Compartilhar via


TextAnalyticsClient class

Classe de cliente para interagir com o Azure Análise de Texto.

Construtores

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Cria uma instância de TextAnalyticsClient.

Exemplo de uso:

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

const client = new TextAnalyticsClient(
   "<service endpoint>",
   new AzureKeyCredential("<api key>")
);

Propriedades

defaultCountryHint

A dica de país padrão a ser usada. O padrão é "us".

defaultLanguage

O idioma padrão a ser usado. O padrão é "en".

endpointUrl

A URL para o ponto de extremidade textAnalytics

Métodos

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo, neutro ou misto contido nas cadeias de caracteres de entrada, bem como pontuações que indicam a confiança do modelo em cada um dos sentimentos previstos. Opcionalmente, ele também pode identificar destinos no texto e avaliações sobre ele por meio da mineração de opiniões. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo ou neutro ou misto contido nos documentos de entrada, bem como pontuações que indicam a confiança do modelo em cada um dos sentimentos previstos. Opcionalmente, ele também pode identificar destinos no texto e avaliações sobre ele por meio da mineração de opiniões. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)

Enviar uma coleção de documentos de texto para análise. Especifique uma ou mais ações exclusivas a serem executadas.

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Enviar uma coleção de documentos de texto para análise. Especifique uma ou mais ações exclusivas a serem executadas.

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

Inicie uma operação de análise de saúde para reconhecer entidades relacionadas à saúde (medicamentos, condições, sintomas etc.) e suas relações.

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Inicie uma operação de análise de saúde para reconhecer entidades relacionadas à saúde (medicamentos, condições, sintomas etc.) e suas relações.

detectLanguage(DetectLanguageInput[], DetectLanguageOptions)

Executa um modelo preditivo para determinar o idioma em que o documento de entrada passado está escrito e retorna, para cada um deles, o idioma detectado, bem como uma pontuação que indica a confiança do modelo de que o idioma inferido está correto. Pontuações próximas a 1 indicam alta certeza no resultado. Há suporte para 120 idiomas.

detectLanguage(string[], string, DetectLanguageOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada um deles, o idioma detectado, bem como uma pontuação que indica a confiança do modelo de que o idioma inferido está correto. Pontuações próximas a 1 indicam alta certeza no resultado. Há suporte para 120 idiomas.

extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)

Executa um modelo para identificar uma coleção de frases significativas encontradas nas cadeias de caracteres de entrada passadas. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Executa um modelo para identificar uma coleção de frases significativas encontradas nos documentos de entrada passados. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades nomeadas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como pessoa, localização ou organização. Para obter mais informações sobre categorias disponíveis,

Consulte https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas compatíveis com essa operação, consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades nomeadas nos documentos de entrada passados e categorizar essas entidades em tipos como pessoa, localização ou organização. Para obter mais informações sobre categorias disponíveis,

Consulte https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas compatíveis com essa operação, consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades encontradas nas cadeias de caracteres de entrada passadas e incluir informações vinculando as entidades às suas entradas correspondentes em um base de dados de conhecimento conhecido. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades encontradas nos documentos de entrada passados e incluir informações vinculando as entidades às suas entradas correspondentes em um base de dados de conhecimento conhecido. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades que contêm informações de identificação pessoal encontradas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como número do seguro social dos EUA, número da carteira de motorista ou número do cartão de crédito. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades que contêm informações de identificação pessoal encontradas nos documentos de entrada passados e categorizar essas entidades em tipos como número do seguro social dos EUA, número da carteira de motorista ou número do cartão de crédito. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

Detalhes do construtor

TextAnalyticsClient(string, TokenCredential | KeyCredential, TextAnalyticsClientOptions)

Cria uma instância de TextAnalyticsClient.

Exemplo de uso:

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)

Parâmetros

endpointUrl

string

A URL para o ponto de extremidade textAnalytics

credential

TokenCredential | KeyCredential

Usado para autenticar solicitações para o serviço.

options
TextAnalyticsClientOptions

Usado para configurar o cliente TextAnalytics.

Detalhes da propriedade

defaultCountryHint

A dica de país padrão a ser usada. O padrão é "us".

defaultCountryHint: string

Valor da propriedade

string

defaultLanguage

O idioma padrão a ser usado. O padrão é "en".

defaultLanguage: string

Valor da propriedade

string

endpointUrl

A URL para o ponto de extremidade textAnalytics

endpointUrl: string

Valor da propriedade

string

Detalhes do método

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo, neutro ou misto contido nas cadeias de caracteres de entrada, bem como pontuações que indicam a confiança do modelo em cada um dos sentimentos previstos. Opcionalmente, ele também pode identificar destinos no texto e avaliações sobre ele por meio da mineração de opiniões. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function analyzeSentiment(documents: string[], language?: string, options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>

Parâmetros

documents

string[]

As cadeias de caracteres de entrada a serem analisadas.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o lanuage é definido explicitamente como "Nenhum".

options
AnalyzeSentimentOptions

Parâmetros opcionais que incluem a habilitação da mineração de opiniões.

Retornos

analyzeSentiment(TextDocumentInput[], AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo ou neutro ou misto contido nos documentos de entrada, bem como pontuações que indicam a confiança do modelo em cada um dos sentimentos previstos. Opcionalmente, ele também pode identificar destinos no texto e avaliações sobre ele por meio da mineração de opiniões. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function analyzeSentiment(documents: TextDocumentInput[], options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>

Parâmetros

documents

TextDocumentInput[]

Os documentos de entrada a serem analisados.

options
AnalyzeSentimentOptions

Parâmetros opcionais que incluem a habilitação da mineração de opiniões.

Retornos

beginAnalyzeActions(string[], TextAnalyticsActions, string, BeginAnalyzeActionsOptions)

Enviar uma coleção de documentos de texto para análise. Especifique uma ou mais ações exclusivas a serem executadas.

function beginAnalyzeActions(documents: string[], actions: TextAnalyticsActions, language?: string, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>

Parâmetros

documents

string[]

Coleção de documentos a serem analisados

actions
TextAnalyticsActions

TextAnalyticsActions a ser executado.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
BeginAnalyzeActionsOptions

Opções para a operação.

Retornos

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Enviar uma coleção de documentos de texto para análise. Especifique uma ou mais ações exclusivas a serem executadas.

function beginAnalyzeActions(documents: TextDocumentInput[], actions: TextAnalyticsActions, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>

Parâmetros

documents

TextDocumentInput[]

Coleção de documentos a serem analisados

actions
TextAnalyticsActions

TextAnalyticsActions a ser executado.

options
BeginAnalyzeActionsOptions

Opções para a operação.

Retornos

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

Inicie uma operação de análise de saúde para reconhecer entidades relacionadas à saúde (medicamentos, condições, sintomas etc.) e suas relações.

function beginAnalyzeHealthcareEntities(documents: string[], language?: string, options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>

Parâmetros

documents

string[]

Coleção de documentos a serem analisados.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
BeginAnalyzeHealthcareEntitiesOptions

Opções para a operação.

Retornos

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Inicie uma operação de análise de saúde para reconhecer entidades relacionadas à saúde (medicamentos, condições, sintomas etc.) e suas relações.

function beginAnalyzeHealthcareEntities(documents: TextDocumentInput[], options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>

Parâmetros

documents

TextDocumentInput[]

Coleção de documentos a serem analisados.

options
BeginAnalyzeHealthcareEntitiesOptions

Opções para a operação.

Retornos

detectLanguage(DetectLanguageInput[], DetectLanguageOptions)

Executa um modelo preditivo para determinar o idioma em que o documento de entrada passado está escrito e retorna, para cada um deles, o idioma detectado, bem como uma pontuação que indica a confiança do modelo de que o idioma inferido está correto. Pontuações próximas a 1 indicam alta certeza no resultado. Há suporte para 120 idiomas.

function detectLanguage(documents: DetectLanguageInput[], options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>

Parâmetros

documents

DetectLanguageInput[]

Uma coleção de documentos de entrada a serem analisados.

options
DetectLanguageOptions

Parâmetros opcionais para a operação.

Retornos

detectLanguage(string[], string, DetectLanguageOptions)

Executa um modelo preditivo para determinar o idioma em que as cadeias de caracteres de entrada passadas são escritas e retorna, para cada um deles, o idioma detectado, bem como uma pontuação que indica a confiança do modelo de que o idioma inferido está correto. Pontuações próximas a 1 indicam alta certeza no resultado. Há suporte para 120 idiomas.

function detectLanguage(documents: string[], countryHint?: string, options?: DetectLanguageOptions): Promise<DetectLanguageResultArray>

Parâmetros

documents

string[]

Uma coleção de cadeias de caracteres de entrada a serem analisadas.

countryHint

string

Indica o país de origem de todas as cadeias de caracteres de entrada para ajudar o modelo de análise de texto 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 em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia ou a cadeia de caracteres "none", o serviço aplicará um modelo em que o país não está definido explicitamente. A mesma dica de país é aplicada a todas as cadeias de caracteres na coleção de entrada.

options
DetectLanguageOptions

Parâmetros opcionais para a operação.

Retornos

extractKeyPhrases(string[], string, ExtractKeyPhrasesOptions)

Executa um modelo para identificar uma coleção de frases significativas encontradas nas cadeias de caracteres de entrada passadas. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>

Parâmetros

documents

string[]

As cadeias de caracteres de entrada a serem analisadas.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
ExtractKeyPhrasesOptions

Opções para a operação.

Retornos

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Executa um modelo para identificar uma coleção de frases significativas encontradas nos documentos de entrada passados. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function extractKeyPhrases(documents: TextDocumentInput[], options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>

Parâmetros

documents

TextDocumentInput[]

Os documentos de entrada a serem analisados.

options
ExtractKeyPhrasesOptions

Opções para a operação.

Retornos

recognizeEntities(string[], string, RecognizeCategorizedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades nomeadas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como pessoa, localização ou organização. Para obter mais informações sobre categorias disponíveis,

Consulte https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas compatíveis com essa operação, consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>

Parâmetros

documents

string[]

As cadeias de caracteres de entrada a serem analisadas.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
RecognizeCategorizedEntitiesOptions

Parâmetros opcionais para a operação.

Retornos

recognizeEntities(TextDocumentInput[], RecognizeCategorizedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades nomeadas nos documentos de entrada passados e categorizar essas entidades em tipos como pessoa, localização ou organização. Para obter mais informações sobre categorias disponíveis,

Consulte https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas compatíveis com essa operação, consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeEntities(documents: TextDocumentInput[], options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>

Parâmetros

documents

TextDocumentInput[]

Os documentos de entrada a serem analisados.

options
RecognizeCategorizedEntitiesOptions

Parâmetros opcionais para a operação.

Retornos

recognizeLinkedEntities(string[], string, RecognizeLinkedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades encontradas nas cadeias de caracteres de entrada passadas e incluir informações vinculando as entidades às suas entradas correspondentes em um base de dados de conhecimento conhecido. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>

Parâmetros

documents

string[]

As cadeias de caracteres de entrada a serem analisadas.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
RecognizeLinkedEntitiesOptions

Opções para a operação.

Retornos

recognizeLinkedEntities(TextDocumentInput[], RecognizeLinkedEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades encontradas nos documentos de entrada passados e incluir informações vinculando as entidades às suas entradas correspondentes em um base de dados de conhecimento conhecido. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support.

function recognizeLinkedEntities(documents: TextDocumentInput[], options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>

Parâmetros

documents

TextDocumentInput[]

Os documentos de entrada a serem analisados.

options
RecognizeLinkedEntitiesOptions

Opções para a operação.

Retornos

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades que contêm informações de identificação pessoal encontradas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como número do seguro social dos EUA, número da carteira de motorista ou número do cartão de crédito. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

function recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>

Parâmetros

inputs

string[]

As cadeias de caracteres de entrada a serem analisadas.

language

string

O idioma em que todas as cadeias de caracteres de entrada são gravadas. Se não for especificado, esse valor será definido como o idioma padrão em TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma está explicitamente definido como "Nenhum".

options
RecognizePiiEntitiesOptions

Opções para a operação.

Retornos

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades que contêm informações de identificação pessoal encontradas nos documentos de entrada passados e categorizar essas entidades em tipos como número do seguro social dos EUA, número da carteira de motorista ou número do cartão de crédito. Para obter uma lista de idiomas compatíveis com esta operação,

Consulte https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support.

function recognizePiiEntities(inputs: TextDocumentInput[], options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>

Parâmetros

inputs

TextDocumentInput[]

Os documentos de entrada a serem analisados.

options
RecognizePiiEntitiesOptions

Parâmetros opcionais para a operação.

Retornos