com.ibm.watson.discovery.v2.model

Class AnalyzeDocumentOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v2.model.AnalyzeDocumentOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class AnalyzeDocumentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The analyzeDocument options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnalyzeDocumentOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	collectionId() Gets the collectionId.
InputStream	file() Gets the file.
String	fileContentType() Gets the fileContentType.
String	filename() Gets the filename.
String	metadata() Gets the metadata.
AnalyzeDocumentOptions.Builder	newBuilder() New builder.
String	projectId() Gets the projectId.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public AnalyzeDocumentOptions.Builder newBuilder()

New builder.

Returns:

a AnalyzeDocumentOptions builder

projectId

public String projectId()

Gets the projectId.

The ID of the project. This information can be found from the *Integrate and Deploy* page in Discovery.

Returns:

the projectId

collectionId

public String collectionId()

Gets the collectionId.

The ID of the collection.

Returns:

the collectionId

file

public InputStream file()

Gets the file.

When adding a document, the content of the document to ingest. For maximum supported file size limits, see [the documentation](/docs/discovery-data?topic=discovery-data-collections#collections-doc-limits).

When analyzing a document, the content of the document to analyze but not ingest. Only the `application/json` content type is supported currently. For maximum supported file size limits, see [the product documentation](/docs/discovery-data?topic=discovery-data-analyzeapi#analyzeapi-limits).

Returns:

the file

filename

public String filename()

Gets the filename.

The filename for file.

Returns:

the filename

fileContentType

public String fileContentType()

Gets the fileContentType.

The content type of file. Values for this parameter can be obtained from the HttpMediaType class.

Returns:

the fileContentType

metadata

public String metadata()

Gets the metadata.

Add information about the file that you want to include in the response.

The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected.

Example:

``` { "filename": "favorites2.json", "file_type": "json" }.

Returns:

the metadata