Discovery (parent 4.0.0 API)

java.lang.Object
- com.ibm.watson.developer_cloud.service.WatsonService
- - com.ibm.watson.developer_cloud.discovery.v1.Discovery

```
public class Discovery
extends WatsonService
```
The IBM Watson Discovery Service is a cognitive search and content analytics engine that you can add to applications to identify patterns, trends and actionable insights to drive better decision-making. Securely unify structured and unstructured data with pre-enriched content, and use a simplified query language to eliminate the need for manual filtering of results.

See Also:

Discovery

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`VERSION_DATE_2016_12_01` The Constant VERSION_DATE_2016_12_01.
`static java.lang.String`	`VERSION_DATE_2017_06_25` The Constant VERSION_DATE_2017_06_25.
`static java.lang.String`	`VERSION_DATE_2017_07_19` The Constant VERSION_DATE_2017_07_19.
`static java.lang.String`	`VERSION_DATE_2017_08_01` The Constant VERSION_DATE_2017_08_01.
`static java.lang.String`	`VERSION_DATE_2017_09_01` The Constant VERSION_DATE_2017_09_01.

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService
defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors
Constructor and Description
`Discovery(java.lang.String versionDate)` Instantiates a new `Discovery`.
`Discovery(java.lang.String versionDate, java.lang.String username, java.lang.String password)` Instantiates a new `Discovery` with username and password.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceCall<DocumentAccepted>`	`addDocument(AddDocumentOptions addDocumentOptions)` Add a document.
`ServiceCall<TrainingQuery>`	`addTrainingData(AddTrainingDataOptions addTrainingDataOptions)` Adds a query to the training data for this collection.
`ServiceCall<Collection>`	`createCollection(CreateCollectionOptions createCollectionOptions)` Create a collection.
`ServiceCall<Configuration>`	`createConfiguration(CreateConfigurationOptions createConfigurationOptions)` Add configuration.
`ServiceCall<Environment>`	`createEnvironment(CreateEnvironmentOptions createEnvironmentOptions)` Add an environment.
`ServiceCall<TrainingExample>`	`createTrainingExample(CreateTrainingExampleOptions createTrainingExampleOptions)` Adds a new example to this training data query.
`ServiceCall<java.lang.Void>`	`deleteAllTrainingData(DeleteAllTrainingDataOptions deleteAllTrainingDataOptions)` Clears all training data for this collection.
`ServiceCall<java.lang.Void>`	`deleteCollection(DeleteCollectionOptions deleteCollectionOptions)` Delete a collection.
`ServiceCall<java.lang.Void>`	`deleteConfiguration(DeleteConfigurationOptions deleteConfigurationOptions)` Delete a configuration.
`ServiceCall<java.lang.Void>`	`deleteDocument(DeleteDocumentOptions deleteDocumentOptions)` Delete a document.
`ServiceCall<java.lang.Void>`	`deleteEnvironment(DeleteEnvironmentOptions deleteEnvironmentOptions)` Delete environment.
`ServiceCall<java.lang.Void>`	`deleteTrainingData(DeleteTrainingDataOptions deleteTrainingDataOptions)` Removes the training data and all associated examples from the training data set.
`ServiceCall<java.lang.Void>`	`deleteTrainingExample(DeleteTrainingExampleOptions deleteTrainingExampleOptions)` Removes the example with the given ID for the training data query.
`ServiceCall<Collection>`	`getCollection(GetCollectionOptions getCollectionOptions)` Get collection details.
`ServiceCall<Configuration>`	`getConfiguration(GetConfigurationOptions getConfigurationOptions)` Get configuration details.
`ServiceCall<DocumentStatus>`	`getDocumentStatus(GetDocumentStatusOptions getDocumentStatusOptions)` Get document details.
`ServiceCall<Environment>`	`getEnvironment(GetEnvironmentOptions getEnvironmentOptions)` Get environment info.
`ServiceCall<TrainingQuery>`	`getTrainingData(GetTrainingDataOptions getTrainingDataOptions)` Shows details for a specific training data query, including the query string and all examples.
`ServiceCall<TrainingExample>`	`getTrainingExample(GetTrainingExampleOptions getTrainingExampleOptions)` Gets the details for this training example.
`ServiceCall<ListCollectionFieldsResponse>`	`listCollectionFields(ListCollectionFieldsOptions listCollectionFieldsOptions)` List unique fields.
`ServiceCall<ListCollectionsResponse>`	`listCollections(ListCollectionsOptions listCollectionsOptions)` List collections.
`ServiceCall<ListConfigurationsResponse>`	`listConfigurations(ListConfigurationsOptions listConfigurationsOptions)` List configurations.
`ServiceCall<ListEnvironmentsResponse>`	`listEnvironments(ListEnvironmentsOptions listEnvironmentsOptions)` List environments.
`ServiceCall<TrainingDataSet>`	`listTrainingData(ListTrainingDataOptions listTrainingDataOptions)` Lists the training data for this collection.
`ServiceCall<QueryResponse>`	`query(QueryOptions queryOptions)` Query documents.
`ServiceCall<QueryNoticesResponse>`	`queryNotices(QueryNoticesOptions queryNoticesOptions)` Query system notices.
`ServiceCall<TestDocument>`	`testConfigurationInEnvironment(TestConfigurationInEnvironmentOptions testConfigurationInEnvironmentOptions)` Test configuration.
`ServiceCall<Collection>`	`updateCollection(UpdateCollectionOptions updateCollectionOptions)` Update a collection.
`ServiceCall<Configuration>`	`updateConfiguration(UpdateConfigurationOptions updateConfigurationOptions)` Update a configuration.
`ServiceCall<DocumentAccepted>`	`updateDocument(UpdateDocumentOptions updateDocumentOptions)` Update a document.
`ServiceCall<Environment>`	`updateEnvironment(UpdateEnvironmentOptions updateEnvironmentOptions)` Update an environment.
`ServiceCall<TrainingExample>`	`updateTrainingExample(UpdateTrainingExampleOptions updateTrainingExampleOptions)` Changes the label or cross reference query for this training example.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService
configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERSION_DATE_2017_09_01
```
public static final java.lang.String VERSION_DATE_2017_09_01
```
    The Constant VERSION_DATE_2017_09_01.
    
    See Also:
    
    Constant Field Values
  - VERSION_DATE_2017_08_01
```
public static final java.lang.String VERSION_DATE_2017_08_01
```
    The Constant VERSION_DATE_2017_08_01.
    
    See Also:
    
    Constant Field Values
  - VERSION_DATE_2017_07_19
```
public static final java.lang.String VERSION_DATE_2017_07_19
```
    The Constant VERSION_DATE_2017_07_19.
    
    See Also:
    
    Constant Field Values
  - VERSION_DATE_2017_06_25
```
public static final java.lang.String VERSION_DATE_2017_06_25
```
    The Constant VERSION_DATE_2017_06_25.
    
    See Also:
    
    Constant Field Values
  - VERSION_DATE_2016_12_01
```
public static final java.lang.String VERSION_DATE_2016_12_01
```
    The Constant VERSION_DATE_2016_12_01.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Discovery
```
public Discovery(java.lang.String versionDate)
```
    Instantiates a new `Discovery`.
    
    Parameters:
    
    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.
  - Discovery
```
public Discovery(java.lang.String versionDate,
                 java.lang.String username,
                 java.lang.String password)
```
    Instantiates a new `Discovery` with username and password.
    
    Parameters:
    
    versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.
    
    username - the username
    
    password - the password
- Method Detail
  - createCollection
```
public ServiceCall<Collection> createCollection(CreateCollectionOptions createCollectionOptions)
```
    Create a collection.
    
    Parameters:
    
    createCollectionOptions - the CreateCollectionOptions containing the options for the call
    
    Returns:
    
    the Collection with the response
  - deleteCollection
```
public ServiceCall<java.lang.Void> deleteCollection(DeleteCollectionOptions deleteCollectionOptions)
```
    Delete a collection.
    
    Parameters:
    
    deleteCollectionOptions - the DeleteCollectionOptions containing the options for the call
    
    Returns:
    
    the service call
  - getCollection
```
public ServiceCall<Collection> getCollection(GetCollectionOptions getCollectionOptions)
```
    Get collection details.
    
    Parameters:
    
    getCollectionOptions - the GetCollectionOptions containing the options for the call
    
    Returns:
    
    the Collection with the response
  - listCollectionFields
```
public ServiceCall<ListCollectionFieldsResponse> listCollectionFields(ListCollectionFieldsOptions listCollectionFieldsOptions)
```
    List unique fields. Gets a list of the the unique fields (and their types) stored in the index.
    
    Parameters:
    
    listCollectionFieldsOptions - the ListCollectionFieldsOptions containing the options for the call
    
    Returns:
    
    the ListCollectionFieldsResponse with the response
  - listCollections
```
public ServiceCall<ListCollectionsResponse> listCollections(ListCollectionsOptions listCollectionsOptions)
```
    List collections. Lists existing collections for the service instance.
    
    Parameters:
    
    listCollectionsOptions - the ListCollectionsOptions containing the options for the call
    
    Returns:
    
    the ListCollectionsResponse with the response
  - updateCollection
```
public ServiceCall<Collection> updateCollection(UpdateCollectionOptions updateCollectionOptions)
```
    Update a collection.
    
    Parameters:
    
    updateCollectionOptions - the UpdateCollectionOptions containing the options for the call
    
    Returns:
    
    the Collection with the response
  - createConfiguration
```
public ServiceCall<Configuration> createConfiguration(CreateConfigurationOptions createConfigurationOptions)
```
    Add configuration. 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.
    
    Parameters:
    
    createConfigurationOptions - the CreateConfigurationOptions containing the options for the call
    
    Returns:
    
    the Configuration with the response
  - deleteConfiguration
```
public ServiceCall<java.lang.Void> deleteConfiguration(DeleteConfigurationOptions deleteConfigurationOptions)
```
    Delete a configuration. 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.
    
    Parameters:
    
    deleteConfigurationOptions - the DeleteConfigurationOptions containing the options for the call
    
    Returns:
    
    the service call
  - getConfiguration
```
public ServiceCall<Configuration> getConfiguration(GetConfigurationOptions getConfigurationOptions)
```
    Get configuration details.
    
    Parameters:
    
    getConfigurationOptions - the GetConfigurationOptions containing the options for the call
    
    Returns:
    
    the Configuration with the response
  - listConfigurations
```
public ServiceCall<ListConfigurationsResponse> listConfigurations(ListConfigurationsOptions listConfigurationsOptions)
```
    List configurations. Lists existing configurations for the service instance.
    
    Parameters:
    
    listConfigurationsOptions - the ListConfigurationsOptions containing the options for the call
    
    Returns:
    
    the ListConfigurationsResponse with the response
  - updateConfiguration
```
public ServiceCall<Configuration> updateConfiguration(UpdateConfigurationOptions updateConfigurationOptions)
```
    Update a configuration. 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.
    
    Parameters:
    
    updateConfigurationOptions - the UpdateConfigurationOptions containing the options for the call
    
    Returns:
    
    the Configuration with the response
  - addDocument
```
public ServiceCall<DocumentAccepted> addDocument(AddDocumentOptions addDocumentOptions)
```
    Add a document. 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 `,`.
    
    Parameters:
    
    addDocumentOptions - the AddDocumentOptions containing the options for the call
    
    Returns:
    
    the DocumentAccepted with the response
  - deleteDocument
```
public ServiceCall<java.lang.Void> deleteDocument(DeleteDocumentOptions deleteDocumentOptions)
```
    Delete a document. 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'.
    
    Parameters:
    
    deleteDocumentOptions - the DeleteDocumentOptions containing the options for the call
    
    Returns:
    
    the service call
  - getDocumentStatus
```
public ServiceCall<DocumentStatus> getDocumentStatus(GetDocumentStatusOptions getDocumentStatusOptions)
```
    Get document details. 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.
    
    Parameters:
    
    getDocumentStatusOptions - the GetDocumentStatusOptions containing the options for the call
    
    Returns:
    
    the DocumentStatus with the response
  - updateDocument
```
public ServiceCall<DocumentAccepted> updateDocument(UpdateDocumentOptions updateDocumentOptions)
```
    Update a document. Replace an existing document. Starts ingesting a document with optional metadata.
    
    Parameters:
    
    updateDocumentOptions - the UpdateDocumentOptions containing the options for the call
    
    Returns:
    
    the DocumentAccepted with the response
  - createEnvironment
```
public ServiceCall<Environment> createEnvironment(CreateEnvironmentOptions createEnvironmentOptions)
```
    Add an environment. Creates a new environment. You can create only one environment per service instance. An attempt to create another environment results in an error.
    
    Parameters:
    
    createEnvironmentOptions - the CreateEnvironmentOptions containing the options for the call
    
    Returns:
    
    the Environment with the response
  - deleteEnvironment
```
public ServiceCall<java.lang.Void> deleteEnvironment(DeleteEnvironmentOptions deleteEnvironmentOptions)
```
    Delete environment.
    
    Parameters:
    
    deleteEnvironmentOptions - the DeleteEnvironmentOptions containing the options for the call
    
    Returns:
    
    the service call
  - getEnvironment
```
public ServiceCall<Environment> getEnvironment(GetEnvironmentOptions getEnvironmentOptions)
```
    Get environment info.
    
    Parameters:
    
    getEnvironmentOptions - the GetEnvironmentOptions containing the options for the call
    
    Returns:
    
    the Environment with the response
  - listEnvironments
```
public ServiceCall<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsOptions listEnvironmentsOptions)
```
    List environments. List existing environments for the service instance.
    
    Parameters:
    
    listEnvironmentsOptions - the ListEnvironmentsOptions containing the options for the call
    
    Returns:
    
    the ListEnvironmentsResponse with the response
  - updateEnvironment
```
public ServiceCall<Environment> updateEnvironment(UpdateEnvironmentOptions updateEnvironmentOptions)
```
    Update an environment. Updates an environment. The environment's `name` and `description` parameters can be changed. You must specify a `name` for the environment.
    
    Parameters:
    
    updateEnvironmentOptions - the UpdateEnvironmentOptions containing the options for the call
    
    Returns:
    
    the Environment with the response
  - query
```
public ServiceCall<QueryResponse> query(QueryOptions queryOptions)
```
    Query documents. See the [Discovery service documentation](https://www.ibm.com/watson/developercloud/doc/discovery/using.html) for more details.
    
    Parameters:
    
    queryOptions - the QueryOptions containing the options for the call
    
    Returns:
    
    the QueryResponse with the response
  - queryNotices
```
public ServiceCall<QueryNoticesResponse> queryNotices(QueryNoticesOptions queryNoticesOptions)
```
    Query system notices. Queries for notices (errors or warnings) that may have been generated by the system. Notices are generated when ingesting documents and performing relevance training. See the [Discovery service documentation] (https://www.ibm.com/watson/developercloud/doc/discovery/using.html) for more details on the query language.
    
    Parameters:
    
    queryNoticesOptions - the QueryNoticesOptions containing the options for the call
    
    Returns:
    
    the QueryNoticesResponse with the response
  - testConfigurationInEnvironment
```
public ServiceCall<TestDocument> testConfigurationInEnvironment(TestConfigurationInEnvironmentOptions testConfigurationInEnvironmentOptions)
```
    Test configuration. Runs a sample document through the default or your configuration and returns diagnostic information designed to help you understand how the document was processed. The document is not added to the index.
    
    Parameters:
    
    testConfigurationInEnvironmentOptions - the TestConfigurationInEnvironmentOptions containing the options for the call
    
    Returns:
    
    the TestDocument with the response
  - addTrainingData
```
public ServiceCall<TrainingQuery> addTrainingData(AddTrainingDataOptions addTrainingDataOptions)
```
    Adds a query to the training data for this collection. The query can contain a filter and natural language query.
    
    Parameters:
    
    addTrainingDataOptions - the AddTrainingDataOptions containing the options for the call
    
    Returns:
    
    the TrainingQuery with the response
  - createTrainingExample
```
public ServiceCall<TrainingExample> createTrainingExample(CreateTrainingExampleOptions createTrainingExampleOptions)
```
    Adds a new example to this training data query.
    
    Parameters:
    
    createTrainingExampleOptions - the CreateTrainingExampleOptions containing the options for the call
    
    Returns:
    
    the TrainingExample with the response
  - deleteAllTrainingData
```
public ServiceCall<java.lang.Void> deleteAllTrainingData(DeleteAllTrainingDataOptions deleteAllTrainingDataOptions)
```
    Clears all training data for this collection.
    
    Parameters:
    
    deleteAllTrainingDataOptions - the DeleteAllTrainingDataOptions containing the options for the call
    
    Returns:
    
    the service call
  - deleteTrainingData
```
public ServiceCall<java.lang.Void> deleteTrainingData(DeleteTrainingDataOptions deleteTrainingDataOptions)
```
    Removes the training data and all associated examples from the training data set.
    
    Parameters:
    
    deleteTrainingDataOptions - the DeleteTrainingDataOptions containing the options for the call
    
    Returns:
    
    the service call
  - deleteTrainingExample
```
public ServiceCall<java.lang.Void> deleteTrainingExample(DeleteTrainingExampleOptions deleteTrainingExampleOptions)
```
    Removes the example with the given ID for the training data query.
    
    Parameters:
    
    deleteTrainingExampleOptions - the DeleteTrainingExampleOptions containing the options for the call
    
    Returns:
    
    the service call
  - getTrainingData
```
public ServiceCall<TrainingQuery> getTrainingData(GetTrainingDataOptions getTrainingDataOptions)
```
    Shows details for a specific training data query, including the query string and all examples.
    
    Parameters:
    
    getTrainingDataOptions - the GetTrainingDataOptions containing the options for the call
    
    Returns:
    
    the TrainingQuery with the response
  - getTrainingExample
```
public ServiceCall<TrainingExample> getTrainingExample(GetTrainingExampleOptions getTrainingExampleOptions)
```
    Gets the details for this training example.
    
    Parameters:
    
    getTrainingExampleOptions - the GetTrainingExampleOptions containing the options for the call
    
    Returns:
    
    the TrainingExample with the response
  - listTrainingData
```
public ServiceCall<TrainingDataSet> listTrainingData(ListTrainingDataOptions listTrainingDataOptions)
```
    Lists the training data for this collection.
    
    Parameters:
    
    listTrainingDataOptions - the ListTrainingDataOptions containing the options for the call
    
    Returns:
    
    the TrainingDataSet with the response
  - updateTrainingExample
```
public ServiceCall<TrainingExample> updateTrainingExample(UpdateTrainingExampleOptions updateTrainingExampleOptions)
```
    Changes the label or cross reference query for this training example.
    
    Parameters:
    
    updateTrainingExampleOptions - the UpdateTrainingExampleOptions containing the options for the call
    
    Returns:
    
    the TrainingExample with the response

Class Discovery

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Constructor Summary

Method Summary

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Methods inherited from class java.lang.Object

Field Detail

VERSION_DATE_2017_09_01

VERSION_DATE_2017_08_01

VERSION_DATE_2017_07_19

VERSION_DATE_2017_06_25

VERSION_DATE_2016_12_01

Constructor Detail

Discovery

Discovery

Method Detail

createCollection

deleteCollection

getCollection

listCollectionFields

listCollections

updateCollection

createConfiguration

deleteConfiguration

getConfiguration

listConfigurations

updateConfiguration

addDocument

deleteDocument

getDocumentStatus

updateDocument

createEnvironment

deleteEnvironment

getEnvironment

listEnvironments

updateEnvironment

query

queryNotices

testConfigurationInEnvironment

addTrainingData

createTrainingExample

deleteAllTrainingData

deleteTrainingData

deleteTrainingExample

getTrainingData

getTrainingExample

listTrainingData

updateTrainingExample