Class DiscoveryV1

Add a document to a collection with optional metadata.

• The version query parameter is still required.

• Returns immediately after the system has accepted the document for processing.

• The user must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.

• The user can set the Content-Type parameter on the file part to indicate the media type of the document. If the Content-Type parameter is missing or is one of the generic media types (for example, application/octet-stream), then the service attempts to automatically detect the document's media type.

• The following field names are reserved and will be filtered out if present after normalization: id, score, highlight, and any field with the prefix of: _, +, or -

• Fields with empty name values after normalization are filtered out before indexing.

• Fields containing the following characters after normalization are filtered out before indexing: # and ,

  Note: Documents can be added with a specific document_id by using the _/v1/environments/{environment_id}/collections/{collection_id}/documents method.

Adds a query to the training data for this collection. The query can contain a filter and natural language query.

Creates a new configuration.

If the input configuration contains the configuration_id, created, or updated properties, then they are ignored and overridden by the system, and an error is not returned so that the overridden fields do not need to be removed when copying a configuration.

The configuration can contain unrecognized JSON fields. Any such fields are ignored and do not generate an error. This makes it easier to use newer configuration files with older versions of the API and the service. It also makes it possible for the tooling to add additional metadata and information to the configuration.

Creates a set of credentials to connect to a remote source. Created credentials are used in a configuration to associate a collection with the remote source.

Note: All credentials are sent over an encrypted connection and encrypted at rest.

Creates a new environment for private data. An environment must be created before collections can be created.

Note: You can create only one environment for private data per service instance. An attempt to create another environment results in an error.

The Events API can be used to create log entries that are associated with specific queries. For example, you can record which documents in the results set were "clicked" by a user and when that click occurred.

Create or replace the Expansion list for this collection. The maximum number of expanded terms per collection is 500. The current expansion list is replaced with the uploaded content.

Create a gateway configuration to use with a remotely installed gateway.

Upload a custom stopword list to use with the specified collection.

Upload a custom tokenization dictionary to use with the specified collection.

Adds a example to this training data query.

Deletes all training data from a collection.

The deletion is performed unconditionally. A configuration deletion request succeeds even if the configuration is referenced by a collection or document ingestion. However, documents that have already been submitted for processing continue to use the deleted configuration. Documents are always processed with a snapshot of the configuration as it existed at the time the document was submitted.

Deletes a set of stored credentials from your Discovery instance.

If the given document ID is invalid, or if the document is not found, then the a success response is returned (HTTP status code 200) with the status set to 'deleted'.

Remove the expansion information for this collection. The expansion list must be deleted to disable query expansion for a collection.

Delete the specified gateway configuration.

Delete a custom stopword list from the collection. After a custom stopword list is deleted, the default list is used for the collection.

Delete the tokenization dictionary from the collection.

Removes the training data query and all associated examples from the training data set.

Deletes the example document with the given ID from the training data query.

Deletes all data associated with a specified customer ID. The method has no effect if no data is associated with the customer ID.

You associate a customer ID with data by passing the X-Watson-Metadata header with a request that passes data. For more information about personal data and customer IDs, see Information security.

By using this method, you can construct long queries that search multiple collection. For details, see the Discovery documentation.

Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training. See the Discovery documentation for more details on the query language.

Returns completion query suggestions for the specified prefix. /n/n Important: this method is only valid when using the Cloud Pak version of Discovery.

Returns details about the specified credentials.

Note: Secure credential information such as a password or SSH key is never returned and must be obtained from the source system.

Fetch status details about a submitted document. Note: this operation does not return the document itself. Instead, it returns only the document's processing status and any notices (warnings or errors) that were generated when the document was ingested. Use the query API to retrieve the actual document content.

List information about the specified gateway.

The percentage of queries using the natural_language_query parameter that have a corresponding "click" event over a specified time window. This metric requires having integrated event tracking in your application using the Events API.

Total number of queries using the natural_language_query parameter over a specific time window.

Total number of queries using the natural_language_query parameter that have a corresponding "click" event over a specified time window. This metric requires having integrated event tracking in your application using the Events API.

Total number of queries using the natural_language_query parameter that have no results returned over a specified time window.

The most frequent query tokens parsed from the natural_language_query parameter and their corresponding "click" event rate within the recording period (queries and events are stored for 30 days). A query token is an individual word or unigram within the query string.

Returns the current status of the stopword list for the specified collection.

Returns the current status of the tokenization dictionary for the specified collection.

Gets details for a specific training data query, including the query string and all examples.

Gets the details for this training example.

Gets a list of the unique fields (and their types) stored in the index.

Lists existing collections for the service instance.

Lists existing configurations for the service instance.

List all the source credentials that have been created for this service instance.

Note: All credentials are sent over an encrypted connection and encrypted at rest.

List existing environments for the service instance.

Returns the current expansion list for the specified collection. If an expansion list is not specified, an object with empty expansion arrays is returned.

Gets a list of the unique fields (and their types) stored in the indexes of the specified collections.

List the currently configured gateways.

Lists the training data for the specified collection.

List all examples for this training data query.

By using this method, you can construct long queries. For details, see the Discovery documentation.

Searches the query and event log to find query sessions that match the specified criteria. Searching the logs endpoint uses the standard Discovery query syntax for the parameters that are supported.

Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training. See the Discovery documentation for more details on the query language.

Replaces an existing configuration.

• Completely replaces the original configuration.
• The configuration_id, updated, and created fields are accepted in the request, but they are ignored, and an error is not generated. It is also acceptable for users to submit an updated configuration with none of the three properties.
• Documents are processed with a snapshot of the configuration as it was at the time the document was submitted to be ingested. This means that already submitted documents will not see any updates made to the configuration.

Updates an existing set of source credentials.

Note: All credentials are sent over an encrypted connection and encrypted at rest.

Replace an existing document or add a document with a specified document_id. Starts ingesting a document with optional metadata.

Note: When uploading a new document with this method it automatically replaces any document stored with the same document_id if it exists.

Updates an environment. The environment's name and description parameters can be changed. You must specify a name for the environment.

Changes the label or cross reference query for this training data example.