com.azure.ai.textanalytics.models

Class LinkedEntityMatch

java.lang.Object

com.azure.ai.textanalytics.models.LinkedEntityMatch

public final class LinkedEntityMatch
extends Object

The LinkedEntityMatch model.

Constructor Summary

Constructors

Constructor and Description
LinkedEntityMatch(String text, double confidenceScore) Creates a LinkedEntityMatch model that describes linked entity match.

Method Summary

Modifier and Type	Method and Description
double	getConfidenceScore() Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.
int	getLength() Gets the length of entity text.
int	getOffset() Gets the offset of linked entity match text.
String	getText() Gets the linked entity match text property: linked entity text as appears in the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedEntityMatch

public LinkedEntityMatch(String text,
                         double confidenceScore)

Creates a LinkedEntityMatch model that describes linked entity match.

Parameters:

text - The linked entity match text as appears in the request.

confidenceScore - If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

Method Detail

getText

public String getText()

Gets the linked entity match text property: linked entity text as appears in the request.

Returns:

The text value.

getConfidenceScore

public double getConfidenceScore()

Gets the score property: If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

Returns:

The score value.

getOffset

public int getOffset()

Gets the offset of linked entity match text. The start position for the linked entity match text in a document.

Returns:

The offset of linked entity match text.

getLength

public int getLength()

Gets the length of entity text.

Returns:

The length of entity text.