EduceFromText
Returns matches from text that you submit in the Text
HTTP parameter.
Example
http://localhost:13000/?action=EduceFromText&Text=Simon was getting ready to leave.
This action might result in output similar to the following XML:
<autnresponse> <action>EDUCEFROMTEXT</action> <response>SUCCESS</response> <responsedata> <autn:hit> <entity_name>contact/people</entity_name> <offset>0</offset> <offset_length>0</offset_length> <score>1.00000</score> <normalized_text_size>5</normalized_text_size> <normalized_text_length>5</normalized_text_length> <original_text_size>5</original_text_size> <original_text_length>5</original_text_length> <original_text>Simon</original_text> <normalized_text>Simon</normalized_text> </autn:hit> <autn:numhits>1</autn:numhits> </responsedata> </autnresponse>
Required Parameters
Parameter | Description |
---|---|
Text | The input text to process. |
Optional Parameters
Parameter | Description |
---|---|
AllowMultipleResults | Whether to return multiple results for a single match. |
AllowOverlaps | Whether to return more than one entity from any one section of text. |
CaseNormalization | The case conversion to use for all incoming text. |
CJKNormalization | How to normalize Chinese, Japanese, and Korean data before extraction. |
EnableComponents | Whether to return all the components of the entity as well as the entity itself. |
EnableUniqueMatches | Whether to return only unique matches in each document. |
Entities | The entities to use for the extraction. |
Grammars | The grammar files to use for the extraction. |
Locale | Enables tokenization of Chinese, Japanese, Korean, and Thai languages. |
MatchCase | Whether to ignore case when matching characters. |
MatchTimeout | The maximum amount of time (in seconds) to spend searching for matches (to all chosen entities) at a specific offset. |
MatchWholeWord | Whether to take account of word boundaries when matching. |
MaxEntityLength | The maximum number of characters in a returned entry. |
MinScore | Matches only items with scores equal to or exceeding the threshold. |
NonGreedyMatch | Whether to return the shortest match. |
RedactionOutputString | A string that replaces redacted information in the output text. |
RedactionReplacementCharacter | A single character that replaces each character in redacted text. |
RedactionType | Whether to replace a match with the normalized form of the text rather than a censored string or replacement character. |
RequestTimeout | The maximum amount of time (in seconds) to spend processing the request. |
TangibleCharacters | A list of punctuation characters to treat as part of the word. |
TokenWithPunctuation | Whether to treat all punctuation characters as part of a word token, rather than treating them as word boundaries |