com.ibm.watson.discovery.v2

Class Discovery

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.watson.discovery.v2.Discovery

public class Discovery
extends com.ibm.cloud.sdk.core.service.BaseService

IBM Watson™ Discovery 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.

Version:

v2

See Also:

Discovery

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME
static String	DEFAULT_SERVICE_URL

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
Discovery(String version) Constructs an instance of the `Discovery` client.
Discovery(String version, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `Discovery` client.
Discovery(String version, String serviceName) Constructs an instance of the `Discovery` client.
Discovery(String version, String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `Discovery` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentAccepted>	addDocument(AddDocumentOptions addDocumentOptions) Add a document.
com.ibm.cloud.sdk.core.http.ServiceCall<AnalyzedDocument>	analyzeDocument(AnalyzeDocumentOptions analyzeDocumentOptions) Analyze a Document.
com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails>	createCollection(CreateCollectionOptions createCollectionOptions) Create a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment>	createEnrichment(CreateEnrichmentOptions createEnrichmentOptions) Create an enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails>	createProject(CreateProjectOptions createProjectOptions) Create a Project.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery>	createTrainingQuery(CreateTrainingQueryOptions createTrainingQueryOptions) Create training query.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteCollection(DeleteCollectionOptions deleteCollectionOptions) Delete a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<DeleteDocumentResponse>	deleteDocument(DeleteDocumentOptions deleteDocumentOptions) Delete a document.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteEnrichment(DeleteEnrichmentOptions deleteEnrichmentOptions) Delete an enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteProject(DeleteProjectOptions deleteProjectOptions) Delete a project.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteTrainingQueries(DeleteTrainingQueriesOptions deleteTrainingQueriesOptions) Delete training queries.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteTrainingQuery(DeleteTrainingQueryOptions deleteTrainingQueryOptions) Delete a training data query.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteUserData(DeleteUserDataOptions deleteUserDataOptions) Delete labeled data.
com.ibm.cloud.sdk.core.http.ServiceCall<Completions>	getAutocompletion(GetAutocompletionOptions getAutocompletionOptions) Get Autocomplete Suggestions.
com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails>	getCollection(GetCollectionOptions getCollectionOptions) Get collection.
com.ibm.cloud.sdk.core.http.ServiceCall<ComponentSettingsResponse>	getComponentSettings(GetComponentSettingsOptions getComponentSettingsOptions) List component settings.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment>	getEnrichment(GetEnrichmentOptions getEnrichmentOptions) Get enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails>	getProject(GetProjectOptions getProjectOptions) Get project.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery>	getTrainingQuery(GetTrainingQueryOptions getTrainingQueryOptions) Get a training data query.
String	getVersion() Gets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<ListCollectionsResponse>	listCollections(ListCollectionsOptions listCollectionsOptions) List collections.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichments>	listEnrichments(ListEnrichmentsOptions listEnrichmentsOptions) List Enrichments.
com.ibm.cloud.sdk.core.http.ServiceCall<ListFieldsResponse>	listFields(ListFieldsOptions listFieldsOptions) List fields.
com.ibm.cloud.sdk.core.http.ServiceCall<ListProjectsResponse>	listProjects() List projects.
com.ibm.cloud.sdk.core.http.ServiceCall<ListProjectsResponse>	listProjects(ListProjectsOptions listProjectsOptions) List projects.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuerySet>	listTrainingQueries(ListTrainingQueriesOptions listTrainingQueriesOptions) List training queries.
com.ibm.cloud.sdk.core.http.ServiceCall<QueryResponse>	query(QueryOptions queryOptions) Query a project.
com.ibm.cloud.sdk.core.http.ServiceCall<QueryNoticesResponse>	queryCollectionNotices(QueryCollectionNoticesOptions queryCollectionNoticesOptions) Query collection notices.
com.ibm.cloud.sdk.core.http.ServiceCall<QueryNoticesResponse>	queryNotices(QueryNoticesOptions queryNoticesOptions) Query project notices.
void	setVersion(String version) Sets the version.
com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails>	updateCollection(UpdateCollectionOptions updateCollectionOptions) Update a collection.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentAccepted>	updateDocument(UpdateDocumentOptions updateDocumentOptions) Update a document.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment>	updateEnrichment(UpdateEnrichmentOptions updateEnrichmentOptions) Update an enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails>	updateProject(UpdateProjectOptions updateProjectOptions) Update a project.
com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery>	updateTrainingQuery(UpdateTrainingQueryOptions updateTrainingQueryOptions) Update a training query.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, enableGzipCompression, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

Discovery

public Discovery(String version)

Constructs an instance of the `Discovery` client. The default service name is used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2019-11-22`.

Discovery

public Discovery(String version,
                 com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `Discovery` client. The default service name and specified authenticator are used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2019-11-22`.

authenticator - the Authenticator instance to be configured for this client

Discovery

public Discovery(String version,
                 String serviceName)

Constructs an instance of the `Discovery` client. The specified service name is used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2019-11-22`.

serviceName - the service name to be used when configuring the client instance

Discovery

public Discovery(String version,
                 String serviceName,
                 com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `Discovery` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2019-11-22`.

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

getVersion

public String getVersion()

Gets the version.

Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2019-11-22`.

Returns:

the version

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the new version

listCollections

public com.ibm.cloud.sdk.core.http.ServiceCall<ListCollectionsResponse> listCollections(ListCollectionsOptions listCollectionsOptions)

List collections.

Lists existing collections for the specified project.

Parameters:

listCollectionsOptions - the ListCollectionsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListCollectionsResponse

createCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails> createCollection(CreateCollectionOptions createCollectionOptions)

Create a collection.

Create a new collection in the specified project.

Parameters:

createCollectionOptions - the CreateCollectionOptions containing the options for the call

Returns:

a ServiceCall with a result of type CollectionDetails

getCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails> getCollection(GetCollectionOptions getCollectionOptions)

Get collection.

Get details about the specified collection.

Parameters:

getCollectionOptions - the GetCollectionOptions containing the options for the call

Returns:

a ServiceCall with a result of type CollectionDetails

updateCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<CollectionDetails> updateCollection(UpdateCollectionOptions updateCollectionOptions)

Update a collection.

Updates the specified collection's name, description, and enrichments.

Parameters:

updateCollectionOptions - the UpdateCollectionOptions containing the options for the call

Returns:

a ServiceCall with a result of type CollectionDetails

deleteCollection

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteCollection(DeleteCollectionOptions deleteCollectionOptions)

Delete a collection.

Deletes the specified collection from the project. All documents stored in the specified collection and not shared is also deleted.

Parameters:

deleteCollectionOptions - the DeleteCollectionOptions containing the options for the call

Returns:

a ServiceCall with a void result

query

public com.ibm.cloud.sdk.core.http.ServiceCall<QueryResponse> query(QueryOptions queryOptions)

Query a project.

By using this method, you can construct queries. For details, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-concepts). The default query parameters are defined by the settings for this project, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-project-defaults) for an overview of the standard default settings, and see [the Projects API documentation](#create-project) for details about how to set custom default query settings.

Parameters:

queryOptions - the QueryOptions containing the options for the call

Returns:

a ServiceCall with a result of type QueryResponse

getAutocompletion

public com.ibm.cloud.sdk.core.http.ServiceCall<Completions> getAutocompletion(GetAutocompletionOptions getAutocompletionOptions)

Get Autocomplete Suggestions.

Returns completion query suggestions for the specified prefix.

Parameters:

getAutocompletionOptions - the GetAutocompletionOptions containing the options for the call

Returns:

a ServiceCall with a result of type Completions

queryCollectionNotices

public com.ibm.cloud.sdk.core.http.ServiceCall<QueryNoticesResponse> queryCollectionNotices(QueryCollectionNoticesOptions queryCollectionNoticesOptions)

Query collection notices.

Finds collection-level notices (errors and warnings) that are generated when documents are ingested.

Parameters:

queryCollectionNoticesOptions - the QueryCollectionNoticesOptions containing the options for the call

Returns:

a ServiceCall with a result of type QueryNoticesResponse

queryNotices

public com.ibm.cloud.sdk.core.http.ServiceCall<QueryNoticesResponse> queryNotices(QueryNoticesOptions queryNoticesOptions)

Query project notices.

Finds project-level notices (errors and warnings). Currently, project-level notices are generated by relevancy training.

Parameters:

queryNoticesOptions - the QueryNoticesOptions containing the options for the call

Returns:

a ServiceCall with a result of type QueryNoticesResponse

listFields

public com.ibm.cloud.sdk.core.http.ServiceCall<ListFieldsResponse> listFields(ListFieldsOptions listFieldsOptions)

List fields.

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

Parameters:

listFieldsOptions - the ListFieldsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListFieldsResponse

getComponentSettings

public com.ibm.cloud.sdk.core.http.ServiceCall<ComponentSettingsResponse> getComponentSettings(GetComponentSettingsOptions getComponentSettingsOptions)

List component settings.

Returns default configuration settings for components.

Parameters:

getComponentSettingsOptions - the GetComponentSettingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ComponentSettingsResponse

addDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentAccepted> addDocument(AddDocumentOptions addDocumentOptions)

Add a document.

Add a document to a collection with optional metadata.

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 `,`

If the document is uploaded to a collection that has it's data shared with another collection, the **X-Watson-Discovery-Force** header must be set to `true`.

**Note:** Documents can be added with a specific **document_id** by using the **_/v2/projects/{project_id}/collections/{collection_id}/documents** method.

**Note:** This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

Parameters:

addDocumentOptions - the AddDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentAccepted

updateDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentAccepted> updateDocument(UpdateDocumentOptions updateDocumentOptions)

Update a document.

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

If the document is uploaded to a collection that has it's data shared with another collection, the **X-Watson-Discovery-Force** header must be set to `true`.

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

**Note:** This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

**Note:** If an uploaded document is segmented, all segments will be overwritten, even if the updated version of the document has fewer segments.

Parameters:

updateDocumentOptions - the UpdateDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentAccepted

deleteDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<DeleteDocumentResponse> 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'.

**Note:** This operation only works on collections created to accept direct file uploads. It cannot be used to modify a collection that connects to an external source such as Microsoft SharePoint.

**Note:** Segments of an uploaded document cannot be deleted individually. Delete all segments by deleting using the `parent_document_id` of a segment result.

Parameters:

deleteDocumentOptions - the DeleteDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type DeleteDocumentResponse

listTrainingQueries

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuerySet> listTrainingQueries(ListTrainingQueriesOptions listTrainingQueriesOptions)

List training queries.

List the training queries for the specified project.

Parameters:

listTrainingQueriesOptions - the ListTrainingQueriesOptions containing the options for the call

Returns:

a ServiceCall with a result of type TrainingQuerySet

deleteTrainingQueries

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTrainingQueries(DeleteTrainingQueriesOptions deleteTrainingQueriesOptions)

Delete training queries.

Removes all training queries for the specified project.

Parameters:

deleteTrainingQueriesOptions - the DeleteTrainingQueriesOptions containing the options for the call

Returns:

a ServiceCall with a void result

createTrainingQuery

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery> createTrainingQuery(CreateTrainingQueryOptions createTrainingQueryOptions)

Create training query.

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

Parameters:

createTrainingQueryOptions - the CreateTrainingQueryOptions containing the options for the call

Returns:

a ServiceCall with a result of type TrainingQuery

getTrainingQuery

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery> getTrainingQuery(GetTrainingQueryOptions getTrainingQueryOptions)

Get a training data query.

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

Parameters:

getTrainingQueryOptions - the GetTrainingQueryOptions containing the options for the call

Returns:

a ServiceCall with a result of type TrainingQuery

updateTrainingQuery

public com.ibm.cloud.sdk.core.http.ServiceCall<TrainingQuery> updateTrainingQuery(UpdateTrainingQueryOptions updateTrainingQueryOptions)

Update a training query.

Updates an existing training query and it's examples.

Parameters:

updateTrainingQueryOptions - the UpdateTrainingQueryOptions containing the options for the call

Returns:

a ServiceCall with a result of type TrainingQuery

deleteTrainingQuery

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTrainingQuery(DeleteTrainingQueryOptions deleteTrainingQueryOptions)

Delete a training data query.

Removes details from a training data query, including the query string and all examples.

Parameters:

deleteTrainingQueryOptions - the DeleteTrainingQueryOptions containing the options for the call

Returns:

a ServiceCall with a void result

analyzeDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<AnalyzedDocument> analyzeDocument(AnalyzeDocumentOptions analyzeDocumentOptions)

Analyze a Document.

Process a document using the specified collection's settings and return it for realtime use.

**Note:** Documents processed using this method are not added to the specified collection.

**Note:** This method is only supported on IBM Cloud Pak for Data instances of Discovery.

Parameters:

analyzeDocumentOptions - the AnalyzeDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type AnalyzedDocument

listEnrichments

public com.ibm.cloud.sdk.core.http.ServiceCall<Enrichments> listEnrichments(ListEnrichmentsOptions listEnrichmentsOptions)

List Enrichments.

List the enrichments available to this project.

Parameters:

listEnrichmentsOptions - the ListEnrichmentsOptions containing the options for the call

Returns:

a ServiceCall with a result of type Enrichments

createEnrichment

public com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment> createEnrichment(CreateEnrichmentOptions createEnrichmentOptions)

Create an enrichment.

Create an enrichment for use with the specified project/.

Parameters:

createEnrichmentOptions - the CreateEnrichmentOptions containing the options for the call

Returns:

a ServiceCall with a result of type Enrichment

getEnrichment

public com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment> getEnrichment(GetEnrichmentOptions getEnrichmentOptions)

Get enrichment.

Get details about a specific enrichment.

Parameters:

getEnrichmentOptions - the GetEnrichmentOptions containing the options for the call

Returns:

a ServiceCall with a result of type Enrichment

updateEnrichment

public com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment> updateEnrichment(UpdateEnrichmentOptions updateEnrichmentOptions)

Update an enrichment.

Updates an existing enrichment's name and description.

Parameters:

updateEnrichmentOptions - the UpdateEnrichmentOptions containing the options for the call

Returns:

a ServiceCall with a result of type Enrichment

deleteEnrichment

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteEnrichment(DeleteEnrichmentOptions deleteEnrichmentOptions)

Delete an enrichment.

Deletes an existing enrichment from the specified project.

**Note:** Only enrichments that have been manually created can be deleted.

Parameters:

deleteEnrichmentOptions - the DeleteEnrichmentOptions containing the options for the call

Returns:

a ServiceCall with a void result

listProjects

public com.ibm.cloud.sdk.core.http.ServiceCall<ListProjectsResponse> listProjects(ListProjectsOptions listProjectsOptions)

List projects.

Lists existing projects for this instance.

Parameters:

listProjectsOptions - the ListProjectsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListProjectsResponse

listProjects

public com.ibm.cloud.sdk.core.http.ServiceCall<ListProjectsResponse> listProjects()

List projects.

Lists existing projects for this instance.

Returns:

a ServiceCall with a result of type ListProjectsResponse

createProject

public com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails> createProject(CreateProjectOptions createProjectOptions)

Create a Project.

Create a new project for this instance.

Parameters:

createProjectOptions - the CreateProjectOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProjectDetails

getProject

public com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails> getProject(GetProjectOptions getProjectOptions)

Get project.

Get details on the specified project.

Parameters:

getProjectOptions - the GetProjectOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProjectDetails

updateProject

public com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails> updateProject(UpdateProjectOptions updateProjectOptions)

Update a project.

Update the specified project's name.

Parameters:

updateProjectOptions - the UpdateProjectOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProjectDetails

deleteProject

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteProject(DeleteProjectOptions deleteProjectOptions)

Delete a project.

Deletes the specified project.

**Important:** Deleting a project deletes everything that is part of the specified project, including all collections.

Parameters:

deleteProjectOptions - the DeleteProjectOptions containing the options for the call

Returns:

a ServiceCall with a void result

deleteUserData

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteUserData(DeleteUserDataOptions deleteUserDataOptions)

Delete labeled data.

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](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-information-security#information-security).

**Note:** This method is only supported on IBM Cloud instances of Discovery.

Parameters:

deleteUserDataOptions - the DeleteUserDataOptions containing the options for the call

Returns:

a ServiceCall with a void result