JavaScript is disabled on your browser.
com.ibm.watson.discovery.v2

Class Discovery


  • public class Discovery
extends com.ibm.cloud.sdk.core.service.BaseService
    IBM Watson™ Discovery for IBM Cloud Pak for Data 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

    • Constructor Detail

      • Discovery

        public Discovery(java.lang.String versionDate)
        Constructs a new `Discovery` client using the DEFAULT_SERVICE_NAME.
        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,
 com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs a new `Discovery` client with the DEFAULT_SERVICE_NAME and the specified Authenticator.
        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.
        authenticator - the Authenticator instance to be configured for this service

      • Discovery

        public Discovery(java.lang.String versionDate,
 java.lang.String serviceName)
        Constructs a new `Discovery` client with the specified serviceName.
        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.
        serviceName - The name of the service to configure.

      • Discovery

        public Discovery(java.lang.String versionDate,
 java.lang.String serviceName,
 com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs a new `Discovery` client with the specified Authenticator and serviceName.
        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.
        serviceName - The name of the service to configure.
        authenticator - the Authenticator instance to be configured for this service

    • Method Detail

      • 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/services/discovery-data?topic=discovery-data-query-concepts).
        Parameters:
        queryOptions - the QueryOptions containing the options for the call
        Returns:
        a ServiceCall with a response type of 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 response type of Completions

      • queryNotices

        public com.ibm.cloud.sdk.core.http.ServiceCall<QueryNoticesResponse> queryNotices(QueryNoticesOptions queryNoticesOptions)
        Query system notices. Queries for notices (errors or warnings) that might have been generated by the system. Notices are generated when ingesting documents and performing relevance training.
        Parameters:
        queryNoticesOptions - the QueryNoticesOptions containing the options for the call
        Returns:
        a ServiceCall with a response type of 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 response type of ListFieldsResponse

      • 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 response type of 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.
        Parameters:
        updateDocumentOptions - the UpdateDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a response type of 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.
        Parameters:
        deleteDocumentOptions - the DeleteDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a response type of DeleteDocumentResponse

      • deleteTrainingQueries

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.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 response type of Void

      • 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 response type of 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 response type of 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 response type of TrainingQuery

AltStyle によって変換されたページ (->オリジナル) /