com.ibm.watson.developer_cloud.discovery.v1.model.document

Interface DocumentManager

All Known Implementing Classes:

Discovery

public interface DocumentManager

Interface defining the constants and methods associated with Environments.

See Also:

Document

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURATION_ID
static java.lang.String	CREATED
static java.lang.String	FILE
static java.lang.String	ID
static java.lang.String	METADATA
static java.lang.String	STATUS
static java.lang.String	STATUS_DESCRIPTION
static java.lang.String	UPDATED

Method Summary

Modifier and Type	Method and Description
ServiceCall<CreateDocumentResponse>	createDocument(CreateDocumentRequest createRequest) Starts ingesting a document with optional metadata and optional configuration overrides.
ServiceCall<DeleteDocumentResponse>	deleteDocument(DeleteDocumentRequest deleteRequest) Deletes a Document.
ServiceCall<GetDocumentResponse>	getDocument(GetDocumentRequest getRequest) Gets a Document.
ServiceCall<UpdateDocumentResponse>	updateDocument(UpdateDocumentRequest updateRequest) Starts ingesting a source document to create or replace an existing document.

Field Detail

ID

static final java.lang.String ID

See Also:

Constant Field Values

CONFIGURATION_ID

static final java.lang.String CONFIGURATION_ID

See Also:

Constant Field Values

CREATED

static final java.lang.String CREATED

See Also:

Constant Field Values

UPDATED

static final java.lang.String UPDATED

See Also:

Constant Field Values

STATUS

static final java.lang.String STATUS

See Also:

Constant Field Values

STATUS_DESCRIPTION

static final java.lang.String STATUS_DESCRIPTION

See Also:

Constant Field Values

FILE

static final java.lang.String FILE

See Also:

Constant Field Values

METADATA

static final java.lang.String METADATA

See Also:

Constant Field Values

Method Detail

getDocument

ServiceCall<GetDocumentResponse> getDocument(GetDocumentRequest getRequest)

Gets a Document.

Parameters:

getRequest - options for getting a Document

Returns:

a GetDocumentResponse containing the details of GetDocumentRequest

createDocument

ServiceCall<CreateDocumentResponse> createDocument(CreateDocumentRequest createRequest)

Starts ingesting a document with optional metadata and optional configuration overrides. 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, then it will be rejected. 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 (e.g. application/octet-stream), then the service will attempt to automatically detect the document's media type.

Parameters:

createRequest - options for creating a Document

Returns:

a CreateDocumentResponse containing the details of CreateDocumentRequest

deleteDocument

ServiceCall<DeleteDocumentResponse> deleteDocument(DeleteDocumentRequest deleteRequest)

Deletes a Document.

Parameters:

deleteRequest - options for deleting a Document

Returns:

a DeleteDocumentResponse containing the details of DeleteDocumentRequest

updateDocument

ServiceCall<UpdateDocumentResponse> updateDocument(UpdateDocumentRequest updateRequest)

Starts ingesting a source document to create or replace an existing document. This is a POST operation instead of a PUT operation because an existing document may be partially updated, depending on whether or not the new, replacement document is successfully ingested (see the next bullet for details). - If a document already exists with the provided Document ID, then the fate of the original document depends on whether or not the new document is successfully ingested - If the new document fails, then the original document is left intact in the collection's index. However, any previous notices (warnings or errors) that were stored for the original document are replaced with the new document's notices. - If the new document is successfully processed, then the original document is replaced with the new document in the collection's index, including any notices. - Only the document_id from the request path is used. If the user provides a document_id in the input document (assuming JSON is submitted), it will be ignored. 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, then it will be rejected. 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 (e.g. application/octet-stream), then the service will attempt to automatically detect the document's media type.

Parameters:

updateRequest - options for updating a Document

Returns:

a UpdateDocumentResponse containing the details of UpdateDocumentRequest