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

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

VERSION

Constructor Summary

Constructors

Constructor and Description
DocumentConversion() Deprecated. See DocumentConversion(String)
DocumentConversion(String versionDate)

Method Summary

Modifier and Type	Method and Description
Answers	convertDocumentToAnswer(File document) Converts a document to Answer Units.
Answers	convertDocumentToAnswer(File document, String mediaType) Converts a document to Answer Units.
Answers	convertDocumentToAnswer(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to Answer Units using a custom configuration.
String	convertDocumentToHTML(File document) Converts a document to HTML.
String	convertDocumentToHTML(File document, String mediaType) Converts a document to HTML.
String	convertDocumentToHTML(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to HTML using a custom configuration.
String	convertDocumentToText(File document) Converts a document to Text.
String	convertDocumentToText(File document, String mediaType) Converts a document to Text.
String	convertDocumentToText(File document, String mediaType, com.google.gson.JsonObject customConfig) Converts a document to Text using a custom configuration.
com.google.gson.JsonObject	loadCustomConfig(InputStream customConfig) Loads a custom configuration from the input stream specified

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

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, 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

See Also:

Constant Field Values

Constructor Detail

DocumentConversion

@Deprecated
public DocumentConversion()

Deprecated. See DocumentConversion(String)

DocumentConversion

public DocumentConversion(String versionDate)

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.

Method Detail

convertDocumentToAnswer

public 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 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:

for available media types

convertDocumentToAnswer

public 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 - a config used to customize the conversion

Returns:

converted document as String

convertDocumentToHTML

public 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 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 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 - a config used to customize the conversion

Returns:

converted document as String

convertDocumentToText

public 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 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 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 - a config used to customize the conversion

Returns:

converted document as String

loadCustomConfig

public com.google.gson.JsonObject loadCustomConfig(InputStream customConfig)

Loads a custom configuration from the input stream specified

Parameters:

customConfig - input stream for the custom configuration

Returns:

the custom configuration as a JsonObject