Structures

The following structures are available globally.

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

    See more

    Declaration

    Swift

    public struct AnalyzedDocument : Codable, Equatable
  • Result of the document analysis.

    See more

    Declaration

    Swift

    public struct AnalyzedResult : Codable, Equatable
  • A collection for storing documents.

    See more

    Declaration

    Swift

    public struct Collection : Codable, Equatable
  • A collection for storing documents.

    See more

    Declaration

    Swift

    public struct CollectionDetails : Codable, Equatable
  • An object describing an Enrichment for a collection.

    See more

    Declaration

    Swift

    public struct CollectionEnrichment : Codable, Equatable
  • An object that contains an array of autocompletion suggestions.

    See more

    Declaration

    Swift

    public struct Completions : Codable, Equatable
  • Display settings for aggregations.

    See more

    Declaration

    Swift

    public struct ComponentSettingsAggregation : Codable, Equatable
  • Fields shown in the results section of the UI.

    See more

    Declaration

    Swift

    public struct ComponentSettingsFieldsShown : Codable, Equatable
  • Body label.

    See more

    Declaration

    Swift

    public struct ComponentSettingsFieldsShownBody : Codable, Equatable
  • Title label.

    See more

    Declaration

    Swift

    public struct ComponentSettingsFieldsShownTitle : Codable, Equatable
  • The default component settings for this project.

    See more

    Declaration

    Swift

    public struct ComponentSettingsResponse : Codable, Equatable
  • Information about a specific enrichment.

    See more

    Declaration

    Swift

    public struct CreateEnrichment : Codable, Equatable
  • Default query parameters for this project.

    See more

    Declaration

    Swift

    public struct DefaultQueryParams : Codable, Equatable
  • Default settings configuration for passage search options.

    See more

    Declaration

    Swift

    public struct DefaultQueryParamsPassages : Codable, Equatable
  • Object that contains suggested refinement settings. Available with Premium plans only.

    See more

    Declaration

    Swift

    public struct DefaultQueryParamsSuggestedRefinements : Codable, Equatable
  • Default project query settings for table results.

    See more

    Declaration

    Swift

    public struct DefaultQueryParamsTableResults : Codable, Equatable
  • Information returned when a document is deleted.

    See more

    Declaration

    Swift

    public struct DeleteDocumentResponse : Codable, Equatable
  • Information returned after an uploaded document is accepted.

    See more

    Declaration

    Swift

    public struct DocumentAccepted : Codable, Equatable
  • List of document attributes.

    See more

    Declaration

    Swift

    public struct DocumentAttribute : Codable, Equatable
  • Information about a specific enrichment.

    See more

    Declaration

    Swift

    public struct Enrichment : Codable, Equatable
  • 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.

    See more

    Declaration

    Swift

    public struct EnrichmentOptions : Codable, Equatable
  • An object that contains an array of enrichment definitions.

    See more

    Declaration

    Swift

    public struct Enrichments : Codable, Equatable
  • Object that contains field details.

    See more

    Declaration

    Swift

    public struct Field : Codable, Equatable
  • Response object that contains an array of collection details.

    See more

    Declaration

    Swift

    public struct ListCollectionsResponse : Codable, Equatable
  • 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).
    See more

    Declaration

    Swift

    public struct ListFieldsResponse : Codable, Equatable
  • A list of projects in this instance.

    See more

    Declaration

    Swift

    public struct ListProjectsResponse : Codable, Equatable
  • A notice produced for the collection.

    See more

    Declaration

    Swift

    public struct Notice : Codable, Equatable
  • Detailed information about the specified project.

    See more

    Declaration

    Swift

    public struct ProjectDetails : Codable, Equatable
  • Details about a specific project.

    See more

    Declaration

    Swift

    public struct ProjectListDetails : Codable, Equatable
  • Relevancy training status information for this project.

    See more

    Declaration

    Swift

    public struct ProjectListDetailsRelevancyTrainingStatus : Codable, Equatable
  • Undocumented

    See more

    Declaration

    Swift

    public struct GenericQueryAggregation : Codable, Equatable
  • 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

    See more

    Declaration

    Swift

    public struct QueryCalculationAggregation : Codable, Equatable
  • A modifier that narrows the document set of the sub-aggregations it precedes.

    Enums with an associated value of QueryFilterAggregation: QueryAggregation

    See more

    Declaration

    Swift

    public struct QueryFilterAggregation : Codable, Equatable
  • Returns the top values for the field specified.

    Enums with an associated value of QueryGroupByAggregation: QueryAggregation

    See more

    Declaration

    Swift

    public struct QueryGroupByAggregation : Codable, Equatable
  • Top value result for the term aggregation.

    See more

    Declaration

    Swift

    public struct QueryGroupByAggregationResult : Codable, Equatable
  • 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

    See more

    Declaration

    Swift

    public struct QueryHistogramAggregation : Codable, Equatable
  • Histogram numeric interval result.

    See more

    Declaration

    Swift

    public struct QueryHistogramAggregationResult : Codable, Equatable
  • Configuration for passage retrieval.

    See more

    Declaration

    Swift

    public struct QueryLargePassages : Codable, Equatable
  • Configuration for suggested refinements. Available with Premium plans only.

    See more

    Declaration

    Swift

    public struct QueryLargeSuggestedRefinements : Codable, Equatable
  • Configuration for table retrieval.

    See more

    Declaration

    Swift

    public struct QueryLargeTableResults : Codable, Equatable
  • 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

    See more

    Declaration

    Swift

    public struct QueryNestedAggregation : Codable, Equatable
  • Object that contains notice query results.

    See more

    Declaration

    Swift

    public struct QueryNoticesResponse : Codable, Equatable
  • A response that contains the documents and aggregations for the query.

    See more

    Declaration

    Swift

    public struct QueryResponse : Codable, Equatable
  • A passage query response.

    See more

    Declaration

    Swift

    public struct QueryResponsePassage : Codable, Equatable
  • Result document for the specified query.

    See more

    Declaration

    Swift

    public struct QueryResult : Codable, Equatable
  • Metadata of a query result.

    See more

    Declaration

    Swift

    public struct QueryResultMetadata : Codable, Equatable
  • A passage query result.

    See more

    Declaration

    Swift

    public struct QueryResultPassage : Codable, Equatable
  • A suggested additional query term or terms user to filter results.

    See more

    Declaration

    Swift

    public struct QuerySuggestedRefinement : Codable, Equatable
  • A tables whose content or context match a search query.

    See more

    Declaration

    Swift

    public struct QueryTableResult : Codable, Equatable
  • Returns the top values for the field specified.

    Enums with an associated value of QueryTermAggregation: QueryAggregation

    See more

    Declaration

    Swift

    public struct QueryTermAggregation : Codable, Equatable
  • Top value result for the term aggregation.

    See more

    Declaration

    Swift

    public struct QueryTermAggregationResult : Codable, Equatable
  • A specialized histogram aggregation that uses dates to create interval segments.

    Enums with an associated value of QueryTimesliceAggregation: QueryAggregation

    See more

    Declaration

    Swift

    public struct QueryTimesliceAggregation : Codable, Equatable
  • A timeslice interval segment.

    See more

    Declaration

    Swift

    public struct QueryTimesliceAggregationResult : Codable, Equatable
  • Returns the top documents ranked by the score of the query.

    Enums with an associated value of QueryTopHitsAggregation: QueryAggregation

    See more

    Declaration

    Swift

    public struct QueryTopHitsAggregation : Codable, Equatable
  • A query response that contains the matching documents for the preceding aggregations.

    See more

    Declaration

    Swift

    public struct QueryTopHitsAggregationResult : Codable, Equatable
  • Object that contains a potential answer to the specified query.

    See more

    Declaration

    Swift

    public struct ResultPassageAnswer : Codable, Equatable
  • An object contain retrieval type information.

    See more

    Declaration

    Swift

    public struct RetrievalDetails : Codable, Equatable
  • Cells that are not table header, column header, or row header cells.

    See more

    Declaration

    Swift

    public struct TableBodyCells : Codable, Equatable
  • A key in a key-value pair.

    See more

    Declaration

    Swift

    public struct TableCellKey : Codable, Equatable
  • A value in a key-value pair.

    See more

    Declaration

    Swift

    public struct TableCellValues : Codable, Equatable
  • An array of values, each being the id value of a column header that is applicable to the current cell.

    See more

    Declaration

    Swift

    public struct TableColumnHeaderIDs : Codable, Equatable
  • An array of values, each being the text value of a column header that is applicable to the current cell.

    See more

    Declaration

    Swift

    public struct TableColumnHeaderTexts : Codable, Equatable
  • 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.

    See more

    Declaration

    Swift

    public struct TableColumnHeaderTextsNormalized : Codable, Equatable
  • Column-level cells, each applicable as a header to other cells in the same column as itself, of the current table.

    See more

    Declaration

    Swift

    public struct TableColumnHeaders : Codable, Equatable
  • The numeric location of the identified element in the document, represented with two integers labeled begin and end.

    See more

    Declaration

    Swift

    public struct TableElementLocation : Codable, Equatable
  • The contents of the current table’s header.

    See more

    Declaration

    Swift

    public struct TableHeaders : Codable, Equatable
  • Key-value pairs detected across cell boundaries.

    See more

    Declaration

    Swift

    public struct TableKeyValuePairs : Codable, Equatable
  • Full table object retrieved from Table Understanding Enrichment.

    See more

    Declaration

    Swift

    public struct TableResultTable : Codable, Equatable
  • An array of values, each being the id value of a row header that is applicable to this body cell.

    See more

    Declaration

    Swift

    public struct TableRowHeaderIDs : Codable, Equatable
  • An array of values, each being the text value of a row header that is applicable to this body cell.

    See more

    Declaration

    Swift

    public struct TableRowHeaderTexts : Codable, Equatable
  • 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.

    See more

    Declaration

    Swift

    public struct TableRowHeaderTextsNormalized : Codable, Equatable
  • Row-level cells, each applicable as a header to other cells in the same row as itself, of the current table.

    See more

    Declaration

    Swift

    public struct TableRowHeaders : Codable, Equatable
  • Text and associated location within a table.

    See more

    Declaration

    Swift

    public struct TableTextLocation : Codable, Equatable
  • Object that contains example response details for a training query.

    See more

    Declaration

    Swift

    public struct TrainingExample : Codable, Equatable
  • Object that contains training query details.

    See more

    Declaration

    Swift

    public struct TrainingQuery : Codable, Equatable
  • Object specifying the training queries contained in the identified training set.

    See more

    Declaration

    Swift

    public struct TrainingQuerySet : Codable, Equatable