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.

API Version: 2.0 See: https://cloud.ibm.com/docs/discovery-data

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_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, 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<DocumentClassifier>	createDocumentClassifier(CreateDocumentClassifierOptions createDocumentClassifierOptions) Create a document classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel>	createDocumentClassifierModel(CreateDocumentClassifierModelOptions createDocumentClassifierModelOptions) Create a document classifier model.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichment>	createEnrichment(CreateEnrichmentOptions createEnrichmentOptions) Create an enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<Expansions>	createExpansions(CreateExpansionsOptions createExpansionsOptions) Create or update an expansion list.
com.ibm.cloud.sdk.core.http.ServiceCall<ProjectDetails>	createProject(CreateProjectOptions createProjectOptions) Create a project.
com.ibm.cloud.sdk.core.http.ServiceCall<StopWordList>	createStopwordList(CreateStopwordListOptions createStopwordListOptions) Create a custom stop words list.
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>	deleteDocumentClassifier(DeleteDocumentClassifierOptions deleteDocumentClassifierOptions) Delete a document classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteDocumentClassifierModel(DeleteDocumentClassifierModelOptions deleteDocumentClassifierModelOptions) Delete a document classifier model.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteEnrichment(DeleteEnrichmentOptions deleteEnrichmentOptions) Delete an enrichment.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteExpansions(DeleteExpansionsOptions deleteExpansionsOptions) Delete the expansion list.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteProject(DeleteProjectOptions deleteProjectOptions) Delete a project.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteStopwordList(DeleteStopwordListOptions deleteStopwordListOptions) Delete a custom stop words list.
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<DocumentDetails>	getDocument(GetDocumentOptions getDocumentOptions) Get document details.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifier>	getDocumentClassifier(GetDocumentClassifierOptions getDocumentClassifierOptions) Get a document classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel>	getDocumentClassifierModel(GetDocumentClassifierModelOptions getDocumentClassifierModelOptions) Get a document classifier model.
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<StopWordList>	getStopwordList(GetStopwordListOptions getStopwordListOptions) Get a custom stop words list.
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<DocumentClassifierModels>	listDocumentClassifierModels(ListDocumentClassifierModelsOptions listDocumentClassifierModelsOptions) List document classifier models.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifiers>	listDocumentClassifiers(ListDocumentClassifiersOptions listDocumentClassifiersOptions) List document classifiers.
com.ibm.cloud.sdk.core.http.ServiceCall<ListDocumentsResponse>	listDocuments(ListDocumentsOptions listDocumentsOptions) List documents.
com.ibm.cloud.sdk.core.http.ServiceCall<Enrichments>	listEnrichments(ListEnrichmentsOptions listEnrichmentsOptions) List enrichments.
com.ibm.cloud.sdk.core.http.ServiceCall<Expansions>	listExpansions(ListExpansionsOptions listExpansionsOptions) Get the expansion list.
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<DocumentClassifier>	updateDocumentClassifier(UpdateDocumentClassifierOptions updateDocumentClassifierOptions) Update a document classifier.
com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel>	updateDocumentClassifierModel(UpdateDocumentClassifierModelOptions updateDocumentClassifierModelOptions) Update a document classifier model.
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, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, 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 `2020-08-30`.

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 `2020-08-30`.

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 `2020-08-30`.

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 `2020-08-30`.

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 `2020-08-30`.

Returns:

the version

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the new version

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

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 specified collections.

Parameters:

listFieldsOptions - the ListFieldsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListFieldsResponse

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

listDocuments

public com.ibm.cloud.sdk.core.http.ServiceCall<ListDocumentsResponse> listDocuments(ListDocumentsOptions listDocumentsOptions)

List documents.

Lists the documents in the specified collection. The list includes only the document ID of each document and returns information for up to 10,000 documents.

**Note**: This method is available only from Cloud Pak for Data version 4.0.9 and later installed instances and from Plus and Enterprise plan IBM Cloud-managed instances.

Parameters:

listDocumentsOptions - the ListDocumentsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ListDocumentsResponse

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.

This operation works with a file upload collection. It cannot be used to modify a collection that crawls an external data source.

* For a list of supported file types, see the [product documentation](/docs/discovery-data?topic=discovery-data-collections#supportedfiletypes).

* You must provide document content, metadata, or both. If the request is missing both document content and metadata, it is rejected.

* You 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.

* If the document is uploaded to a collection that shares its data with another collection, the **X-Watson-Discovery-Force** header must be set to `true`.

* In curl requests only, you can assign an ID to a document that you add by appending the ID to the endpoint (`/v2/projects/{project_id}/collections/{collection_id}/documents/{document_id}`). If a document already exists with the specified ID, it is replaced.

For more information about how certain file types and field names are handled when a file is added to a collection, see the [product documentation](/docs/discovery-data?topic=discovery-data-index-overview#field-name-limits).

Parameters:

addDocumentOptions - the AddDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentAccepted

getDocument

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentDetails> getDocument(GetDocumentOptions getDocumentOptions)

Get document details.

Get details about a specific document, whether the document is added by uploading a file or by crawling an external data source.

**Note**: This method is available only from Cloud Pak for Data version 4.0.9 and later installed instances and from Plus and Enterprise plan IBM Cloud-managed instances.

Parameters:

getDocumentOptions - the GetDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentDetails

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.

This operation works with a file upload collection. It cannot be used to modify a collection that crawls an external data source.

If the document is uploaded to a collection that shares its data with another collection, the **X-Watson-Discovery-Force** header must be set to `true`.

**Notes:**

* Uploading a new document with this method automatically replaces any existing document stored with the same document ID.

* If an uploaded document is split into child documents during ingestion, all existing child documents are overwritten, even if the updated version of the document has fewer child documents.

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

query

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

Query a project.

Search your data by submitting queries that are written in natural language or formatted in the Discovery Query Language. For more information, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-concepts). The default query parameters differ by project type. For more information about the project default settings, see the [Discovery documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-query-defaults). See [the Projects API documentation](#create-project) for details about how to set custom default query settings.

The length of the UTF-8 encoding of the POST body cannot exceed 10,000 bytes, which is roughly equivalent to 10,000 characters in English.

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

getStopwordList

public com.ibm.cloud.sdk.core.http.ServiceCall<StopWordList> getStopwordList(GetStopwordListOptions getStopwordListOptions)

Get a custom stop words list.

Returns the custom stop words list that is used by the collection. For information about the default stop words lists that are applied to queries, see [the product documentation](/docs/discovery-data?topic=discovery-data-stopwords).

Parameters:

getStopwordListOptions - the GetStopwordListOptions containing the options for the call

Returns:

a ServiceCall with a result of type StopWordList

createStopwordList

public com.ibm.cloud.sdk.core.http.ServiceCall<StopWordList> createStopwordList(CreateStopwordListOptions createStopwordListOptions)

Create a custom stop words list.

Adds a list of custom stop words. Stop words are words that you want the service to ignore when they occur in a query because they're not useful in distinguishing the semantic meaning of the query. The stop words list cannot contain more than 1 million characters.

A default stop words list is used by all collections. The default list is applied both at indexing time and at query time. A custom stop words list that you add is used at query time only.

The custom stop words list replaces the default stop words list. Therefore, if you want to keep the stop words that were used when the collection was indexed, get the default stop words list for the language of the collection first and edit it to create your custom list. For information about the default stop words lists per language, see [the product documentation](/docs/discovery-data?topic=discovery-data-stopwords).

Parameters:

createStopwordListOptions - the CreateStopwordListOptions containing the options for the call

Returns:

a ServiceCall with a result of type StopWordList

deleteStopwordList

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteStopwordList(DeleteStopwordListOptions deleteStopwordListOptions)

Delete a custom stop words list.

Deletes a custom stop words list to stop using it in queries against the collection. After a custom stop words list is deleted, the default stop words list is used.

Parameters:

deleteStopwordListOptions - the DeleteStopwordListOptions containing the options for the call

Returns:

a ServiceCall with a void result

listExpansions

public com.ibm.cloud.sdk.core.http.ServiceCall<Expansions> listExpansions(ListExpansionsOptions listExpansionsOptions)

Get the expansion list.

Returns the current expansion list for the specified collection. If an expansion list is not specified, an empty expansions array is returned.

Parameters:

listExpansionsOptions - the ListExpansionsOptions containing the options for the call

Returns:

a ServiceCall with a result of type Expansions

createExpansions

public com.ibm.cloud.sdk.core.http.ServiceCall<Expansions> createExpansions(CreateExpansionsOptions createExpansionsOptions)

Create or update an expansion list.

Creates or replaces the expansion list for this collection. An expansion list introduces alternative wording for key terms that are mentioned in your collection. By identifying synonyms or common misspellings, you expand the scope of a query beyond exact matches. The maximum number of expanded terms allowed per collection is 5,000.

Parameters:

createExpansionsOptions - the CreateExpansionsOptions containing the options for the call

Returns:

a ServiceCall with a result of type Expansions

deleteExpansions

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteExpansions(DeleteExpansionsOptions deleteExpansionsOptions)

Delete the expansion list.

Removes the expansion information for this collection. To disable query expansion for a collection, delete the expansion list.

Parameters:

deleteExpansionsOptions - the DeleteExpansionsOptions containing the options for the call

Returns:

a ServiceCall with a void result

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

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

listEnrichments

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

List enrichments.

Lists the enrichments available to this project. The *Part of Speech* and *Sentiment of Phrases* enrichments might be listed, but are reserved for internal use only.

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. To apply the enrichment to a collection in the project, use the [Collections API](/apidocs/discovery-data#createcollection).

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

listDocumentClassifiers

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifiers> listDocumentClassifiers(ListDocumentClassifiersOptions listDocumentClassifiersOptions)

List document classifiers.

Get a list of the document classifiers in a project. Returns only the name and classifier ID of each document classifier.

Parameters:

listDocumentClassifiersOptions - the ListDocumentClassifiersOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifiers

createDocumentClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifier> createDocumentClassifier(CreateDocumentClassifierOptions createDocumentClassifierOptions)

Create a document classifier.

Create a document classifier. You can use the API to create a document classifier in any project type. After you create a document classifier, you can use the Enrichments API to create a classifier enrichment, and then the Collections API to apply the enrichment to a collection in the project.

**Note:** This method is supported on installed instances (IBM Cloud Pak for Data) or IBM Cloud-managed Premium or Enterprise plan instances.

Parameters:

createDocumentClassifierOptions - the CreateDocumentClassifierOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifier

getDocumentClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifier> getDocumentClassifier(GetDocumentClassifierOptions getDocumentClassifierOptions)

Get a document classifier.

Get details about a specific document classifier.

Parameters:

getDocumentClassifierOptions - the GetDocumentClassifierOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifier

updateDocumentClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifier> updateDocumentClassifier(UpdateDocumentClassifierOptions updateDocumentClassifierOptions)

Update a document classifier.

Update the document classifier name or description, update the training data, or add or update the test data.

Parameters:

updateDocumentClassifierOptions - the UpdateDocumentClassifierOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifier

deleteDocumentClassifier

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteDocumentClassifier(DeleteDocumentClassifierOptions deleteDocumentClassifierOptions)

Delete a document classifier.

Deletes an existing document classifier from the specified project.

Parameters:

deleteDocumentClassifierOptions - the DeleteDocumentClassifierOptions containing the options for the call

Returns:

a ServiceCall with a void result

listDocumentClassifierModels

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModels> listDocumentClassifierModels(ListDocumentClassifierModelsOptions listDocumentClassifierModelsOptions)

List document classifier models.

Get a list of the document classifier models in a project. Returns only the name and model ID of each document classifier model.

Parameters:

listDocumentClassifierModelsOptions - the ListDocumentClassifierModelsOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifierModels

createDocumentClassifierModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel> createDocumentClassifierModel(CreateDocumentClassifierModelOptions createDocumentClassifierModelOptions)

Create a document classifier model.

Create a document classifier model by training a model that uses the data and classifier settings defined in the specified document classifier.

**Note:** This method is supported on installed intances (IBM Cloud Pak for Data) or IBM Cloud-managed Premium or Enterprise plan instances.

Parameters:

createDocumentClassifierModelOptions - the CreateDocumentClassifierModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifierModel

getDocumentClassifierModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel> getDocumentClassifierModel(GetDocumentClassifierModelOptions getDocumentClassifierModelOptions)

Get a document classifier model.

Get details about a specific document classifier model.

Parameters:

getDocumentClassifierModelOptions - the GetDocumentClassifierModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifierModel

updateDocumentClassifierModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DocumentClassifierModel> updateDocumentClassifierModel(UpdateDocumentClassifierModelOptions updateDocumentClassifierModelOptions)

Update a document classifier model.

Update the document classifier model name or description.

Parameters:

updateDocumentClassifierModelOptions - the UpdateDocumentClassifierModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DocumentClassifierModel

deleteDocumentClassifierModel

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteDocumentClassifierModel(DeleteDocumentClassifierModelOptions deleteDocumentClassifierModelOptions)

Delete a document classifier model.

Deletes an existing document classifier model from the specified project.

Parameters:

deleteDocumentClassifierModelOptions - the DeleteDocumentClassifierModelOptions 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 and return it for realtime use. Supports JSON files only.

The file is not stored in the collection, but is processed according to the collection's configuration settings. To get results, enrichments must be applied to a field in the collection that also exists in the file that you want to analyze. For example, to analyze text in a `Quote` field, you must apply enrichments to the `Quote` field in the collection configuration. Then, when you analyze the file, the text in the `Quote` field is analyzed and results are written to a field named `enriched_Quote`.

**Note:** This method is supported with Enterprise plan deployments and installed deployments only.

Parameters:

analyzeDocumentOptions - the AnalyzeDocumentOptions containing the options for the call

Returns:

a ServiceCall with a result of type AnalyzedDocument

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