com.ibm.watson.developer_cloud.document_conversion.v1

Class DocumentConversion

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.document_conversion.v1.DocumentConversion

public class DocumentConversion
extends WatsonService

The IBM Watson Document Conversion service converts provided source documents (HTML, Word, PDF) into JSON Answer Units, Normalized HTML, or Normalized Text.

Version:

v1

See Also:

Document Conversion

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT The default limit for get requests.
static String	JOB_ID The Constant JOB_ID.
static String	LIMIT The Constant LIMIT.
static String	MEDIA_TYPE The Constant MEDIA_TYPE.
static String	NAME The Constant NAME.
static String	SINCE The Constant SINCE.
static String	STATUS The Constant STATUS.
static String	TOKEN The Constant TOKEN.

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

FORWARD_SLASH

Constructor Summary

Constructors

Constructor and Description
DocumentConversion() Sets the endpoint url for the service.

Method Summary

Modifier and Type	Method and Description
BatchDocumentResponse	addDocumentToBatch(String batchId, String documentId) Adds a document to the batch whose ids are specified PUT /v1/batches/{batch_id}/documents/{document_id}.
InputStream	convertDocument(File document, ConversionTarget conversionTarget) Synchronously converts a new document without persistence POST /v1/convert_document.
InputStream	convertDocument(File document, String mediaType, ConversionTarget conversionTarget) Synchronously converts a new document without persistence POST /v1/convert_document.
InputStream	convertDocument(String documentId, ConversionTarget conversionTarget) Synchronously converts a single previously uploaded document POST /v1/convert_document.
Answers	convertDocumentToAnswer(File document) Synchronously converts a new document without persistence into an Answers object POST /v1/convert_document.
Answers	convertDocumentToAnswer(String documentId) Synchronously converts a single previously uploaded document into an Answers object POST /v1/convert_document.
Batch	createBatch(String name, List<Property> properties) Creates a new batch with name and properties POST /v1/batches.
JobResponse	createJob(String name, String batchId, ConversionTarget conversionTarget) Creates a new job by submitting a batch for processing POST /v1/jobs.
JobResponse	createJob(String name, String batchId, ConversionTarget conversionTarget, com.google.gson.JsonObject config) Creates a new job by submitting a batch for processing POST /v1/jobs.
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpRequestBase request) Execute the Http request.
Batch	getBatch(String batchId) Gets an existing batch GET /v1/batches/{batch_id}.
BatchCollection	getBatchCollection() Gets a collection of all existing batches in the service GET /v1/batches.
BatchCollection	getBatchCollection(Map<String,Object> batchListParams) Gets a collection of all existing batches with optional query parameters for filtering results.
BatchDocumentResponse	getBatchDocument(String batchId, String documentId) Retrieves the documents from the batch whose ids are specified GET /v1/batches/{batch_id}/documents/{document_id}.
BatchDocumentCollection	getBatchDocumentCollection(String batchId) Gets a collection of existing documents in the batch GET /v1/batches/{batch_id}/documents.
BatchDocumentCollection	getBatchDocumentCollection(String batchId, Map<String,Object> batchDocListParams) Gets a list of existing documents in the batch with optional query parameters for filtering results.
InputStream	getDocument(String documentId) Retrieves a document from the service with the given id GET /v1/documents/{document_id}.
DocumentCollection	getDocumentCollection() Gets a collection of uploaded documents GET /v1/documents.
DocumentCollection	getDocumentCollection(Map<String,Object> docListParams) Gets a collection of all existing documents with optional query parameters for filtering results.
Job	getJob(String jobId) Gets information about a job GET /v1/jobs/{job_id}.
JobCollection	getJobCollection() Gets a collection of all jobs in the service GET /v1/jobs.
JobCollection	getJobCollection(Map<String,Object> jobListParams) Gets a list of all jobs with optional query parameters for filtering results.
InputStream	getJobLog(String jobId) Gets the job processing log GET /v1/jobs/{job_id}/log.
InputStream	getOutput(String outputId) Gets the content of the output of the document conversion process.
OutputCollection	getOutputCollection() Gets a collection of all generated outputs GET /v1/output.
OutputCollection	getOutputCollection(Map<String,Object> outputListParams) Gets a collection of all generated outputs with optional query parameters for filtering results.
Batch	updateBatch(String batchId, String name, List<Property> properties) Updates an existing batch with the provided name and properties PUT /v1/batches/{batch_id}.
Document	uploadDocument(File document) Uploads the document to the service with the given media type POST /v1/documents.
Document	uploadDocument(File document, String mediaType) Uploads the document to the service with the given media type POST /v1/documents.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

executeRequest, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getHttpClient, getThreadSafeClient, setApiKey, setAuthentication, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

The default limit for get requests.

See Also:

Constant Field Values

JOB_ID

public static final String JOB_ID

The Constant JOB_ID. (value is "job_id")

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

The Constant LIMIT. (value is "limit")

See Also:

Constant Field Values

MEDIA_TYPE

public static final String MEDIA_TYPE

The Constant MEDIA_TYPE. (value is "media_type")

See Also:

Constant Field Values

NAME

public static final String NAME

The Constant NAME. (value is "name")

See Also:

Constant Field Values

SINCE

public static final String SINCE

The Constant SINCE. (value is "since")

See Also:

Constant Field Values

STATUS

public static final String STATUS

The Constant STATUS. (value is "status")

See Also:

Constant Field Values

TOKEN

public static final String TOKEN

The Constant TOKEN. (value is "token")

See Also:

Constant Field Values

Constructor Detail

DocumentConversion

public DocumentConversion()

Sets the endpoint url for the service.

Method Detail

addDocumentToBatch

public BatchDocumentResponse addDocumentToBatch(String batchId,
                                                String documentId)

Adds a document to the batch whose ids are specified PUT /v1/batches/{batch_id}/documents/{document_id}.

Parameters:

batchId - id of the batch to be retrieved

documentId - id of the document to be retrieved

Returns:

document from the batch

convertDocument

public InputStream convertDocument(File document,
                                   ConversionTarget conversionTarget)

Synchronously converts a new document without persistence POST /v1/convert_document.

Parameters:

document - The file to convert

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

convertDocument

public InputStream convertDocument(File document,
                                   String mediaType,
                                   ConversionTarget conversionTarget)

Synchronously converts a new document without persistence POST /v1/convert_document.

Parameters:

document - The file to convert

mediaType - Internet media type of the file

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

convertDocument

public InputStream convertDocument(String documentId,
                                   ConversionTarget conversionTarget)

Synchronously converts a single previously uploaded document POST /v1/convert_document.

Parameters:

documentId - The id of the document to convert

conversionTarget - The conversion target to use

Returns:

Converted document in the specified format

convertDocumentToAnswer

public Answers convertDocumentToAnswer(File document)

Synchronously converts a new document without persistence into an Answers object POST /v1/convert_document.

Parameters:

document - The file to convert

Returns:

Converted document as an Answer

convertDocumentToAnswer

public Answers convertDocumentToAnswer(String documentId)

Synchronously converts a single previously uploaded document into an Answers object POST /v1/convert_document.

Parameters:

documentId - The id of the document to convert

Returns:

Converted document as an Answer

createBatch

public Batch createBatch(String name,
                         List<Property> properties)

Creates a new batch with name and properties POST /v1/batches.

Parameters:

name - the name of the created batch

properties - the properties for the created batch

Returns:

requested Batch

createJob

public JobResponse createJob(String name,
                             String batchId,
                             ConversionTarget conversionTarget)

Creates a new job by submitting a batch for processing POST /v1/jobs.

Parameters:

name - The name of the job

batchId - The id of the batch to process

conversionTarget - The conversion target to use

Returns:

JobResponse

createJob

public JobResponse createJob(String name,
                             String batchId,
                             ConversionTarget conversionTarget,
                             com.google.gson.JsonObject config)

Creates a new job by submitting a batch for processing POST /v1/jobs.

Parameters:

name - The name of the job

batchId - The id of the batch to process

conversionTarget - The conversion target to use

config - The configuration to use for the job (optional), pass null to use default config

Returns:

JobResponse

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpRequestBase request)

Description copied from class: WatsonService

Execute the Http request.

Overrides:

execute in class WatsonService

Parameters:

request - the http request

Returns:

the http response

getBatch

public Batch getBatch(String batchId)

Gets an existing batch GET /v1/batches/{batch_id}.

Parameters:

batchId - id for the batch to be updated

Returns:

requested Batch

getBatchCollection

public BatchCollection getBatchCollection()

Gets a collection of all existing batches in the service GET /v1/batches.

Returns:

All batches

getBatchCollection

public BatchCollection getBatchCollection(Map<String,Object> batchListParams)

Gets a collection of all existing batches with optional query parameters for filtering results. GET /v1/batches

Parameters:

batchListParams - The parameters to be used in the batch list service call. The parameters - token, limit, name and since are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of batches to get, pass 0 to use the default limit from server (100)
• String name - The name of batches to get, pass null to exclude this filter
• Date since - The date to filter on, batches created on or after the provided date and time format will be returned, pass null to exclude this filter

Returns:

Batches based on filtering parameters provided

getBatchDocument

public BatchDocumentResponse getBatchDocument(String batchId,
                                              String documentId)

Retrieves the documents from the batch whose ids are specified GET /v1/batches/{batch_id}/documents/{document_id}.

Parameters:

batchId - id of the batch to be retrieved

documentId - id of the document to be retrieved

Returns:

document from the batch

getBatchDocumentCollection

public BatchDocumentCollection getBatchDocumentCollection(String batchId)

Gets a collection of existing documents in the batch GET /v1/batches/{batch_id}/documents.

Parameters:

batchId - The id for the batch whose documents are returned

Returns:

All documents in a batch

getBatchDocumentCollection

public BatchDocumentCollection getBatchDocumentCollection(String batchId,
                                                          Map<String,Object> batchDocListParams)

Gets a list of existing documents in the batch with optional query parameters for filtering results. GET /v1/batches/{batch_id}/documents

Parameters:

batchId - The id for the batch whose documents are returned

batchDocListParams - The parameters to be used in the batch documents list service call. The parameters - token, limit, since, job_id and media_type are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of documents in a batch to get, pass 0 to use the default limit from server (100)
• Date since - The date to filter on, documents added to the batch on or after the provided date and time format will be returned.

Returns:

Documents in a batch based on the filtering parameters provided

getDocument

public InputStream getDocument(String documentId)

Retrieves a document from the service with the given id GET /v1/documents/{document_id}.

Parameters:

documentId - id of the document to be retrieved

Returns:

requested Document as InputStream

getDocumentCollection

public DocumentCollection getDocumentCollection()

Gets a collection of uploaded documents GET /v1/documents.

Returns:

All documents

getDocumentCollection

public DocumentCollection getDocumentCollection(Map<String,Object> docListParams)

Gets a collection of all existing documents with optional query parameters for filtering results. GET /v1/documents

Parameters:

docListParams - The parameters to be used in the documents list service call. The parameters - token, limit, name, since and media_type are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of documents to get, pass 0 to use the default limit from server (100)
• String name - The name of the documents to get, pass null to exclude this filter
• Date since - The date to filter on, documents created on or after the provided date and time format will be returned, pass null to exclude this filter
• String media_type - The Internet media type to filter on, pass null to exclude this filter

Returns:

Documents based on filtering parameters provided

getJob

public Job getJob(String jobId)

Gets information about a job GET /v1/jobs/{job_id}.

Parameters:

jobId - The id of the job

Returns:

Job

getJobCollection

public JobCollection getJobCollection()

Gets a collection of all jobs in the service GET /v1/jobs.

Returns:

All jobs

getJobCollection

public JobCollection getJobCollection(Map<String,Object> jobListParams)

Gets a list of all jobs with optional query parameters for filtering results. GET /v1/jobs

Parameters:

jobListParams - The parameters to be used in the job list service call. The parameters - token, limit, since, name, since and status are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of jobs to get, pass 0 to use the default limit from server (100)
• String name - The name of the jobs to get, pass null to exclude this filter
• Date since - The date to filter on, jobs created on or after the provided date and time format will be returned, pass null to exclude this filter
• String status - The status of the job to filter on, pass null to exclude this filter

Returns:

Jobs based on filtering parameters provided

getJobLog

public InputStream getJobLog(String jobId)

Gets the job processing log GET /v1/jobs/{job_id}/log.

Parameters:

jobId - The id of the job

Returns:

Job's processing log

getOutput

public InputStream getOutput(String outputId)

Gets the content of the output of the document conversion process. This can represent a single converted document or the combined output of multiple input documents.

Parameters:

outputId - The id of the output to get

Returns:

The requested Output

getOutputCollection

public OutputCollection getOutputCollection()

Gets a collection of all generated outputs GET /v1/output.

Returns:

All Outputs

getOutputCollection

public OutputCollection getOutputCollection(Map<String,Object> outputListParams)

Gets a collection of all generated outputs with optional query parameters for filtering results. GET /v1/output

Parameters:

outputListParams - The parameters to be used in the output list service call. The parameters - token, limit, since, job_id and media_type are optional

• String token - The reference to the starting element of the requested page which is provided by the server, pass null to get the first page
• int limit - The number of outputs to get, pass 0 to use the default limit from server (100)
• Date since - The date to filter on, outputs created on or after the provided date and time format will be returned.
• String job_id - The id of a job to filter outputs by, pass null to exclude this filter
• String media_type - The Internet media type to filter on, pass null to exclude this filter

Returns:

Outputs based on filtering parameters provided

updateBatch

public Batch updateBatch(String batchId,
                         String name,
                         List<Property> properties)

Updates an existing batch with the provided name and properties PUT /v1/batches/{batch_id}.

Parameters:

batchId - id for the batch to be updated

name - name of the batch to be updated

properties - properties of the batch to be updated

Returns:

updated Batch

uploadDocument

public Document uploadDocument(File document)

Uploads the document to the service with the given media type POST /v1/documents.

Parameters:

document - the document to be uploaded

Returns:

Document

uploadDocument

public Document uploadDocument(File document,
                               String mediaType)

Uploads the document to the service with the given media type POST /v1/documents.

Parameters:

document - the document to be uploaded

mediaType - the media type

Returns:

Document