Structures

Aggregation results for the specified query.

Calculation.

Enums with an associated value of Calculation: QueryAggregation

A collection for storing documents.

Object containing information about the crawl status of this collection.

Summary of the disk usage statistics for this collection.

Summary of the collection usage in the environment.

An object containing an array of autocompletion suggestions.

A custom configuration for the environment.

Document conversion settings.

An object defining the event being created.

Object containing details of the stored credentials. Obtain credentials for your source from the administrator of the source.

Object containing credential information.

Object containing array of credential definitions.

Response object returned when deleting a colleciton.

Information returned when a configuration is deleted.

Object returned after credentials are deleted.

Information returned when a document is deleted.

Response object returned when deleting an environment.

Summary of the disk usage statistics for the environment.

Information returned after an uploaded document is accepted.

Object containing collection document count information.

Status information about a submitted document.

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.

Options which are specific to a particular enrichment.

Details about an environment.

Summary of the document usage statistics for the environment.

Query event data object.

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.

The query expansion definitions for the specified collection.

Object containing field details.

Filter.

Enums with an associated value of Filter: QueryAggregation

Font matching configuration.

Object describing a specific gateway.

Gatway deletion confirmation.

Object containing gateways array.

A list of HTML conversion settings.

Histogram.

Enums with an associated value of Histogram: QueryAggregation

Details about the resource usage and capacity of the environment.

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).

Response object containing an array of collection details.

Object containing an array of available configurations.

Response object containing an array of configured environments.

Object containing results that match the requested logs query.

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.

Object containing result information that was returned by the query used to create this log entry. Only returned with logs of type query.

Each object in the results array corresponds to an individual document returned by the original query.

An aggregation analyzing log information for queries and events.

Aggregation result data for the requested metric.

The response generated from a call to a metrics method.

An aggregation analyzing log information for queries and events.

Aggregation result data for the requested metric.

The response generated from a call to a metrics method that evaluates tokens.

Nested.

Enums with an associated value of Nested: QueryAggregation

An object specifiying the concepts enrichment and related parameters.

An object specifying the emotion detection enrichment and related parameters.

An object speficying the Entities enrichment and related parameters.

Object containing Natural Language Understanding features to be used.

An object specifying the Keyword enrichment and related parameters.

An object specifying the relations enrichment and related parameters.

An object specifiying the semantic roles enrichment and related parameters.

An object specifying the sentiment extraction enrichment and related parameters.

Object containing normalization operations.

A notice produced for the collection.

Object containing heading detection conversion settings for PDF documents.

A list of PDF conversion settings.

Undocumented

Object containing notice query results.

Query result object.

A passage query result.

A response containing the documents and aggregations for the query.

Query result object.

Metadata of a query result.

An object contain retrieval type information.

Object containing smart document understanding information for this collection.

Information about custom smart document understanding fields that exist in this collection.

Information about the Continuous Relevancy Training for this environment.

A list of Document Segmentation settings.

Object containing source parameters for the configuration.

The options object defines which items to crawl from the source system.

Object defining a cloud object store bucket to crawl.

Object that defines a box folder to crawl with this configuration.

Object that defines a Salesforce document object type crawl with this configuration.

Object that defines a Microsoft SharePoint site collection to crawl with this configuration.

Object defining which URL to crawl and how to crawl it.

Object containing the schedule information for the source.

Object containing source crawl status information.

Object that contains details about the status of the authentication process.

Term.

Enums with an associated value of Term: QueryAggregation

Timeslice.

Enums with an associated value of Timeslice: QueryAggregation

An object defining a single tokenizaion rule.

Object describing the current status of the wordlist.

TopHits.

Enums with an associated value of TopHits: QueryAggregation

Top hit information for this query.

Training information for a specific collection.

Training example details.

Object containing an array of training examples.

Training query details.

Training status details.

Object containing heading detection conversion settings for Microsoft Word documents.

A list of Word conversion settings.

Microsoft Word styles to convert into a specified HTML head level.

Object containing an array of XPaths.