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 String	VERSION_DATE_2015_12_01 The Constant VERSION_DATE_2015_12_01.

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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
DocumentConversion(String versionDate) Instantiates a new document conversion.
DocumentConversion(String versionDate, String username, String password) Instantiates a new document conversion by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<Answers>	convertDocumentToAnswer(File document) Converts a document to Answer Units.
ServiceCall<Answers>	convertDocumentToAnswer(File document, String mediaType) Converts a document to Answer Units.
ServiceCall<Answers>	convertDocumentToAnswer(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to Answer Units using a custom configuration.
ServiceCall<String>	convertDocumentToHTML(File document) Converts a document to HTML.
ServiceCall<String>	convertDocumentToHTML(File document, String mediaType) Converts a document to HTML.
ServiceCall<String>	convertDocumentToHTML(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to HTML using a custom configuration.
ServiceCall<String>	convertDocumentToText(File document) Converts a document to Text.
ServiceCall<String>	convertDocumentToText(File document, String mediaType) Converts a document to Text.
ServiceCall<String>	convertDocumentToText(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to Text using a custom configuration.
ServiceCall<String>	indexDocument(IndexDocumentOptions indexDocumentOptions) Converts and indexes the document and metadata provided.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_DATE_2015_12_01

public static final String VERSION_DATE_2015_12_01

The Constant VERSION_DATE_2015_12_01.

See Also:

Constant Field Values

Constructor Detail

DocumentConversion

public DocumentConversion(String versionDate)

Instantiates a new document conversion.

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.

DocumentConversion

public DocumentConversion(String versionDate,
                          String username,
                          String password)

Instantiates a new document conversion by username and password.

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.

username - the username

password - the password

Method Detail

convertDocumentToAnswer

public ServiceCall<Answers> convertDocumentToAnswer(File document)

Converts a document to Answer Units.
Use convertDocumentToAnswer(File, String) if you want to specify the media type

Parameters:

document - the document

Returns:

Converted document as Answers

convertDocumentToAnswer

public ServiceCall<Answers> convertDocumentToAnswer(File document,
                                                    String mediaType)

Converts a document to Answer Units.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided

Returns:

Converted document as Answers

See Also:

HttpMediaType for available media types

convertDocumentToAnswer

public ServiceCall<Answers> convertDocumentToAnswer(File document,
                                                    String mediaType,
                                                    com.google.gson.JsonObject customConfig)

Converts a document to Answer Units using a custom configuration.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided.

customConfig - the configuration parameters to customize the conversion

Returns:

converted document as String

convertDocumentToHTML

public ServiceCall<String> convertDocumentToHTML(File document)

Converts a document to HTML.
Use convertDocumentToHTML(File, String) if you want to specify the media type.

Parameters:

document - the document

Returns:

Converted document as String

convertDocumentToHTML

public ServiceCall<String> convertDocumentToHTML(File document,
                                                 String mediaType)

Converts a document to HTML.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided.

Returns:

Converted document as String

See Also:

for available media types

convertDocumentToHTML

public ServiceCall<String> convertDocumentToHTML(File document,
                                                 String mediaType,
                                                 com.google.gson.JsonObject customConfig)

Converts a document to HTML using a custom configuration.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided.

customConfig - the configuration parameters to customize the conversion

Returns:

converted document as String

convertDocumentToText

public ServiceCall<String> convertDocumentToText(File document)

Converts a document to Text.
Use convertDocumentToText(File, String) if you want to specify the media type.

Parameters:

document - the document

Returns:

Converted document as String

convertDocumentToText

public ServiceCall<String> convertDocumentToText(File document,
                                                 String mediaType)

Converts a document to Text.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided.

Returns:

Converted document as String

See Also:

for available media types

convertDocumentToText

public ServiceCall<String> convertDocumentToText(File document,
                                                 String mediaType,
                                                 com.google.gson.JsonObject customConfig)

Converts a document to Text using a custom configuration.

Parameters:

document - the document

mediaType - the document media type. It will use the file extension if not provided.

customConfig - the configuration parameters to customize the conversion

Returns:

converted document as String

indexDocument

public ServiceCall<String> indexDocument(IndexDocumentOptions indexDocumentOptions)

Converts and indexes the document and metadata provided.

Parameters:

indexDocumentOptions - Specifies the options for indexing the document

Returns:

index document response as String