Structures

The following structures are available globally.

  • Aggregation results for the specified query.

    See more

    Declaration

    Swift

    public struct AggregationResult : Codable, Equatable
  • Calculation.

    Enums with an associated value of Calculation: QueryAggregation

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct Collection : Codable, Equatable
  • Object containing information about the crawl status of this collection.

    See more

    Declaration

    Swift

    public struct CollectionCrawlStatus : Codable, Equatable
  • Summary of the disk usage statistics for this collection.

    See more

    Declaration

    Swift

    public struct CollectionDiskUsage : Codable, Equatable
  • Summary of the collection usage in the environment.

    See more

    Declaration

    Swift

    public struct CollectionUsage : Codable, Equatable
  • An object containing an array of autocompletion suggestions.

    See more

    Declaration

    Swift

    public struct Completions : Codable, Equatable
  • A custom configuration for the environment.

    See more

    Declaration

    Swift

    public struct Configuration : Codable, Equatable
  • Document conversion settings.

    See more

    Declaration

    Swift

    public struct Conversions : Codable, Equatable
  • An object defining the event being created.

    See more

    Declaration

    Swift

    public struct CreateEventResponse : Codable, Equatable
  • Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.

    See more

    Declaration

    Swift

    public struct CredentialDetails : Codable, Equatable
  • Object containing credential information.

    See more

    Declaration

    Swift

    public struct Credentials : Codable, Equatable
  • Object containing array of credential definitions.

    See more

    Declaration

    Swift

    public struct CredentialsList : Codable, Equatable
  • Response object returned when deleting a colleciton.

    See more

    Declaration

    Swift

    public struct DeleteCollectionResponse : Codable, Equatable
  • Information returned when a configuration is deleted.

    See more

    Declaration

    Swift

    public struct DeleteConfigurationResponse : Codable, Equatable
  • Object returned after credentials are deleted.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct DeleteDocumentResponse : Codable, Equatable
  • Response object returned when deleting an environment.

    See more

    Declaration

    Swift

    public struct DeleteEnvironmentResponse : Codable, Equatable
  • Summary of the disk usage statistics for the environment.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct DocumentAccepted : Codable, Equatable
  • Object containing collection document count information.

    See more

    Declaration

    Swift

    public struct DocumentCounts : Codable, Equatable
  • Status information about a submitted document.

    See more

    Declaration

    Swift

    public struct DocumentStatus : Codable, Equatable
  • Enrichment step to perform on the document. Each enrichment is performed on the specified field in the order that they are listed in the configuration.

    See more

    Declaration

    Swift

    public struct Enrichment : Codable, Equatable
  • Options which are specific to a particular enrichment.

    See more

    Declaration

    Swift

    public struct EnrichmentOptions : Codable, Equatable
  • Details about an environment.

    See more

    Declaration

    Swift

    public struct Environment : Codable, Equatable
  • Summary of the document usage statistics for the environment.

    See more

    Declaration

    Swift

    public struct EnvironmentDocuments : Codable, Equatable
  • Query event data object.

    See more

    Declaration

    Swift

    public struct EventData : Codable, Equatable
  • An expansion definition. Each object respresents one set of expandable strings. For example, you could have expansions for the word hot in one object, and expansions for the word cold in another.

    See more

    Declaration

    Swift

    public struct Expansion : Codable, Equatable
  • The query expansion definitions for the specified collection.

    See more

    Declaration

    Swift

    public struct Expansions : Codable, Equatable
  • Object containing field details.

    See more

    Declaration

    Swift

    public struct Field : Codable, Equatable
  • Filter.

    Enums with an associated value of Filter: QueryAggregation

    See more

    Declaration

    Swift

    public struct Filter : Codable, Equatable
  • Font matching configuration.

    See more

    Declaration

    Swift

    public struct FontSetting : Codable, Equatable
  • Object describing a specific gateway.

    See more

    Declaration

    Swift

    public struct Gateway : Codable, Equatable
  • Gatway deletion confirmation.

    See more

    Declaration

    Swift

    public struct GatewayDelete : Codable, Equatable
  • Object containing gateways array.

    See more

    Declaration

    Swift

    public struct GatewayList : Codable, Equatable
  • A list of HTML conversion settings.

    See more

    Declaration

    Swift

    public struct HTMLSettings : Codable, Equatable
  • Histogram.

    Enums with an associated value of Histogram: QueryAggregation

    See more

    Declaration

    Swift

    public struct Histogram : Codable, Equatable
  • Details about the resource usage and capacity of the environment.

    See more

    Declaration

    Swift

    public struct IndexCapacity : 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 JSON 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).
    • Fields returned from the News collection are prefixed with v{N}-fullnews-t3-{YEAR}.mappings (for example, v5-fullnews-t3-2016.mappings.text.properties.author).
    See more

    Declaration

    Swift

    public struct ListCollectionFieldsResponse : Codable, Equatable
  • Response object containing an array of collection details.

    See more

    Declaration

    Swift

    public struct ListCollectionsResponse : Codable, Equatable
  • Object containing an array of available configurations.

    See more

    Declaration

    Swift

    public struct ListConfigurationsResponse : Codable, Equatable
  • Response object containing an array of configured environments.

    See more

    Declaration

    Swift

    public struct ListEnvironmentsResponse : Codable, Equatable
  • Object containing results that match the requested logs query.

    See more

    Declaration

    Swift

    public struct LogQueryResponse : Codable, Equatable
  • Individual result object for a logs query. Each object represents either a query to a Discovery collection or an event that is associated with a query.

    See more

    Declaration

    Swift

    public struct LogQueryResponseResult : Codable, Equatable
  • Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type query.

    See more

    Declaration

    Swift

    public struct LogQueryResponseResultDocuments : Codable, Equatable
  • Each object in the results array corresponds to an individual document returned by the original query.

    See more

    Declaration

    Swift

    public struct LogQueryResponseResultDocumentsResult : Codable, Equatable
  • An aggregation analyzing log information for queries and events.

    See more

    Declaration

    Swift

    public struct MetricAggregation : Codable, Equatable
  • Aggregation result data for the requested metric.

    See more

    Declaration

    Swift

    public struct MetricAggregationResult : Codable, Equatable
  • The response generated from a call to a metrics method.

    See more

    Declaration

    Swift

    public struct MetricResponse : Codable, Equatable
  • An aggregation analyzing log information for queries and events.

    See more

    Declaration

    Swift

    public struct MetricTokenAggregation : Codable, Equatable
  • Aggregation result data for the requested metric.

    See more

    Declaration

    Swift

    public struct MetricTokenAggregationResult : Codable, Equatable
  • The response generated from a call to a metrics method that evaluates tokens.

    See more

    Declaration

    Swift

    public struct MetricTokenResponse : Codable, Equatable
  • Nested.

    Enums with an associated value of Nested: QueryAggregation

    See more

    Declaration

    Swift

    public struct Nested : Codable, Equatable
  • An object specifiying the concepts enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentConcepts : Codable, Equatable
  • An object specifying the emotion detection enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentEmotion : Codable, Equatable
  • An object speficying the Entities enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentEntities : Codable, Equatable
  • Object containing Natural Language Understanding features to be used.

    See more

    Declaration

    Swift

    public struct NluEnrichmentFeatures : Codable, Equatable
  • An object specifying the Keyword enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentKeywords : Codable, Equatable
  • An object specifying the relations enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentRelations : Codable, Equatable
  • An object specifiying the semantic roles enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentSemanticRoles : Codable, Equatable
  • An object specifying the sentiment extraction enrichment and related parameters.

    See more

    Declaration

    Swift

    public struct NluEnrichmentSentiment : Codable, Equatable
  • Object containing normalization operations.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct Notice : Codable, Equatable
  • Object containing heading detection conversion settings for PDF documents.

    See more

    Declaration

    Swift

    public struct PDFHeadingDetection : Codable, Equatable
  • A list of PDF conversion settings.

    See more

    Declaration

    Swift

    public struct PDFSettings : Codable, Equatable
  • Undocumented

    See more

    Declaration

    Swift

    public struct GenericQueryAggregation : Codable, Equatable
  • Object containing notice query results.

    See more

    Declaration

    Swift

    public struct QueryNoticesResponse : Codable, Equatable
  • Query result object.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct QueryPassages : Codable, Equatable
  • A response containing the documents and aggregations for the query.

    See more

    Declaration

    Swift

    public struct QueryResponse : Codable, Equatable
  • Query result object.

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

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

    See more

    Declaration

    Swift

    public struct RetrievalDetails : Codable, Equatable
  • Object containing smart document understanding information for this collection.

    See more

    Declaration

    Swift

    public struct SduStatus : Codable, Equatable
  • Information about custom smart document understanding fields that exist in this collection.

    See more

    Declaration

    Swift

    public struct SduStatusCustomFields : Codable, Equatable
  • Information about the Continuous Relevancy Training for this environment.

    See more

    Declaration

    Swift

    public struct SearchStatus : Codable, Equatable
  • A list of Document Segmentation settings.

    See more

    Declaration

    Swift

    public struct SegmentSettings : Codable, Equatable
  • Object containing source parameters for the configuration.

    See more

    Declaration

    Swift

    public struct Source : Codable, Equatable
  • The options object defines which items to crawl from the source system.

    See more

    Declaration

    Swift

    public struct SourceOptions : Codable, Equatable
  • Object defining a cloud object store bucket to crawl.

    See more

    Declaration

    Swift

    public struct SourceOptionsBuckets : Codable, Equatable
  • Object that defines a box folder to crawl with this configuration.

    See more

    Declaration

    Swift

    public struct SourceOptionsFolder : Codable, Equatable
  • Object that defines a Salesforce document object type crawl with this configuration.

    See more

    Declaration

    Swift

    public struct SourceOptionsObject : Codable, Equatable
  • Object that defines a Microsoft SharePoint site collection to crawl with this configuration.

    See more

    Declaration

    Swift

    public struct SourceOptionsSiteColl : Codable, Equatable
  • Object defining which URL to crawl and how to crawl it.

    See more

    Declaration

    Swift

    public struct SourceOptionsWebCrawl : Codable, Equatable
  • Object containing the schedule information for the source.

    See more

    Declaration

    Swift

    public struct SourceSchedule : Codable, Equatable
  • Object containing source crawl status information.

    See more

    Declaration

    Swift

    public struct SourceStatus : Codable, Equatable
  • Object that contains details about the status of the authentication process.

    See more

    Declaration

    Swift

    public struct StatusDetails : Codable, Equatable
  • Term.

    Enums with an associated value of Term: QueryAggregation

    See more

    Declaration

    Swift

    public struct Term : Codable, Equatable
  • Timeslice.

    Enums with an associated value of Timeslice: QueryAggregation

    See more

    Declaration

    Swift

    public struct Timeslice : Codable, Equatable
  • An object defining a single tokenizaion rule.

    See more

    Declaration

    Swift

    public struct TokenDictRule : Codable, Equatable
  • Object describing the current status of the wordlist.

    See more

    Declaration

    Swift

    public struct TokenDictStatusResponse : Codable, Equatable
  • TopHits.

    Enums with an associated value of TopHits: QueryAggregation

    See more

    Declaration

    Swift

    public struct TopHits : Codable, Equatable
  • Top hit information for this query.

    See more

    Declaration

    Swift

    public struct TopHitsResults : Codable, Equatable
  • Training information for a specific collection.

    See more

    Declaration

    Swift

    public struct TrainingDataSet : Codable, Equatable
  • Training example details.

    See more

    Declaration

    Swift

    public struct TrainingExample : Codable, Equatable
  • Object containing an array of training examples.

    See more

    Declaration

    Swift

    public struct TrainingExampleList : Codable, Equatable
  • Training query details.

    See more

    Declaration

    Swift

    public struct TrainingQuery : Codable, Equatable
  • Training status details.

    See more

    Declaration

    Swift

    public struct TrainingStatus : Codable, Equatable
  • Object containing heading detection conversion settings for Microsoft Word documents.

    See more

    Declaration

    Swift

    public struct WordHeadingDetection : Codable, Equatable
  • A list of Word conversion settings.

    See more

    Declaration

    Swift

    public struct WordSettings : Codable, Equatable
  • Microsoft Word styles to convert into a specified HTML head level.

    See more

    Declaration

    Swift

    public struct WordStyle : Codable, Equatable
  • Object containing an array of XPaths.

    See more

    Declaration

    Swift

    public struct XPathPatterns : Codable, Equatable