@azure/ai-text-analytics package

Uma credencial baseada em chave estática que oferece 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 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-text-analytics";

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-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 da ação.

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

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

O estado do início da operação de sondagem.

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

O erro de uma ação de análise 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 em lote de reconhecimento de entidade personalizada.

O resultado da operação reconhecer 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 multirótulo personalizada.

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

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

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

Informações sobre a língua de um documento, tal como identificada pelo Serviço linguístico.

Representa um aviso encontrado durante o processamento de um documento.

Uma palavra ou frase identificada como uma entidade que é categorizada dentro de uma taxonomia de tipos. O conjunto de categorias reconhecidas pelo serviço linguístico é 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 entidade específico.

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

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

Opções para uma ação em 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 é hipotético ou condicional.

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

Uma entidade de saúde representada como um nó em um gráfico direcionado onde as bordas são um tipo particular 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 numa relação.

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

Opções para uma ação em lote de extração de frase-chave.

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

Uma entrada para a operação de deteção de idioma. Este objeto especifica uma ID de documento exclusiva, bem como o texto completo de um documento e uma dica indicando o país de origem do documento para ajudar o modelo preditivo de idioma a detetar o idioma do documento.

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

Uma palavra ou frase identificada como uma entidade bem 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 substring 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. Consiste tanto num alvo sobre o qual estas avaliações se referem, como nas próprias avaliações.

Opções para uma ação em 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 período de texto. Para obter mais informações sobre o sentimento do texto, consulte https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Opções para uma ação em 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 os escores de confiança entre 0 e 1 em todas as classes de sentimento: positivo, neutro, negativo.

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 os escores de confiança em todas as classes de sentimento: positivo, neutro, negativo.

TargetSentiment contém o sentimento previsto, pontuações de confiança e outras informações sobre um alvo de um produto. Um alvo 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 de base para resultados de erro de uma ação correspondente a um único documento.

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

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

se includeStatistics=true foi especificado na solicitação, este campo conterá informações sobre a carga útil da solicitação.

Um objeto que representa um documento de texto individual a ser analisado pelo serviço de idiomas. O documento contém um ID de documento exclusivo, 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 a carga útil 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 pré-construídos.

Tipo de ações suportadas pelo analisar método.

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

Lote de ações.

Tipo de ações suportadas pelo método beginAnalyzeBatch.

Um poller que sonda 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 suportados para uma tarefa de Entidades Personalizadas.

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

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

O resultado da operação de entidades de reconhecimento personalizado 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 de lote de classificação personalizada de vários rótulos.

Um erro resultante da operação personalizada classificar documento multicategoria em um documento múltiplo.

O resultado da operação personalizada classificar várias categorias de documentos 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 personalizada.

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

O resultado da operação personalizada classificar documento de categoria única 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 que vincula a ação em lote.

Um erro resulta 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 em lote de reconhecimento de entidade.

Um erro resulta 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 suportados para uma tarefa de Sumarização Extrativa.

O resultado de uma ação de lote de sumarização extrativa.

Define valores para ExtractiveSummarizationOrderingCriteria.
KnownExtractiveSummarizationOrderingCriteria pode ser usado de forma intercambiável com ExtractiveSummarizationOrderingCriteria, este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Deslocamento: Indica que os resultados devem ser classificados por ordem de aparição no texto.
Rank: Indica que os resultados devem ser ordenados por 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

4.0.1

Parâmetros suportados para uma tarefa de Cuidados de Saúde.

O resultado de uma ação de lote de cuidados de saúde.

Define valores para HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> pode ser usado de forma intercambiável com HealthcareEntityCategory, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

BODY_STRUCTURE
IDADE
DE GÉNERO
EXAMINATION_NAME
DATA
DIREÇÃO
FREQUÊNCIA
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
TEMPO
GENE_OR_PROTEIN
VARIANTE
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DIAGNÓSTICO
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSAGEM
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

O tipo de diferentes papéis que uma entidade de saúde pode desempenhar numa relação.

Resultado de um erro da operação de cuidados de saúde num único documento.

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

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

O resultado de uma ação em lote de extração de frase-chave.

Um erro resulta 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 deteção de idioma.

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

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

Define valores para OperationStatus.

Resultados paginados da operação de beginAnalyzeBatch.

Define valores para PiiEntityCategory.
KnownPiiEntityCategory pode ser usado de forma intercambiável com PiiEntityCategory, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

ABARoutingNúmero
ARNationalIdentityNumber
AUBankAccountNumber
AUDriversLicenseNumber
AUMedicalAccountNumber
AUPassportNumber
AUTaxFileNumber
AUBusinessNumber
AUCompanyNumber
ATIdentityCard
ATTaxIdentificationNumber
ATValueAddedTaxNumber
AzureDocumentDBAuthKey
AzureIAASDatabaseConnectionAndSQLString
AzureIoTConnectionString
AzurePublishSettingPassword
AzureRedisCacheString
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
DrugEnforcementAgencyNúmero
EEPersonalIdentificationCode
EUDebitCardNumber
EUDriversLicenseNumber
EUGPSCoordinates
EUNationalIdentificationNumber
EUPassportNúmero
EUSocialSecurityNumber
EUTaxIdentificationNumber
FIEuropeanHealthNumber
FINationalID
FINationalIDV2
FIPassportNumber
FRDriversLicenseNumber
FRHealthInsuranceNumber
FRNationalID
FRPassportNúmero
FRSocialSecurityNumber
FRTaxIdentificationNumber
FRValueAddedTaxNumber
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
ZAIdentificationNúmero
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
de e-mail
URL
Idade
Número de telefone
IPAddress
Data
Pessoa
Endereço
Todos os
Padrão

Define valores para PiiEntityDomain.
KnownPiiEntityDomain pode ser usado de forma intercambiável com PiiEntityDomain, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

phi: Indica que as entidades no domínio Informações Pessoais de Saúde devem ser editadas.
nenhum: Indica que nenhum domínio é especificado.

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

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

Um erro resulta 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, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Abreviatura
DirectionOfBodyStructure
DirectionOfCondition
DirectionOfExamination
DirectionOfTreatment
DosagemdeMedicação
FormOfMedication
Frequência da Medicação
Frequência do Tratamento
QualifierOfCondition
RelationOfExamination
RouteOfMedication
TimeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
Unidade de Exame
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, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

TextElements_v8: Os valores de deslocamento e comprimento retornados corresponderão a TextElements (Graphemes e clusters Grapheme) confirmando para o padrão Unicode 8.0.0. Use esta opção se seu aplicativo estiver escrito em .Net Framework ou .Net Core e você estiver usando StringInfo.
UnicodeCodePoint: Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Python.
Utf16CodeUnit: Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use esta opção se seu aplicativo estiver escrito em uma linguagem que suporte Unicode, por exemplo, Java, JavaScript.

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

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

Define valores para TokenSentimentLabel.

Define valores para WarningCode.
<xref:KnownWarningCode> pode ser usado de forma intercambiável com WarningCode, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

LongWordsInDocument
DocumentTruncated

Valores conhecidos de KnownErrorCode que o serviço aceita.

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

Os valores conhecidos de PiiEntityCategory que o serviço aceita.

Os valores conhecidos de PiiEntityDomain que o serviço aceita.

Valores conhecidos de StringIndexType que o serviço aceita.

Tipo de ações suportadas pelo analisar método.

Tipo de ações suportadas pelo método beginAnalyzeBatch.

Inum de possíveis códigos de erro de um TextAnalysisError.