使用语言资源的终结点和身份验证方法（例如 API 密钥或 AAD）创建 TextAnalysisClient 的实例。

可以在 Azure 门户的语言资源页中找到 API 密钥和终结点。 它们位于资源管理的“密钥和终结点”页中。

例

import { TextAnalysisClient, AzureKeyCredential } from "@azure/ai-text-analytics";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new TextAnalysisClient(endpoint, credential);

new TextAnalysisClient(endpointUrl: string, credential: KeyCredential, options?: TextAnalysisClientOptions)

参数

使用语言资源的终结点和身份验证方法（例如 API 密钥或 AAD）创建 TextAnalysisClient 的实例。

可以在 Azure 门户的语言资源页中找到 API 密钥和终结点。 它们位于资源管理的“密钥和终结点”页中。

例

有关使用 Azure Active Directory 进行身份验证的详细信息，请参阅 @azure/identity 包。

import { TextAnalysisClient } from "@azure/ai-text-analytics";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new TextAnalysisClient(endpoint, credential);

new TextAnalysisClient(endpointUrl: string, credential: TokenCredential, options?: TextAnalysisClientOptions)

参数

运行预测模型来确定传入输入字符串写入的语言，并为每个字符串返回检测到的语言，以及指示模型对推断语言正确的信心的分数。 分数接近 1 表示结果中的高确定性。 支持 120 种语言。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

语言检测

const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);

for (let i = 0; i < results.length; i++) {
  const result = results[i];
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
  }
}

有关语言检测的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview。

function analyze<ActionName>(actionName: ActionName, documents: LanguageDetectionInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

参数

返回

结果数组，其中每个元素都包含相应输入文档的主要语言。

运行预测模型来确定传入输入字符串写入的语言，并为每个字符串返回检测到的语言，以及指示模型对推断语言正确的信心的分数。 分数接近 1 表示结果中的高确定性。 支持 120 种语言。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

语言检测

const documents = [<input strings>];
const countryHint = "us";
const results = await client.analyze("LanguageDetection", documents, countryHint);

for (const result of results) {
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { name, confidenceScore, iso6391Name } = result.primaryLanguage;
  }
}

有关语言检测的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview。

function analyze<ActionName>(actionName: ActionName, documents: string[], countryHint?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

参数

返回

结果数组，其中每个元素都包含相应输入文档的主要语言。

运行预测模型以对输入字符串执行所选操作。 有关受支持的作列表，请参阅 $AnalyzeActionName。

结果数组中每个项的布局取决于所选的操作。 例如，每个 PIIEntityRecognition 文档结果都由 entities 和 redactedText 组成，其中前者是文本中所有 Pii 实体的列表，后者是经过所有此类 Pii 实体修订后的原始文本。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

意见挖掘

const documents = ["The food and service aren't the best"];
const results = await client.analyze("SentimentAnalysis", documents, {
  includeOpinionMining: true,
});

for (const result of results) {
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { sentiment, confidenceScores, sentences } = result;
    for (const { sentiment, confidenceScores, opinions } of sentences) {
      for (const { target, assessments } of opinions) {
        const { text, sentiment, confidenceScores } = target;
        for (const { text, sentiment } of assessments) {
          // Do something
        }
      }
    }
  }
}

有关意见挖掘的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview。

个人身份信息

const documents = [<input strings>];
const languageHint = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageHint, {
  domainFilter, categoriesFilter
});

for (const result of results) {
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { entities, redactedText } = result;
    for (const { text, category, confidenceScore, length, offset } of entities) {
      // Do something
    }
  }
}

有关个人身份信息的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview。

function analyze<ActionName>(actionName: ActionName, documents: string[], languageCode?: string, options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

参数

返回

对应于输入文档的结果数组

运行预测模型以对输入文档执行所选操作。 有关受支持的作列表，请参阅 $AnalyzeActionName。

结果数组中每个项的布局取决于所选的操作。 例如，每个 PIIEntityRecognition 文档结果都由 entities 和 redactedText 组成，其中前者是文本中所有 Pii 实体的列表，后者是经过所有此类 Pii 实体修订后的原始文本。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

意见挖掘

const documents = [{
 id: "1",
 text: "The food and service aren't the best",
 language: "en"
}];
const results = await client.analyze("SentimentAnalysis", documents, {
  includeOpinionMining: true,
});

for (const result of results) {
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { sentiment, confidenceScores, sentences } = result;
    for (const { sentiment, confidenceScores, opinions } of sentences) {
      for (const { target, assessments } of opinions) {
        const { text, sentiment, confidenceScores } = target;
        for (const { text, sentiment } of assessments) {
          // Do something
        }
      }
    }
  }
}

有关意见挖掘的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview。

个人身份信息

const documents = [<input documents>];
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, {
  domainFilter, categoriesFilter
});

for (const result of results) {
  if (result.error) {
    // a document has an error instead of results
  } else {
    const { entities, redactedText } = result;
    for (const { text, category, confidenceScore, length, offset } of entities) {
      // Do something
    }
  }
}

有关个人身份信息的详细信息，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview。

function analyze<ActionName>(actionName: ActionName, documents: TextDocumentInput[], options?: AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions): Promise<AnalyzeResult<ActionName>>

参数

返回

对应于输入文档的结果数组

对输入文档执行数组（批处理）操作。 每个作都有一个 kind 字段，该字段指定作的性质。 有关支持的作列表，请参阅 $AnalyzeBatchActionNames。 除了 kind，作还可以具有其他参数，例如 disableServiceLogs 和 modelVersion。

结果数组包含这些输入作的结果，其中每个项还具有指定结果类型的 kind 字段。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

关键短语提取和 Pii 实体识别

const poller = await client.beginAnalyzeBatch(
 [{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
 documents
);
const actionResults = await poller.pollUntilDone();

for await (const actionResult of actionResults) {
 if (actionResult.error) {
   throw new Error(`Unexpected error`);
 }
 switch (actionResult.kind) {
   case "KeyPhraseExtraction": {
     for (const doc of actionResult.results) {
       // do something
     }
     break;
   }
   case "PiiEntityRecognition": {
     for (const doc of actionResult.results) {
       // do something
     }
     break;
   }
 }
}

function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: string[], languageCode?: string, options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>

参数

返回

对应于输入操作的结果数组

对输入文档执行数组（批处理）操作。 每个作都有一个 kind 字段，该字段指定作的性质。 有关支持的作列表，请参阅 $AnalyzeBatchActionNames。 除了 kind，作还可以具有其他参数，例如 disableServiceLogs 和 modelVersion。

结果数组包含这些输入作的结果，其中每个项还具有指定结果类型的 kind 字段。

有关数据限制，请参阅 https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits。

例子

密钥短语提取和 Pii 实体识别

const poller = await client.beginAnalyzeBatch(
 [{ kind: "KeyPhraseExtraction" }, { kind: "PiiEntityRecognition" }],
 documents
);
const actionResults = await poller.pollUntilDone();

for await (const actionResult of actionResults) {
 if (actionResult.error) {
   throw new Error(`Unexpected error`);
 }
 switch (actionResult.kind) {
   case "KeyPhraseExtraction": {
     for (const doc of actionResult.results) {
       // do something
     }
     break;
   }
   case "PiiEntityRecognition": {
     for (const doc of actionResult.results) {
       // do something
     }
     break;
   }
 }
}

function beginAnalyzeBatch(actions: AnalyzeBatchAction[], documents: TextDocumentInput[], options?: BeginAnalyzeBatchOptions): Promise<AnalyzeBatchPoller>

参数

返回

对应于输入操作的结果数组

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

function restoreAnalyzeBatchPoller(serializedState: string, options?: RestoreAnalyzeBatchPollerOptions): Promise<AnalyzeBatchPoller>

参数

const serializedState = poller.toString();
const rehydratedPoller = await client.createAnalyzeBatchPoller(serializedState);
const actionResults = await rehydratedPoller.pollUntilDone();

返回