AnalyzeParams | ibm-watson

Parameters for the analyze operation.

Hierarchy

AnalyzeParams

Index

Properties

Optional clean

clean: boolean

Set this to false to disable webpage cleaning. For more information about webpage cleaning, see Analyzing webpages.

Optional fallbackToRaw

fallbackToRaw: boolean

Whether to use raw HTML content if text cleaning fails.

features

features: Features

Specific features to analyze the document for.

Optional headers

headers: OutgoingHttpHeaders

Optional html

html: string

The HTML file to analyze. One of the text, html, or url parameters is required.

Optional language

language: string

ISO 639-1 code that specifies the language of your text. This overrides automatic language detection. Language support differs depending on the features you include in your analysis. For more information, see Language support.

Optional limitTextCharacters

limitTextCharacters: number

Sets the maximum number of characters that are processed by the service.

Optional returnAnalyzedText

returnAnalyzedText: boolean

Whether or not to return the analyzed text.

Optional text

text: string

The plain text to analyze. One of the text, html, or url parameters is required.

Optional url

url: string

The webpage to analyze. One of the text, html, or url parameters is required.

Optional xpath

xpath: string

An XPath query to perform on html or url input. Results of the query will be appended to the cleaned webpage text before it is analyzed. To analyze only the results of the XPath query, set the clean parameter to false.