Создает экземпляр TextAnalysisClient с конечной точкой ресурса языка и методом проверки подлинности, например ключом API или AAD.

Ключ API и конечная точка можно найти на странице ресурсов языка на портале Azure. Они будут находиться на странице "Ключи ресурса" и "Конечная точка" в разделе "Управление ресурсами".

Пример

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)

Параметры

Создает экземпляр TextAnalysisClient с конечной точкой ресурса языка и методом проверки подлинности, например ключом API или AAD.

Ключ API и конечная точка можно найти на странице ресурсов языка на портале Azure. Они будут находиться на странице "Ключи ресурса" и "Конечная точка" в разделе "Управление ресурсами".

Пример

Дополнительные сведения о проверке подлинности с помощью 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();

Возвращаемое значение