Structures

An object that contains the converted document and any identified enrichments.

Result of the document analysis.

A collection for storing documents.

A collection for storing documents.

An object describing an Enrichment for a collection.

An object that contains an array of autocompletion suggestions.

Display settings for aggregations.

Fields shown in the results section of the UI.

Body label.

Title label.

The default component settings for this project.

Information about a specific enrichment.

Default query parameters for this project.

Default settings configuration for passage search options.

Object that contains suggested refinement settings. Available with Premium plans only.

Default project query settings for table results.

Information returned when a document is deleted.

Information returned after an uploaded document is accepted.

List of document attributes.

Information about a specific enrichment.

An object that contains options for the current enrichment. Starting with version 2020-08-30, the enrichment options are not included in responses from the List Enrichments method.

An object that contains an array of enrichment definitions.

Object that contains field details.

Response object that contains an array of collection details.

The list of fetched fields. The fields are returned using a fully qualified name format, however, the format differs slightly from that used by the query operations.

• Fields which contain nested objects are assigned a type of “nested”.
• Fields which belong to a nested object are prefixed with .properties (for example, warnings.properties.severity means that the warnings object has a property called severity).

A list of projects in this instance.

A notice produced for the collection.

Detailed information about the specified project.

Details about a specific project.

Relevancy training status information for this project.

Undocumented

Returns a scalar calculation across all documents for the field specified. Possible calculations include min, max, sum, average, and unique_count.

Enums with an associated value of QueryCalculationAggregation: QueryAggregation

A modifier that narrows the document set of the sub-aggregations it precedes.

Enums with an associated value of QueryFilterAggregation: QueryAggregation

Returns the top values for the field specified.

Enums with an associated value of QueryGroupByAggregation: QueryAggregation

Top value result for the term aggregation.

Numeric interval segments to categorize documents by using field values from a single numeric field to describe the category.

Enums with an associated value of QueryHistogramAggregation: QueryAggregation

Histogram numeric interval result.

Configuration for passage retrieval.

Configuration for suggested refinements. Available with Premium plans only.

Configuration for table retrieval.

A restriction that alters the document set that is used for sub-aggregations it precedes to nested documents found in the field specified.

Enums with an associated value of QueryNestedAggregation: QueryAggregation

Object that contains notice query results.

A response that contains the documents and aggregations for the query.

A passage query response.

Result document for the specified query.

Metadata of a query result.

A passage query result.

A suggested additional query term or terms user to filter results.

A tables whose content or context match a search query.

Returns the top values for the field specified.

Enums with an associated value of QueryTermAggregation: QueryAggregation

Top value result for the term aggregation.

A specialized histogram aggregation that uses dates to create interval segments.

Enums with an associated value of QueryTimesliceAggregation: QueryAggregation

A timeslice interval segment.

Returns the top documents ranked by the score of the query.

Enums with an associated value of QueryTopHitsAggregation: QueryAggregation

A query response that contains the matching documents for the preceding aggregations.

Object that contains a potential answer to the specified query.

An object contain retrieval type information.

Cells that are not table header, column header, or row header cells.

A key in a key-value pair.

A value in a key-value pair.

An array of values, each being the id value of a column header that is applicable to the current cell.

An array of values, each being the text value of a column header that is applicable to the current cell.

If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as column_header_texts.

Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.

The numeric location of the identified element in the document, represented with two integers labeled begin and end.

The contents of the current table’s header.

Key-value pairs detected across cell boundaries.

Full table object retrieved from Table Understanding Enrichment.

An array of values, each being the id value of a row header that is applicable to this body cell.

An array of values, each being the text value of a row header that is applicable to this body cell.

If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as row_header_texts.

Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.

Text and associated location within a table.

Object that contains example response details for a training query.

Object that contains training query details.

Object specifying the training queries contained in the identified training set.