@azure/ai-text-analytics package

Uma credencial baseada em chave estática que dá suporte à atualização do valor da chave subjacente.

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 linguagem e de um método de autenticação, como uma chave de API ou AAD. A chave de 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 de Extremidade do recurso, em Gerenciamento de Recursos.

Exemplos de autenticação:

Chave de 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);

Active Directory do Azure

Consulte o pacote @azure/identity para obter mais informações sobre como autenticar com o Azure Active Directory.

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

Configuração comum a todas as ações.

Metadados de ação.

Opções comuns a todas as ações em lotes.

Os metadados para operações de execução longa iniciadas por beginAnalyzeBatch.

O estado da operação de análise de início.

Um objeto que contém o sentimento previsto, pontuações de confiança e outras informações sobre uma avaliação de um destino. Por exemplo, na frase "A comida é boa", a avaliação do "alimento" de destino é "boa".

O erro de uma ação analisar em lote.

O estado de uma ação em lote

O estado de uma ação em lote bem-sucedida.

Opções para a operação iniciar a análise de ações.

Um resultado de classificação de uma ação de categoria única de documento de classificação personalizada

Metadados de ação personalizados.

Opções para uma ação de lote de reconhecimento de entidade personalizada.

O resultado da operação de reconhecimento de entidades personalizadas em um único documento, contendo uma coleção das entidades identificadas nesse documento.

Opções para uma ação de lote de classificação de vários rótulos personalizada.

O resultado da operação personalizada de classificação de várias categorias de documento em um documento múltiplo, contendo o resultado da classificação.

Opções para uma ação personalizada de lote de classificação de rótulo único.

O resultado da operação de categoria única do documento de classificação personalizada em um único documento, contendo o resultado da classificação.

Informações sobre o idioma de um documento, conforme identificado pelo serviço de Idioma.

Representa um aviso encontrado durante o processamento de um documento.

Uma palavra ou frase identificada como uma entidade categorizada dentro de uma taxonomia de tipos. O conjunto de categorias reconhecidas pelo serviço de idioma é descrito em https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories .

Um tipo que representa uma referência para a entidade de saúde em um catálogo de entidades específico.

Opções para uma entidade que vincula a ação em lote.

O resultado de uma ação de vinculação de entidade em um único documento, contendo uma coleção de objetos LinkedEntity identificados nesse documento.

Opções para uma ação de lote de reconhecimento de entidade.

O resultado de uma ação de reconhecimento de entidade em um único documento, contendo uma coleção de objetos Entity identificados nesse documento.

Opções para uma ação de lote de resumo extrativo.

Um objeto que descreve metadados sobre a entidade de saúde, como se ela é hipotética ou condicional.

Opções para uma ação de lote de serviços de saúde.

Uma entidade de saúde representada como um nó em um grafo direcionado em que as bordas são um tipo específico de relação entre os nós de origem e de destino.

Uma relação entre duas ou mais entidades de saúde.

Uma entidade de saúde que desempenha um papel específico em uma relação.

Os resultados de uma operação de saúde bem-sucedida para um único documento.

Opções para uma ação do lote de extração de frases-chave.

O resultado de uma ação de extração de frase-chave em um único documento, contendo uma coleção das frases-chave identificadas nesse documento.

Uma entrada para a operação de detecção de idioma. Este objeto especifica uma ID de documento exclusiva, bem como o texto completo de um documento e uma dica que indica o país de origem do documento para auxiliar o modelo de previsão de linguagem na detecção do idioma do documento.

O resultado de uma ação de detecção de idioma em um único documento, contendo uma previsão de qual idioma o documento está escrito.

Uma palavra ou frase identificada como uma entidade conhecida dentro de um banco de dados, incluindo seu nome formal (desambiguado) e um link para as informações da entidade dentro do banco de dados de origem.

Detalhes sobre a subcadeia de caracteres específica em um documento que se refere a uma entidade vinculada identificada pelo modelo de linguagem.

Um objeto de opinião minado representa uma opinião que extraímos de uma frase. Ele consiste em um destino sobre o qual essas avaliações se tratam e as próprias avaliações reais.

Opções para uma ação de lote de reconhecimento de entidade pii.

O resultado de uma ação de reconhecimento de entidade pii em um único documento, contendo a coleção de objetos Entity identificados nesse documento.

Opções para a operação iniciar a análise de ações.

O sentimento previsto para um determinado intervalo de texto. Para obter mais informações sobre o sentimento de texto, consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Opções para uma ação de lote de análise de sentimento.

O resultado de uma ação de análise de sentimento em um único documento, contendo o sentimento previsto para cada frase, bem como para o documento completo.

Representa as pontuações de confiança entre 0 e 1 em todas as classes de sentimento: positiva, neutra, negativa.

O resultado da ação de extração de resumo em um único documento, contendo uma coleção do resumo identificado nesse documento.

Uma frase que faz parte do resumo extraído.

Representa as pontuações de confiança em todas as classes de sentimento: positivas, neutras, negativas.

TargetSentiment contém o sentimento previsto, pontuações de confiança e outras informações sobre um destino de um produto. Um destino de um produto/serviço é um componente-chave desse produto/serviço. Por exemplo, em "A comida no Hotel Foo é boa", "comida" é um alvo de "Hotel Foo".

Opções de configuração para TextAnalysisClient.

Digite descrevendo um erro de API.

Tipo base para resultados de erro de uma ação correspondente a um único documento.

Opções comuns a todas as operações.

Tipo base para resultados de uma ação correspondente a um único documento de entrada.

se includeStatistics=true foi especificado na solicitação, esse campo conterá informações sobre o conteúdo da solicitação.

Um objeto que representa um documento de texto individual a ser analisado pelo serviço De linguagem. O documento contém uma ID de documento exclusiva, o texto completo do documento e o idioma do texto do documento.

se includeStatistics=true foi especificado na solicitação, este campo conterá informações sobre o conteúdo do documento.

Objeto Parameters para uma tarefa de análise de texto usando modelos personalizados.

Configuração comum a todas as ações que usam modelos predefinidos.

Tipo de ações compatíveis com o método analisar.

O tipo de parâmetros para cada ação em $AnalyzeActionNames.

Lote de ações.

Tipo de ações com suporte pelo método de beginAnalyzeBatch do.

Um sondador que pesquisa operações de longa duração iniciadas por beginAnalyzeBatch.

Resultados de um lote de ações.

O tipo de resultados de cada ação em $AnalyzeActionNames.

O resultado de uma ação em lote.

Parâmetros com suporte para uma tarefa entidades personalizadas.

O resultado de uma ação de lote de reconhecimento de entidade personalizada.

Um resultado de erro da operação reconhecer entidades personalizadas em um único documento.

O resultado da operação de reconhecimento personalizado de entidades em um único documento.

Opções para uma ação personalizada de classificação de vários rótulos

O resultado de uma ação personalizada de lote de classificação de vários rótulos.

Um resultado de erro da operação de várias categorias de documento de classificação personalizada em um documento múltiplo.

O resultado da operação de classificação personalizada de várias categorias de documento em um documento múltiplo.

Opções para uma ação personalizada de classificação de rótulo único

O resultado de uma ação de lote de classificação de rótulo único personalizado.

Um resultado de erro da operação de categoria única do documento de classificação personalizada em um único documento.

O resultado da operação de categoria única do documento de classificação personalizada em um único documento.

Define valores para DocumentSentimentLabel.

Define valores para EntityAssociation.

Define valores para EntityCertainty.

Define valores para EntityConditionality.

Opções para uma ação de vinculação de entidade.

O resultado de uma entidade vinculando a ação em lote.

Um resultado de erro de uma ação de vinculação de entidade em um único documento.

O resultado de uma ação de vinculação de entidade em um único documento.

Opções para uma ação de reconhecimento de entidade.

O resultado de uma ação de lote de reconhecimento de entidade.

Um resultado de erro de uma ação de reconhecimento de entidade em um único documento.

O resultado de uma ação de reconhecimento de entidade em um único documento.

Parâmetros com suporte para uma tarefa de Resumo Extrativo.

O resultado de uma ação de lote de resumo extrativo.

Define valores para ExtractiveSummarizationOrderingCriteria.
KnownExtractiveSummarizationOrderingCriteria pode ser usado de forma intercambiável com ExtractiveSummarizationOrderingCriteria, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Deslocamento: indica que os resultados devem ser classificados em ordem de aparência no texto.
Classificação: indica que os resultados devem ser classificados em ordem de importância (ou seja, pontuação de classificação) de acordo com o modelo.

Define valores para FhirVersion.
KnownFhirVersion pode ser usado de forma intercambiável com FhirVersion, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

4.0.1

Parâmetros com suporte para uma tarefa healthcare.

O resultado de uma ação em lotes de serviços de saúde.

Define valores para HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> podem ser usados de forma intercambiável com HealthcareEntityCategory, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

BODY_STRUCTURE

DE GÊNERO
EXAMINATION_NAME
DATE
DIRECTION
DE FREQUÊNCIA
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
time
GENE_OR_PROTEIN
variant
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DE DIAGNÓSTICO
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSAGE
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

O tipo de funções diferentes que uma entidade de saúde pode desempenhar em uma relação.

Um resultado de erro da operação de saúde em um único documento.

O resultado da operação de saúde em um único documento.

Opções para uma ação de reconhecimento de frase-chave.

O resultado de uma ação do lote de extração de frases-chave.

Um resultado de erro de uma ação de extração de frase-chave em um único documento.

O resultado de uma ação de análise de sentimento em um único documento.

Opções para uma ação de detecção de idioma.

Um erro resulta de uma ação de detecção de idioma em um único documento.

O resultado de uma ação de detecção de idioma em um único documento.

Define valores para OperationStatus.

Resultados de páginas da operação de beginAnalyzeBatch do.

Define valores para PiiEntityCategory.
KnownPiiEntityCategory pode ser usado de forma intercambiável com PiiEntityCategory, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

ABARoutingNumber
ARNationalIdentityNumber
AUBankAccountNumber
AUDriversLicenseNumber
AUMedicalAccountNumber
AUPassportNumber
AUTaxFileNumber
AUBusinessNumber
AUCompanyNumber
ATIdentityCard
ATTaxIdentificationNumber
ATValueAddedTaxNumber
AzureDocumentDBAuthKey
AzureIAASDatabaseConnectionAndSQLString
do AzureIoTConnectionString
AzurePublishSettingPassword
AzureRedisCacheString
do AzureSAS
AzureServiceBusString
AzureStorageAccountKey
AzureStorageAccountGeneric
BENationalNumber
BENationalNumberV2
BEValueAddedTaxNumber
BRCPFNumber
BRLegalEntityNumber
BRNationalIDRG
BGUniformCivilNumber
CABankAccountNumber
CADriversLicenseNumber
CAHealthServiceNumber
CAPassportNumber
CAPersonalHealthIdentification
CASocialInsuranceNumber
CLIdentityCardNumber
CNResidentIdentityCardNumber
creditcardnumber
HRIdentityCardNumber
HRNationalIDNumber
HRPersonalIdentificationNumber
HRPersonalIdentificationOIBNumberV2
CYIdentityCard
CYTaxIdentificationNumber
CZPersonalIdentityNumber
CZPersonalIdentityV2
DKPersonalIdentificationNumber
DKPersonalIdentificationV2
DrugEnforcementAgencyNumber
EEPersonalIdentificationCode
EUDebitCardNumber
EUDriversLicenseNumber
EUGPSCoordinates
EUNationalIdentificationNumber
EUPassportNumber
EUSocialSecurityNumber
EUTaxIdentificationNumber
FIEuropeanHealthNumber
FINationalID
FINationalIDV2
FIPassportNumber
FRDriversLicenseNumber
FRHealthInsuranceNumber
FRNationalID
FRPassportNumber
FRSocialSecurityNumber
FRTaxIdentificationNumber
FRValueAddedTaxNumber
de DEDriversLicenseNumber
DEPassportNumber
DEIdentityCardNumber
DETaxIdentificationNumber
DEValueAddedNumber
GRNationalIDCard
GRNationalIDV2
GRTaxIdentificationNumber
HKIdentityCardNumber
HUValueAddedNumber
HUPersonalIdentificationNumber
HUTaxIdentificationNumber
INPermanentAccount
INUniqueIdentificationNumber
IDIdentityCardNumber
InternationalBankingAccountNumber
IEPersonalPublicServiceNumber
IEPersonalPublicServiceNumberV2
ILBankAccountNumber
ILNationalID
ITDriversLicenseNumber
ITFiscalCode
ITValueAddedTaxNumber
JPBankAccountNumber
JPDriversLicenseNumber
JPPassportNumber
JPResidentRegistrationNumber
JPSocialInsuranceNumber
JPMyNumberCorporate
JPMyNumberPersonal
JPResidenceCardNumber
LVPersonalCode
LTPersonalCode
LUNationalIdentificationNumberNatural
LUNationalIdentificationNumberNonNatural
MYIdentityCardNumber
MTIdentityCardNumber
MTTaxIDNumber
NLCitizensServiceNumber
NLCitizensServiceNumberV2
NLTaxIdentificationNumber
NLValueAddedTaxNumber
NZBankAccountNumber
NZDriversLicenseNumber
NZInlandRevenueNumber
NZMinistryOfHealthNumber
NZSocialWelfareNumber
NOIdentityNumber
PHUnifiedMultiPurposeIDNumber
PLIdentityCard
PLNationalID
PLNationalIDV2
PLPassportNumber
PLTaxIdentificationNumber
PLREGONNumber
PTCitizenCardNumber
PTCitizenCardNumberV2
PTTaxIdentificationNumber
ROPersonalNumericalCode
RUPassportNumberDomestic
RUPassportNumberInternational
SANationalID
SGNationalRegistrationIdentityCardNumber
SKPersonalNumber
SITaxIdentificationNumber
SIUniqueMasterCitizenNumber
ZAIdentificationNumber
KRResidentRegistrationNumber
ESDNI
ESSocialSecurityNumber
ESTaxIdentificationNumber
SQLServerConnectionString
SENationalID
SENationalIDV2
SEPassportNumber
SETaxIdentificationNumber
SWIFTCode
CHSocialSecurityNumber
TWNationalID
TWPassportNumber
TWResidentCertificate
THPopulationIdentificationCode
TRNationalIdentificationNumber
UKDriversLicenseNumber
UKElectoralRollNumber
UKNationalHealthNumber
UKNationalInsuranceNumber
UKUniqueTaxpayerNumber
USUKPassportNumber
USBankAccountNumber
USDriversLicenseNumber
USIndividualTaxpayerIdentification
USSocialSecurityNumber
UAPassportNumberDomestic
UAPassportNumberInternational
Organização
email
URL
Age
Número de Telefone
IPAddress
Date
Person
Endereço
Todos
Padrão

Define valores para PiiEntityDomain.
KnownPiiEntityDomain podem ser usados de forma intercambiável com PiiEntityDomain, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

phi: indica que as entidades no domínio informações de integridade pessoal devem ser redigidas.
nenhum: indica que nenhum domínio foi especificado.

Opções para uma ação de reconhecimento de entidade pii.

O resultado de uma ação de lote de reconhecimento de entidade pii.

Um resultado de erro de uma ação de reconhecimento de entidade pii em um único documento.

O resultado de uma ação de reconhecimento de entidade em um único documento.

Define valores para RelationType.
<xref:KnownRelationType> pode ser usado de forma intercambiável com RelationType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de Abreviação
DirectionOfBodyStructure
DirectionOfCondition
directionOfExamination
DirectionOfTreatment
DosageOfMedication
FormOfMedication
FrequencyOfMedication
FrequencyOfTreatment
qualifierOfCondition
RelationOfExamination
RouteOfMedication
TimeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
UnitOfExamination
ValueOfCondition
ValueOfExamination

Define valores para SentenceSentimentLabel.

Opções para uma ação de análise de sentimento.

O resultado de uma ação em lote de análise de sentimento.

Um erro resulta de uma ação de análise de sentimento em um único documento.

O resultado de uma ação de análise de sentimento em um único documento.

Define valores para StringIndexType.
KnownStringIndexType pode ser usado de forma intercambiável com StringIndexType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

TextElements_v8: valores de deslocamento e comprimento retornados corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando o padrão Unicode 8.0.0. Use essa opção se o aplicativo for escrito no .Net Framework ou no .Net Core e você usará StringInfo.
UnicodeCodePoint: os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo, Python.
Utf16CodeUnit: os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo Java, JavaScript.

Um resultado de erro da operação de resumo de extração em um único documento.

O resultado da operação de resumo de extração em um único documento.

Define valores para TokenSentimentLabel.

Define valores para WarningCode.
<xref:KnownWarningCode> pode ser usado de forma intercambiável com WarningCode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

LongWordsInDocument
DocumentTruncated

Valores conhecidos de KnownErrorCode que o serviço aceita.

Valores conhecidos de ExtractiveSummarizationOrderingCriteria que o serviço aceita.

Valores conhecidos do parâmetro <xref:HealthcareAction.fhirVersion>.

Valores conhecidos de KnownInnerErrorCode que o serviço aceita.

Valores conhecidos de PiiEntityCategory que o serviço aceita.

Valores conhecidos de PiiEntityDomain que o serviço aceita.

Valores conhecidos de StringIndexType que o serviço aceita.

Tipo de ações compatíveis com o método analisar.

Tipo de ações com suporte pelo método de beginAnalyzeBatch do.

Um número de possíveis códigos de erro de um TextAnalysisError.