Package com.azure.ai.textanalytics.models

Class LinkedEntity

java.lang.Object

com.azure.ai.textanalytics.models.LinkedEntity

public final class LinkedEntity
extends Object

The LinkedEntity model.

Constructor Summary

Constructors

Constructor	Description
LinkedEntity(String name, com.azure.core.util.IterableStream<LinkedEntityMatch> matches, String language, String dataSourceEntityId, String url, String dataSource)	Creates a LinkedEntity model that describes linked entity.

Method Summary

Modifier and Type	Method	Description
String	getBingEntitySearchApiId()	Gets the bingEntitySearchApiId property: Bing Entity Search unique identifier of the recognized entity.
String	getDataSource()	Gets the dataSource property: Data source used to extract entity linking, such as Wiki/Bing etc.
String	getDataSourceEntityId()	Gets the id property: Unique identifier of the recognized entity from the data source.
String	getLanguage()	Gets the language property: Language used in the data source.
com.azure.core.util.IterableStream<LinkedEntityMatch>	getMatches()	Gets the linked entities matched property: List of instances this entity appears in the text.
String	getName()	Gets the name property: Entity Linking formal name.
String	getUrl()	Gets the url property: URL for the entity's page from the data source.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedEntity

public LinkedEntity(String name,
                    com.azure.core.util.IterableStream<LinkedEntityMatch> matches,
                    String language,
                    String dataSourceEntityId,
                    String url,
                    String dataSource)

Creates a LinkedEntity model that describes linked entity.

Parameters:

name - The entity Linking formal name.

matches - A list of instances this entity appears in the text.

language - The language used in the data source.

dataSourceEntityId - Unique identifier of the recognized entity from the data source.

url - URL for the entity's page from the data source.

dataSource - The data source used to extract entity linking, such as Wiki/Bing etc.

Method Detail

getName

public String getName()

Gets the name property: Entity Linking formal name.

Returns:

The name value.

getMatches

public com.azure.core.util.IterableStream<LinkedEntityMatch> getMatches()

Gets the linked entities matched property: List of instances this entity appears in the text.

Returns:

The linked entities matched value.

getLanguage

public String getLanguage()

Gets the language property: Language used in the data source.

Returns:

The language value.

getDataSourceEntityId

public String getDataSourceEntityId()

Gets the id property: Unique identifier of the recognized entity from the data source.

Returns:

The id value.

getUrl

public String getUrl()

Gets the url property: URL for the entity's page from the data source.

Returns:

The URL value.

getDataSource

public String getDataSource()

Gets the dataSource property: Data source used to extract entity linking, such as Wiki/Bing etc.

Returns:

The dataSource value.

getBingEntitySearchApiId

public String getBingEntitySearchApiId()

Gets the bingEntitySearchApiId property: Bing Entity Search unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search SDK to fetch additional relevant information. Only available for API version v3.1 and up.

Returns:

The bingEntitySearchApiId value.