Partilhar via


TextAnalyticsClient class

Classe de cliente para interagir com o Azure Text Analytics.

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 é "nós".

defaultLanguage

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

endpointUrl

A URL para o ponto de extremidade do TextAnalytics

Métodos

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo, neutro ou misto contido nas cadeias 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 alvos no texto e avaliações sobre ele por meio de mineração de opinião. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 alvos no texto e avaliações sobre ele por meio de mineração de opinião. Para obter uma lista de idiomas suportados por esta operação,

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

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

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

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

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

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

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

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

Iniciar uma operação de análise de cuidados de saúde para reconhecer entidades relacionadas com cuidados de saúde (medicamentos, condições, sintomas, etc.) e as 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, o idioma detetado, 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. São suportados 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 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.

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 suportados por esta operação,

Ver 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 aprovados. Para obter uma lista de idiomas suportados por esta operação,

Ver 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, local ou organização. Para mais informações sobre as categorias disponíveis,

Ver https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas suportados por esta 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, local ou organização. Para mais informações sobre as categorias disponíveis,

Ver https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas suportados por esta 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 entradas correspondentes em uma base de dados de conhecimento conhecida. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 entradas correspondentes em uma base de dados de conhecimento conhecida. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 contendo informações pessoalmente identificáveis encontradas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como número de segurança social dos EUA, número de carteira de motorista ou número de cartão de crédito. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 contendo informações pessoalmente identificáveis encontradas nos documentos de entrada passados e categorizar essas entidades em tipos como número de segurança social dos EUA, número de carteira de motorista ou número de cartão de crédito. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 do TextAnalytics

credential

TokenCredential | KeyCredential

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

options
TextAnalyticsClientOptions

Usado para configurar o cliente TextAnalytics.

Detalhes de Propriedade

defaultCountryHint

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

defaultCountryHint: string

Valor de Propriedade

string

defaultLanguage

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

defaultLanguage: string

Valor de Propriedade

string

endpointUrl

A URL para o ponto de extremidade do TextAnalytics

endpointUrl: string

Valor de Propriedade

string

Detalhes de Método

analyzeSentiment(string[], string, AnalyzeSentimentOptions)

Executa um modelo preditivo para identificar o sentimento positivo, negativo, neutro ou misto contido nas cadeias 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 alvos no texto e avaliações sobre ele por meio de mineração de opinião. Para obter uma lista de idiomas suportados por esta operação,

Ver 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

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que a lanuage é explicitamente definida como "Nenhum".

options
AnalyzeSentimentOptions

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

Devoluções

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 alvos no texto e avaliações sobre ele por meio de mineração de opinião. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 para analisar.

options
AnalyzeSentimentOptions

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

Devoluções

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

Envie 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[]

Recolha de documentos a analisar

actions
TextAnalyticsActions

TextAnalyticsAções a executar.

language

string

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
BeginAnalyzeActionsOptions

Opções para a operação.

Devoluções

beginAnalyzeActions(TextDocumentInput[], TextAnalyticsActions, BeginAnalyzeActionsOptions)

Envie 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[]

Recolha de documentos a analisar

actions
TextAnalyticsActions

TextAnalyticsAções a executar.

options
BeginAnalyzeActionsOptions

Opções para a operação.

Devoluções

beginAnalyzeHealthcareEntities(string[], string, BeginAnalyzeHealthcareEntitiesOptions)

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

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

Parâmetros

documents

string[]

Recolha de documentos a analisar.

language

string

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
BeginAnalyzeHealthcareEntitiesOptions

Opções para a operação.

Devoluções

beginAnalyzeHealthcareEntities(TextDocumentInput[], BeginAnalyzeHealthcareEntitiesOptions)

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

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

Parâmetros

documents

TextDocumentInput[]

Recolha de documentos a analisar.

options
BeginAnalyzeHealthcareEntitiesOptions

Opções para a operação.

Devoluçõ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, o idioma detetado, 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. São suportados 120 idiomas.

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

Parâmetros

documents

DetectLanguageInput[]

Uma coleção de documentos de entrada para analisar.

options
DetectLanguageOptions

Parâmetros opcionais para a operação.

Devoluções

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

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

Parâmetros

documents

string[]

Uma coleção de cadeias de caracteres de entrada para analisar.

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 no TextAnalyticsClientOptions. 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
DetectLanguageOptions

Parâmetros opcionais para a operação.

Devoluções

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 suportados por esta operação,

Ver 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

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
ExtractKeyPhrasesOptions

Opções para a operação.

Devoluções

extractKeyPhrases(TextDocumentInput[], ExtractKeyPhrasesOptions)

Executa um modelo para identificar uma coleção de frases significativas encontradas nos documentos de entrada aprovados. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 para analisar.

options
ExtractKeyPhrasesOptions

Opções para a operação.

Devoluções

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, local ou organização. Para mais informações sobre as categorias disponíveis,

Ver https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas suportados por esta 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

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
RecognizeCategorizedEntitiesOptions

Parâmetros opcionais para a operação.

Devoluções

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, local ou organização. Para mais informações sobre as categorias disponíveis,

Ver https://docs.microsoft.com/azure/cognitive-services/Text-Analytics/named-entity-types. Para obter uma lista de idiomas suportados por esta 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 para analisar.

options
RecognizeCategorizedEntitiesOptions

Parâmetros opcionais para a operação.

Devoluções

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 entradas correspondentes em uma base de dados de conhecimento conhecida. Para obter uma lista de idiomas suportados por esta operação,

Ver 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

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
RecognizeLinkedEntitiesOptions

Opções para a operação.

Devoluções

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 entradas correspondentes em uma base de dados de conhecimento conhecida. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 para analisar.

options
RecognizeLinkedEntitiesOptions

Opções para a operação.

Devoluções

recognizePiiEntities(string[], string, RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades contendo informações pessoalmente identificáveis encontradas nas cadeias de caracteres de entrada passadas e categorizar essas entidades em tipos como número de segurança social dos EUA, número de carteira de motorista ou número de cartão de crédito. Para obter uma lista de idiomas suportados por esta operação,

Ver 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

A 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 TextAnalyticsClientOptions. Se definido como uma cadeia de caracteres vazia, o serviço aplicará um modelo em que o idioma é explicitamente definido como "Nenhum".

options
RecognizePiiEntitiesOptions

Opções para a operação.

Devoluções

recognizePiiEntities(TextDocumentInput[], RecognizePiiEntitiesOptions)

Executa um modelo preditivo para identificar uma coleção de entidades contendo informações pessoalmente identificáveis encontradas nos documentos de entrada passados e categorizar essas entidades em tipos como número de segurança social dos EUA, número de carteira de motorista ou número de cartão de crédito. Para obter uma lista de idiomas suportados por esta operação,

Ver 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 para analisar.

options
RecognizePiiEntitiesOptions

Parâmetros opcionais para a operação.

Devoluções