Partilhar via

TextAnalysisClient class

Pacote:
@azure/ai-language-text

Um cliente para interagir com os recursos de análise de texto no Serviço de Linguagem Cognitiva do Azure.

O cliente precisa do ponto de extremidade de um recurso de idioma e um método de autenticação, como uma chave de API ou AAD. A chave da API e o ponto de extremidade podem ser encontrados na página de recursos de idioma no portal do Azure. Eles estarão localizados na página Chaves e Ponto Final do recurso, em Gerenciamento de Recursos.

Exemplos de autenticação:

Chave da API

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

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

const client = new TextAnalysisClient(endpoint, credential);

Azure Active Directory

Consulte o pacote @azure/identity para obter mais informações sobre a autenticação com o Azure Ative Directory.

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

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

const client = new TextAnalysisClient(endpoint, credential);

Construtores

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Cria uma instância de TextAnalysisClient com o ponto de extremidade de um recurso Language e um método de autenticação, como uma chave de API ou AAD.

A chave da API e o ponto de extremidade podem ser encontrados na página de recursos de idioma no portal do Azure. Eles estarão localizados na página Chaves e Ponto Final do recurso, em Gerenciamento de Recursos.

Exemplo

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

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

const client = new TextAnalysisClient(endpoint, credential);
TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)

Cria uma instância de TextAnalysisClient com o ponto de extremidade de um recurso Language e um método de autenticação, como uma chave de API ou AAD.

A chave da API e o ponto de extremidade podem ser encontrados na página de recursos de idioma no portal do Azure. Eles estarão localizados na página Chaves e Ponto Final do recurso, em Gerenciamento de Recursos.

Exemplo

Consulte o pacote @azure/identity para obter mais informações sobre a autenticação com o Azure Ative Directory.

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

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

const client = new TextAnalysisClient(endpoint, credential);

Métodos

analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada uma delas, o idioma detetado, bem como uma pontuação que indica a confiança do modelo de que a linguagem inferida está correta. Pontuações próximas a 1 indicam alta certeza no resultado. São suportados 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Deteção de idioma

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;
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obter mais informações sobre deteção de idioma.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada uma delas, o idioma detetado, bem como uma pontuação que indica a confiança do modelo de que a linguagem inferida está correta. Pontuações próximas a 1 indicam alta certeza no resultado. São suportados 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Deteção de idioma

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;
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obter mais informações sobre deteção de idioma.
analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para executar a ação de escolha nas cadeias de caracteres de entrada. Consulte $AnalyzeActionName para obter uma lista de ações suportadas.

O layout de cada item na matriz de resultados depende da ação escolhida. Por exemplo, cada resultado de documento PIIEntityRecognition consiste em entities e redactedText onde o primeiro é uma lista de todas as entidades Pii no texto e o segundo é o texto original depois que todas essas entidades Pii foram editadas a partir dele.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Mineração de opinião

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
        }
      }
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obter mais informações sobre mineração de opinião.

Informações de identificação pessoal

const documents = [<input strings>];
const languageCode = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageCode, {
  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
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obter mais informações sobre informações pessoalmente identificáveis.
analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para executar a ação de escolha nos documentos de entrada. Consulte $AnalyzeActionName para obter uma lista de ações suportadas.

O layout de cada item na matriz de resultados depende da ação escolhida. Por exemplo, cada resultado de documento PIIEntityRecognition consiste em entities e redactedText onde o primeiro é uma lista de todas as entidades Pii no texto e o segundo é o texto original depois que todas essas entidades Pii foram editadas a partir dele.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Mineração de opinião

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
        }
      }
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obter mais informações sobre mineração de opinião.

Informações de identificação pessoal

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
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obter mais informações sobre informações pessoalmente identificáveis.
beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)

Executa uma matriz (lote) de ações nos documentos de entrada. Cada ação tem um campo kind que especifica a natureza da ação. Consulte $AnalyzeBatchActionNames para obter uma lista de ações suportadas. Além kind, as ações também podem ter outros parâmetros, como disableServiceLogs e modelVersion.

A matriz de resultados contém os resultados para as ações de entrada em que cada item também tem um campo kind que especifica o tipo dos resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Extração de frases-chave e reconhecimento de entidades 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;
   }
 }
}
beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)

Executa uma matriz (lote) de ações nos documentos de entrada. Cada ação tem um campo kind que especifica a natureza da ação. Consulte $AnalyzeBatchActionNames para obter uma lista de ações suportadas. Além kind, as ações também podem ter outros parâmetros, como disableServiceLogs e modelVersion.

A matriz de resultados contém os resultados para as ações de entrada em que cada item também tem um campo kind que especifica o tipo dos resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Extração de frases-chave e reconhecimento de entidades 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;
   }
 }
}
restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Detalhes do Construtor

TextAnalysisClient(string, KeyCredential, TextAnalysisClientOptions)

Cria uma instância de TextAnalysisClient com o ponto de extremidade de um recurso Language e um método de autenticação, como uma chave de API ou AAD.

A chave da API e o ponto de extremidade podem ser encontrados na página de recursos de idioma no portal do Azure. Eles estarão localizados na página Chaves e Ponto Final do recurso, em Gerenciamento de Recursos.

Exemplo

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

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)

Parâmetros

endpointUrl

string

A URL para o ponto de extremidade de um recurso do Cognitive Language Service

credential
KeyCredential

Credencial de chave a ser usada para autenticar solicitações para o serviço.

options
TextAnalysisClientOptions

Usado para configurar o cliente TextAnalytics.

TextAnalysisClient(string, TokenCredential, TextAnalysisClientOptions)

Cria uma instância de TextAnalysisClient com o ponto de extremidade de um recurso Language e um método de autenticação, como uma chave de API ou AAD.

A chave da API e o ponto de extremidade podem ser encontrados na página de recursos de idioma no portal do Azure. Eles estarão localizados na página Chaves e Ponto Final do recurso, em Gerenciamento de Recursos.

Exemplo

Consulte o pacote @azure/identity para obter mais informações sobre a autenticação com o Azure Ative Directory.

import { TextAnalysisClient } from "@azure/ai-language-text";
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)

Parâmetros

endpointUrl

string

A URL para o ponto de extremidade de um recurso do Cognitive Language Service

credential
TokenCredential

Credencial de token a ser usada para autenticar solicitações para o serviço.

options
TextAnalysisClientOptions

Usado para configurar o cliente TextAnalytics.

Detalhes do Método

analyze<ActionName>(ActionName, LanguageDetectionInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada uma delas, o idioma detetado, bem como uma pontuação que indica a confiança do modelo de que a linguagem inferida está correta. Pontuações próximas a 1 indicam alta certeza no resultado. São suportados 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Deteção de idioma

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;
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obter mais informações sobre deteção de idioma.

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

Parâmetros

actionName

ActionName

o nome da ação a ser executada nos documentos de entrada, consulte $AnalyzeActionName

documents

LanguageDetectionInput[]

os documentos de entrada a serem analisados

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

parâmetros de ação opcionais e configurações para a operação

Regressos

Promise<AnalyzeResult<ActionName>>

Uma matriz de resultados em que cada elemento contém o idioma principal para o documento de entrada correspondente.

analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada uma delas, o idioma detetado, bem como uma pontuação que indica a confiança do modelo de que a linguagem inferida está correta. Pontuações próximas a 1 indicam alta certeza no resultado. São suportados 120 idiomas.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Deteção de idioma

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;
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/language-detection/overview para obter mais informações sobre deteção de idioma.

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

Parâmetros

actionName

ActionName

o nome da ação a ser executada nos documentos de entrada, consulte $AnalyzeActionName

documents

string[]

os documentos de entrada a serem analisados

countryHint

string

Indica o país de origem de todas as cadeias de caracteres de entrada para ajudar o modelo a prever o idioma em que estão escritas. Se não for especificado, esse valor será definido como a dica de país padrão no TextAnalysisClientOptions. Se definido como uma cadeia de caracteres vazia ou a cadeia de caracteres "nenhuma", o serviço aplicará um modelo em que o país está explicitamente desdefinido. A mesma dica de país é aplicada a todas as cadeias de caracteres na coleção de entrada.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

parâmetros de ação opcionais e configurações para a operação

Regressos

Promise<AnalyzeResult<ActionName>>

Uma matriz de resultados em que cada elemento contém o idioma principal para o documento de entrada correspondente.

analyze<ActionName>(ActionName, string[], string, AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para executar a ação de escolha nas cadeias de caracteres de entrada. Consulte $AnalyzeActionName para obter uma lista de ações suportadas.

O layout de cada item na matriz de resultados depende da ação escolhida. Por exemplo, cada resultado de documento PIIEntityRecognition consiste em entities e redactedText onde o primeiro é uma lista de todas as entidades Pii no texto e o segundo é o texto original depois que todas essas entidades Pii foram editadas a partir dele.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Mineração de opinião

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
        }
      }
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obter mais informações sobre mineração de opinião.

Informações de identificação pessoal

const documents = [<input strings>];
const languageCode = "en";
const categoriesFilter = [KnownPiiCategory.USSocialSecurityNumber];
const domainFilter = KnownPiiDomain.Phi;
const results = await client.analyze("PiiEntityRecognition", documents, languageCode, {
  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
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obter mais informações sobre informações pessoalmente identificáveis.

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

Parâmetros

actionName

ActionName

o nome da ação a ser executada nos documentos de entrada, consulte $AnalyzeActionName

documents

string[]

os documentos de entrada a serem analisados

languageCode

string

O código da linguagem em que todas as cadeias de caracteres de entrada são escritas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalysisClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum". O suporte a idiomas varia de acordo com a ação, por exemplo, mais informações sobre os idiomas suportados para ações de Reconhecimento de Entidade podem ser encontradas em https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Se definido como "auto", o serviço irá inferir automaticamente o idioma a partir do texto de entrada.

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

parâmetros de ação opcionais e configurações para a operação

Regressos

Promise<AnalyzeResult<ActionName>>

uma matriz de resultados correspondente aos documentos de entrada

analyze<ActionName>(ActionName, TextDocumentInput[], AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions)

Executa um modelo preditivo para executar a ação de escolha nos documentos de entrada. Consulte $AnalyzeActionName para obter uma lista de ações suportadas.

O layout de cada item na matriz de resultados depende da ação escolhida. Por exemplo, cada resultado de documento PIIEntityRecognition consiste em entities e redactedText onde o primeiro é uma lista de todas as entidades Pii no texto e o segundo é o texto original depois que todas essas entidades Pii foram editadas a partir dele.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Mineração de opinião

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
        }
      }
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview para obter mais informações sobre mineração de opinião.

Informações de identificação pessoal

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
    }
  }
}

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/personally-identifiable-information/overview para obter mais informações sobre informações pessoalmente identificáveis.

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

Parâmetros

actionName

ActionName

o nome da ação a ser executada nos documentos de entrada, consulte $AnalyzeActionName

documents

TextDocumentInput[]

os documentos de entrada a serem analisados

options

AnalyzeActionParameters<ActionName> & TextAnalysisOperationOptions

parâmetros de ação opcionais e configurações para a operação

Regressos

Promise<AnalyzeResult<ActionName>>

uma matriz de resultados correspondente aos documentos de entrada

beginAnalyzeBatch(AnalyzeBatchAction[], string[], string, BeginAnalyzeBatchOptions)

Executa uma matriz (lote) de ações nos documentos de entrada. Cada ação tem um campo kind que especifica a natureza da ação. Consulte $AnalyzeBatchActionNames para obter uma lista de ações suportadas. Além kind, as ações também podem ter outros parâmetros, como disableServiceLogs e modelVersion.

A matriz de resultados contém os resultados para as ações de entrada em que cada item também tem um campo kind que especifica o tipo dos resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Extração de frases-chave e reconhecimento de entidades 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>

Parâmetros

actions

AnalyzeBatchAction[]

uma matriz de ações que serão executadas nos documentos de entrada

documents

string[]

os documentos de entrada a serem analisados

languageCode

string

O código da linguagem em que todas as cadeias de caracteres de entrada são escritas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalysisClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum". O suporte a idiomas varia de acordo com a ação, por exemplo, mais informações sobre os idiomas suportados para ações de Reconhecimento de Entidade podem ser encontradas em https://docs.microsoft.com//azure/cognitive-services/language-service/named-entity-recognition/language-support. Se definido como "auto", o serviço irá inferir automaticamente o idioma a partir do texto de entrada.

options
BeginAnalyzeBatchOptions

configurações opcionais para a operação

Regressos

Promise<AnalyzeBatchPoller>

uma matriz de resultados correspondente às ações de entrada

beginAnalyzeBatch(AnalyzeBatchAction[], TextDocumentInput[], BeginAnalyzeBatchOptions)

Executa uma matriz (lote) de ações nos documentos de entrada. Cada ação tem um campo kind que especifica a natureza da ação. Consulte $AnalyzeBatchActionNames para obter uma lista de ações suportadas. Além kind, as ações também podem ter outros parâmetros, como disableServiceLogs e modelVersion.

A matriz de resultados contém os resultados para as ações de entrada em que cada item também tem um campo kind que especifica o tipo dos resultados.

Consulte https://docs.microsoft.com//azure/cognitive-services/language-service/concepts/data-limits para limites de dados.

Exemplos

Extração de frases-chave e reconhecimento de entidades 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>

Parâmetros

actions

AnalyzeBatchAction[]

uma matriz de ações que serão executadas nos documentos de entrada

documents

TextDocumentInput[]

os documentos de entrada a serem analisados

options
BeginAnalyzeBatchOptions

configurações opcionais para a operação

Regressos

Promise<AnalyzeBatchPoller>

uma matriz de resultados correspondente às ações de entrada

restoreAnalyzeBatchPoller(string, RestoreAnalyzeBatchPollerOptions)

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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

Parâmetros

serializedState

string

O estado serializado de outro poller. É o resultado de poller.toString()

options
RestoreAnalyzeBatchPollerOptions

configurações opcionais para a operação

Exemplo

client.beginAnalyzeBatch devolve uma promessa que vai resolver a um eleitor. O estado do poller pode ser serializado e usado para criar outro da seguinte maneira:

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

Regressos

Promise<AnalyzeBatchPoller>