你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

TextAnalyticsClient 类

  • 参考

文本分析 API 是一套使用一流的 Microsoft 机器学习算法构建的文本分析 Web 服务。 API 可用于分析非结构化文本，以便执行情绪分析、关键短语提取和语言检测等任务。 使用此 API 不需要训练数据;只需带上文本数据即可。 此 API 使用高级自然语言处理技术提供最佳的类预测。 可在 https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview

继承
SDKClient
TextAnalyticsClient

构造函数

TextAnalyticsClient(endpoint, credentials)

参数

endpoint
str
必需

支持的认知服务终结点 (协议和主机名，例如： https://westus.api.cognitive.microsoft.com) 。

credentials
None
必需

唯一标识客户端订阅的订阅凭据。

变量

config
TextAnalyticsClientConfiguration

客户端的配置。

方法

close

如果keep_alive为 True，请关闭客户端。
detect_language

该 API 返回检测到的语言以及介于 0 与 1 之间的数字评分。

接近 1 的分数表示 100% 确定所识别的语言是真实的。 共支持 120 种语言。
entities

API 返回给定文档中已识别的实体的列表。

若要获取有关每个已识别实体的详细信息，建议通过查询已识别的实体名称来使用必应实体搜索 API。 有关已启用语言的列表，请参阅文本分析 API 中支持的语言。
key_phrases

API 返回表示输入文本中的关键话题的字符串列表。

有关关键短语提取支持的语言的详细信息，请参阅文本分析文档。
sentiment

该 API 返回介于 0 与 1 之间的数字评分。

接近 1 的分数表示积极情绪，而接近 0 的分数表示消极情绪。 评分 0.5 表示缺少情绪（例如 factoid 语句）。 有关情绪分析支持的语言的详细信息，请参阅文本分析文档。

close

如果keep_alive为 True，请关闭客户端。

close() -> None

detect_language

该 API 返回检测到的语言以及介于 0 与 1 之间的数字评分。

接近 1 的分数表示 100% 确定所识别的语言是真实的。 共支持 120 种语言。

detect_language(show_stats=None, documents=None, custom_headers=None, raw=False, **operation_config)

参数

show_stats
bool
默认值: None

(可选) 如果设置为 true，则响应将包含输入和文档级别的统计信息。

documents
list[LanguageInput]
默认值: None
custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代。

返回

LanguageBatchResult 或 ClientRawResponse（如果 raw=true）

返回类型

LanguageBatchResult,
ClientRawResponse

例外

ErrorResponseException

entities

API 返回给定文档中已识别的实体的列表。

若要获取有关每个已识别实体的详细信息，建议通过查询已识别的实体名称来使用必应实体搜索 API。 有关已启用语言的列表，请参阅文本分析 API 中支持的语言。

entities(show_stats=None, documents=None, custom_headers=None, raw=False, **operation_config)

参数

show_stats
bool
默认值: None

(可选) 如果设置为 true，则响应将包含输入和文档级别的统计信息。

documents
list[MultiLanguageInput]
默认值: None
custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代。

返回

EntitiesBatchResult 或 ClientRawResponse（如果 raw=true）

返回类型

EntitiesBatchResult,
ClientRawResponse

例外

ErrorResponseException

key_phrases

API 返回表示输入文本中的关键话题的字符串列表。

有关关键短语提取支持的语言的详细信息，请参阅文本分析文档。

key_phrases(show_stats=None, documents=None, custom_headers=None, raw=False, **operation_config)

参数

show_stats
bool
默认值: None

(可选) 如果设置为 true，则响应将包含输入和文档级别的统计信息。

documents
list[MultiLanguageInput]
默认值: None
custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代。

返回

KeyPhraseBatchResult 或 ClientRawResponse（如果 raw=true）

返回类型

KeyPhraseBatchResult,
ClientRawResponse

例外

ErrorResponseException

sentiment

该 API 返回介于 0 与 1 之间的数字评分。

接近 1 的分数表示积极情绪，而接近 0 的分数表示消极情绪。 评分 0.5 表示缺少情绪（例如 factoid 语句）。 有关情绪分析支持的语言的详细信息，请参阅文本分析文档。

sentiment(show_stats=None, documents=None, custom_headers=None, raw=False, **operation_config)

参数

show_stats
bool
默认值: None

(可选) 如果设置为 true，则响应将包含输入和文档级别的统计信息。

documents
list[MultiLanguageInput]
默认值: None
custom_headers
dict
默认值: None

将添加到请求的标头

raw
bool
默认值: False

返回直接响应以及反序列化的响应

operation_config
必需

操作配置替代。

返回

object 或 ClientRawResponse（如果 raw=true）

返回类型

object,
ClientRawResponse

例外

HttpOperationError