TextAnalyticsClient class
用于与 Azure 文本分析交互的客户端类。
构造函数
Text |
创建 TextAnalyticsClient 的实例。 示例用法:
|
属性
default |
要使用的默认国家/地区提示。 默认为“us”。 |
default |
要使用的默认语言。 默认值为“en”。 |
endpoint |
TextAnalytics 终结点的 URL |
方法
构造函数详细信息
TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)
创建 TextAnalyticsClient 的实例。
示例用法:
import { TextAnalyticsClient, AzureKeyCredential } from "@azure/ai-text-analytics";
const client = new TextAnalyticsClient(
"<service endpoint>",
new AzureKeyCredential("<api key>")
);
new TextAnalyticsClient(endpointUrl: string, credential: TokenCredential | KeyCredential, options?: TextAnalyticsClientOptions)
参数
- endpointUrl
-
string
TextAnalytics 终结点的 URL
- credential
用于对服务的请求进行身份验证。
- options
- TextAnalyticsClientOptions
用于配置 TextAnalytics 客户端。
属性详细信息
defaultCountryHint
要使用的默认国家/地区提示。 默认为“us”。
defaultCountryHint: string
属性值
string
defaultLanguage
要使用的默认语言。 默认值为“en”。
defaultLanguage: string
属性值
string
endpointUrl
TextAnalytics 终结点的 URL
endpointUrl: string
属性值
string
方法详细信息
analyzeSentiment(string[], string, AnalyzeSentimentOptions)
运行预测模型来识别输入字符串中包含的正、负、中性或混合情绪,以及指示模型对每个预测情绪的信心的分数。 (可选)还可以通过意见挖掘识别文本中的目标和评估。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function analyzeSentiment(documents: string[], language?: string, options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>
参数
- documents
-
string[]
要分析的输入字符串。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中 lanuage 显式设置为“None”。
- options
- AnalyzeSentimentOptions
包括启用意见挖掘的可选参数。
返回
Promise<AnalyzeSentimentResultArray>
analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)
运行预测模型来识别输入文档中包含的正、负或中性或混合情绪,以及指示模型对每个预测情绪的信心的分数。(可选)还可以通过意见挖掘识别文本中的目标和评估。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function analyzeSentiment(documents: TextDocumentInput[], options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>
参数
- documents
要分析的输入文档。
- options
- AnalyzeSentimentOptions
包括启用意见挖掘的可选参数。
返回
Promise<AnalyzeSentimentResultArray>
beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)
提交文本文档集合以供分析。 指定要执行的一个或多个唯一作。
function beginAnalyzeActions(documents: string[], actions: TextAnalyticsActions, language?: string, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>
参数
- documents
-
string[]
要分析的文档集合
- actions
- TextAnalyticsActions
要执行的 TextAnalyticsActions。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
- options
- BeginAnalyzeActionsOptions
作的选项。
返回
Promise<AnalyzeActionsPollerLike>
beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)
提交文本文档集合以供分析。 指定要执行的一个或多个唯一作。
function beginAnalyzeActions(documents: TextDocumentInput[], actions: TextAnalyticsActions, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>
参数
- documents
要分析的文档集合
- actions
- TextAnalyticsActions
要执行的 TextAnalyticsActions。
- options
- BeginAnalyzeActionsOptions
作的选项。
返回
Promise<AnalyzeActionsPollerLike>
beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)
启动医疗保健分析作,识别医疗保健相关实体(药物、条件、症状等)及其关系。
function beginAnalyzeHealthcareEntities(documents: string[], language?: string, options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>
参数
- documents
-
string[]
要分析的文档集合。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
作的选项。
返回
Promise<AnalyzeHealthcareEntitiesPollerLike>
beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)
启动医疗保健分析作,识别医疗保健相关实体(药物、条件、症状等)及其关系。
function beginAnalyzeHealthcareEntities(documents: TextDocumentInput[], options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>
参数
- documents
要分析的文档集合。
作的选项。
返回
Promise<AnalyzeHealthcareEntitiesPollerLike>
detectLanguage(DetectLanguageInput[], DetectLanguageOptions)
运行预测模型来确定传入的输入文档写入的语言,并为每个文档返回检测到的语言,以及指示模型的置信度推断语言正确无误的分数。 分数接近 1 表示结果中的高确定性。 支持 120 种语言。
function detectLanguage(documents: DetectLanguageInput[], options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>
参数
- documents
要分析的输入文档的集合。
- options
- DetectLanguageOptions
作的可选参数。
返回
Promise<DetectLanguageResultArray>
detectLanguage(string[], string, DetectLanguageOptions)
运行预测模型来确定传入输入字符串写入的语言,并为每个字符串返回检测到的语言,以及指示模型对推断语言正确的信心的分数。 分数接近 1 表示结果中的高确定性。 支持 120 种语言。
function detectLanguage(documents: string[], countryHint?: string, options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>
参数
- documents
-
string[]
要分析的输入字符串的集合。
- countryHint
-
string
指示所有输入字符串的起源国家/地区,以帮助文本分析模型预测所写入的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
中的默认国家/地区提示。
如果设置为空字符串或字符串“none”,则服务将应用一个模型,其中国家/地区明确未设置。
相同的国家/地区提示应用于输入集合中的所有字符串。
- options
- DetectLanguageOptions
作的可选参数。
返回
Promise<DetectLanguageResultArray>
extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)
运行模型来标识传入输入字符串中找到的重要短语的集合。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>
参数
- documents
-
string[]
要分析的输入字符串。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
- options
- ExtractKeyPhrasesOptions
作的选项。
返回
Promise<ExtractKeyPhrasesResultArray>
extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)
运行模型来标识传入输入文档中发现的重要短语的集合。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function extractKeyPhrases(documents: TextDocumentInput[], options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>
参数
- documents
要分析的输入文档。
- options
- ExtractKeyPhrasesOptions
作的选项。
返回
Promise<ExtractKeyPhrasesResultArray>
recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)
运行预测模型来标识传入输入字符串中命名实体的集合,并将这些实体分类为人员、位置或组织等类型。 有关可用类别的详细信息,
请参阅 https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types。 有关此作支持的语言列表,请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>
参数
- documents
-
string[]
要分析的输入字符串。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
作的可选参数。
返回
recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)
运行预测模型来标识传入输入文档中命名实体的集合,并将这些实体分类为人员、位置或组织等类型。 有关可用类别的详细信息,
请参阅 https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types。 有关此作支持的语言列表,请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function recognizeEntities(documents: TextDocumentInput[], options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>
参数
- documents
要分析的输入文档。
作的可选参数。
返回
recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)
运行预测模型来标识传入输入字符串中找到的实体集合,并包括将实体链接到已知知识库中的相应条目的信息。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>
参数
- documents
-
string[]
要分析的输入字符串。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
- options
- RecognizeLinkedEntitiesOptions
作的选项。
返回
Promise<RecognizeLinkedEntitiesResultArray>
recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)
运行预测模型来标识传入输入文档中发现的实体集合,并包括将实体链接到已知知识库中的相应条目的信息。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support。
function recognizeLinkedEntities(documents: TextDocumentInput[], options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>
参数
- documents
要分析的输入文档。
- options
- RecognizeLinkedEntitiesOptions
作的选项。
返回
Promise<RecognizeLinkedEntitiesResultArray>
recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)
运行预测模型来标识包含传入输入字符串中找到的个人身份信息的实体集合,并将这些实体分类为美国社会安全号码、驱动程序许可证号或信用卡号等类型。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support。
function recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>
参数
- inputs
-
string[]
要分析的输入字符串。
- language
-
string
写入所有输入字符串的语言。 如果未指定,此值将设置为 TextAnalyticsClientOptions
的默认语言。
如果设置为空字符串,服务将应用一个模型,其中语言显式设置为“None”。
- options
- RecognizePiiEntitiesOptions
作的选项。
返回
Promise<RecognizePiiEntitiesResultArray>
recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)
运行预测模型来标识包含传入输入文档中发现的个人身份信息的实体集合,并将这些实体分类为美国社会安全号码、驾驶执照号或信用卡号等类型。 有关此作支持的语言列表,
请参阅 https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support。
function recognizePiiEntities(inputs: TextDocumentInput[], options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>
参数
- inputs
要分析的输入文档。
- options
- RecognizePiiEntitiesOptions
作的可选参数。
返回
Promise<RecognizePiiEntitiesResultArray>