@azure/ai-text-analytics package

Informations d’identification statiques basées sur une clé qui prend en charge la mise à jour de la valeur de clé sous-jacente.

Un client pour interagir avec les fonctionnalités d’analyse de texte dans Azure Cognitive Language Service.

Le client a besoin du point de terminaison d’une ressource language et d’une méthode d’authentification, comme une clé API ou AAD. La clé d’API et le point de terminaison se trouvent dans la page de ressources de langue dans le portail Azure. Elles se trouvent dans la page Clés et point de terminaison de la ressource, sous Gestion des ressources.

Exemples d’authentification :

Clé 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

Pour plus d’informations sur l’authentification auprès d’Azure Active Directory, consultez le package @azure/identity.

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

Configuration commune à toutes les actions.

Métadonnées d’action.

Options communes à toutes les actions de traitement par lots.

Métadonnées pour les opérations de longue durée démarrées par beginAnalyzeBatch.

État de l’opération d’interrogation de début.

Objet qui contient les sentiments prédits, les scores de confiance et d’autres informations sur une évaluation d’une cible. Par exemple, dans la phrase « La nourriture est bonne », l’évaluation de la cible « nourriture » est « bonne ».

Erreur d’une action de traitement par lots d’analyse.

État d’une action par lots

État d’une action par lots réussie.

Options pour l’opération de début d’analyse des actions.

Résultat de classification d’une action de catégorie unique de document de classification personnalisée

Métadonnées d’action personnalisées.

Options d’une action de lot de reconnaissance d’entité personnalisée.

Résultat de l’opération reconnaître des entités personnalisées sur un document unique, contenant une collection d’entités identifiées dans ce document.

Options d’une action de lot de classification multi-étiquette personnalisée.

Résultat de l’opération de classification personnalisée de documents à plusieurs catégories sur un document multiple, contenant le résultat de la classification.

Options d’une action de lot de classification à étiquette unique personnalisée.

Résultat de l’opération de catégorie unique de document de classification personnalisée sur un document unique, contenant le résultat de la classification.

Informations sur la langue d’un document identifiée par le service Language.

Représente un avertissement rencontré lors du traitement d’un document.

Mot ou expression identifié en tant qu’entité catégorisée dans une taxonomie de types. L’ensemble de catégories reconnues par le service language est décrit à https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories .

Type représentant une référence pour l’entité de santé dans un catalogue d’entités spécifique.

Options d’une action de liaison d’entité par lot.

Résultat d’une action de liaison d’entité sur un document unique, contenant une collection des objets LinkedEntity identifiés dans ce document.

Options d’une action de lot de reconnaissance d’entité.

Résultat d’une action de reconnaissance d’entité sur un document unique contenant une collection d’objets Entity identifiés dans ce document.

Options d’une action par lot de résumés extractifs.

Objet qui décrit les métadonnées relatives à l’entité de santé, comme s’il s’agit d’un objet hypothétique ou conditionnel.

Options d’une action de traitement par lots de soins de santé.

Entité de santé représentée en tant que nœud dans un graphique dirigé où les arêtes sont un type particulier de relation entre les nœuds source et cible.

Relation entre deux entités médicales ou plus.

Entité de santé qui joue un rôle spécifique dans une relation.

Résultats d’une opération de santé réussie pour un document unique.

Options d’une action par lot d’extraction d’expressions clés.

Résultat d’une action d’extraction d’expressions clés sur un document unique, contenant une collection des expressions clés identifiées dans ce document.

Entrée de l’opération de détection de langue. Cet objet spécifie un ID de document unique, ainsi que le texte intégral d’un document et un indicateur indiquant le pays d’origine du document pour aider le modèle prédictif de langue à détecter la langue du document.

Résultat d’une action de détection de langue sur un seul document, contenant une prédiction de la langue dans laquelle le document est écrit.

Mot ou expression identifié comme une entité connue dans une base de données, y compris son nom formel (ambiguïté) et un lien vers les informations d’entité dans la base de données source.

Détails sur la sous-chaîne spécifique dans un document qui fait référence à une entité liée identifiée par le modèle de langage.

Un objet d’opinion miné représente une opinion que nous avons extraite d’une phrase. Il s’agit à la fois d’une cible sur laquelle ces évaluations sont relatives et des évaluations réelles elles-mêmes.

Options d’une action par lot de reconnaissance d’entité pii.

Résultat d’une action de reconnaissance d’entité pii sur un document unique, contenant la collection d’objets Entity identifiés dans ce document.

Options pour l’opération de début d’analyse des actions.

Sentiment prédit pour une étendue de texte donnée. Pour plus d’informations sur le sentiment de texte, consultez https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview.

Options d’une action par lot d’analyse des sentiments.

Résultat d’une action d’analyse des sentiments sur un seul document, contenant le sentiment prédit pour chaque phrase ainsi que pour le document complet.

Représente les scores de confiance compris entre 0 et 1 dans toutes les classes de sentiment : positif, neutre, négatif.

Résultat de l’action d’extraction de synthèse sur un document unique, contenant une collection du résumé identifié dans ce document.

Phrase qui fait partie du résumé extrait.

Représente les scores de confiance dans toutes les classes de sentiment : positif, neutre, négatif.

TargetSentiment contient les sentiments prédits, les scores de confiance et d’autres informations sur une cible d’un produit. Une cible d’un produit/service est un composant clé de ce produit/service. Par exemple, dans « The food at Hotel Foo is good », « food » est une cible de « Hotel Foo ».

Options de configuration pour TextAnalysisClient.

Type décrivant une erreur d’API.

Type de base pour les résultats d’erreur d’une action correspondant à un document unique.

Options communes à toutes les opérations.

Type de base pour les résultats d’une action correspondant à un document d’entrée unique.

si includeStatistics=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.

Objet représentant un document texte individuel à analyser par le service Language. Le document contient un ID de document unique, le texte intégral du document et la langue du texte du document.

si includeStatistics=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.

Objet Parameters pour une tâche d’analyse de texte à l’aide de modèles personnalisés.

Configuration commune à toutes les actions qui utilisent des modèles prédéfinis.

Type d’actions prises en charge par la méthode analyser.

Type de paramètres pour chaque action en $AnalyzeActionNames.

Lot d’actions.

Type d’actions prises en charge par la méthode beginAnalyzeBatch.

Polleur qui interroge les opérations longues démarrées par beginAnalyzeBatch.

Résultats d’un lot d’actions.

Type de résultats de chaque action en $AnalyzeActionNames.

Résultat d’une action par lots.

Paramètres pris en charge pour une tâche Entités personnalisées.

Résultat d’une action de lot de reconnaissance d’entité personnalisée.

Une erreur résulte de l’opération reconnaître des entités personnalisées sur un document unique.

Résultat de l’opération de reconnaissance personnalisée des entités sur un document unique.

Options d’une action personnalisée de classification multi-étiquette

Résultat d’une action de lot de classification multi-étiquette personnalisée.

Une erreur résulte de l’opération de classification personnalisée de document à plusieurs catégories sur un document multiple.

Résultat de l’opération de classification personnalisée de documents à plusieurs catégories sur un document multiple.

Options d’une action personnalisée de classification à étiquette unique

Résultat d’une action de lot de classification à étiquette unique personnalisée.

Une erreur résulte de l’opération de catégorie unique de document de classification personnalisée sur un seul document.

Résultat de l’opération de catégorie unique de document de classification personnalisée sur un seul document.

Définit des valeurs pour DocumentSentimentLabel.

Définit des valeurs pour EntityAssociation.

Définit des valeurs pour EntityCertainty.

Définit des valeurs pour EntityConditionality.

Options d’une action de liaison d’entité.

Résultat d’une action de lot de liaison d’entité.

Une erreur résulte d’une action de liaison d’entité sur un document unique.

Résultat d’une action de liaison d’entité sur un document unique.

Options d’une action de reconnaissance d’entité.

Résultat d’une action de lot de reconnaissance d’entité.

Une erreur résulte d’une action de reconnaissance d’entité sur un document unique.

Résultat d’une action de reconnaissance d’entité sur un document unique.

Paramètres pris en charge pour une tâche de synthèse extractif.

Résultat d’une action par lot de résumés extractifs.

Définit des valeurs pour ExtractSummarizationOrderingCriteria.
KnownExtractiveSummarizationOrderingCriteria peut être utilisé de manière interchangeable avec ExtractSummarizationOrderingCriteria, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

décalage: indique que les résultats doivent être triés dans l’ordre d’apparence dans le texte.
classement: indique que les résultats doivent être triés dans l’ordre d’importance (c’est-à-dire le score de classement) en fonction du modèle.

Définit des valeurs pour FhirVersion.
KnownFhirVersion peut être utilisé de manière interchangeable avec FhirVersion, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

4.0.1

Paramètres pris en charge pour une tâche de santé.

Résultat d’une action par lots de soins de santé.

Définit des valeurs pour HealthcareEntityCategory.
<xref:KnownHealthcareEntityCategory> pouvez être utilisé de manière interchangeable avec HealthcareEntityCategory, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

BODY_STRUCTURE
AGE
gender
EXAMINATION_NAME
DATE
DIRECTION
FREQUENCY
MEASUREMENT_VALUE
MEASUREMENT_UNIT
RELATIONAL_OPERATOR
TIME
GENE_OR_PROTEIN
VARIANT
ADMINISTRATIVE_EVENT
CARE_ENVIRONMENT
HEALTHCARE_PROFESSION
DIAGNOSTIC
SYMPTOM_OR_SIGN
CONDITION_QUALIFIER
MEDICATION_CLASS
MEDICATION_NAME
DOSAGE
MEDICATION_FORM
MEDICATION_ROUTE
FAMILY_RELATION
TREATMENT_NAME

Le type de différents rôles qu’une entité de santé peut jouer dans une relation.

Une erreur résulte de l’opération de santé sur un document unique.

Résultat de l’opération de santé sur un document unique.

Options d’une action de reconnaissance d’expressions clés.

Résultat d’une action par lot d’extraction d’expressions clés.

Une erreur résulte d’une action d’extraction d’expressions clés sur un document unique.

Résultat d’une action d’analyse des sentiments sur un document unique.

Options d’une action de détection de langue.

Une erreur résulte d’une action de détection de langue sur un document unique.

Résultat d’une action de détection de langue sur un seul document.

Définit des valeurs pour OperationStatus.

Résultats paginés de l’opération beginAnalyzeBatch.

Définit des valeurs pour PiiEntityCategory.
KnownPiiEntityCategory peut être utilisé de manière interchangeable avec PiiEntityCategory, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

ABARoutingNumber
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
CNResidentityCardNumber
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
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
Organisation
de messagerie
url
âge
Numéro de téléphone
IPAddress
Date
Person
Adresse
Tout
Par défaut

Définit des valeurs pour PiiEntityDomain.
KnownPiiEntityDomain pouvez être utilisé de manière interchangeable avec PiiEntityDomain, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

phi: indique que les entités du domaine Informations personnelles sur la santé doivent être réinsérées.
aucun: indique qu’aucun domaine n’est spécifié.

Options d’une action de reconnaissance d’entité Pii.

Résultat d’une action par lot de reconnaissance d’entité pii.

Une erreur résulte d’une action de reconnaissance d’entité pii sur un document unique.

Résultat d’une action de reconnaissance d’entité sur un document unique.

Définit des valeurs pour RelationType.
<xref:KnownRelationType> pouvez être utilisé de manière interchangeable avec RelationType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

abréviation
DirectionOfBodyStructure
DirectionOfCondition
DirectionOfExamination
DirectionOfTreatment
DosageOfMedication
FormOfMedication
FrequencyOfMedication
frequencyOfTreatment
QualifierOfCondition
RelationOfExamination
routeOfMedication
timeOfCondition
TimeOfEvent
TimeOfExamination
TimeOfMedication
TimeOfTreatment
UnitOfCondition
UnitOfExamination
ValueOfCondition
ValueOfExamination

Définit des valeurs pour SentenceSentimentLabel.

Options d’une action d’analyse des sentiments.

Résultat d’une action par lot d’analyse des sentiments.

Une erreur résulte d’une action d’analyse des sentiments sur un document unique.

Résultat d’une action d’analyse des sentiments sur un document unique.

Définit des valeurs pour StringIndexType.
KnownStringIndexType peut être utilisé de manière interchangeable avec StringIndexType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

TextElements_v8: les valeurs de décalage et de longueur retournées correspondent aux éléments TextElements (clusters Graphemes et Grapheme) confirmant la norme Unicode 8.0.0. Utilisez cette option si votre application est écrite dans .Net Framework ou .Net Core et que vous utiliserez StringInfo.
UnicodeCodePoint: les valeurs de décalage et de longueur retournées correspondent aux points de code Unicode. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Python.
Utf16CodeUnit: les valeurs de décalage et de longueur retournées correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple JavaScript.

Une erreur résulte de l’opération de synthèse d’extraction sur un document unique.

Résultat de l’opération de synthèse d’extraction sur un document unique.

Définit des valeurs pour TokenSentimentLabel.

Définit des valeurs pour WarningCode.
<xref:KnownWarningCode> pouvez être utilisé de manière interchangeable avec WarningCode, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

LongWordsInDocument
documentTruncated

Valeurs connues de KnownErrorCode que le service accepte.

Valeurs connues de ExtractSummarizationOrderingCriteria que le service accepte.

Valeurs connues du paramètre <xref:HealthcareAction.fhirVersion>.

Valeurs connues de KnownInnerErrorCode que le service accepte.

Valeurs connues de PiiEntityCategory que le service accepte.

Valeurs connues de PiiEntityDomain que le service accepte.

Valeurs connues de StringIndexType que le service accepte.

Type d’actions prises en charge par la méthode analyser.

Type d’actions prises en charge par la méthode beginAnalyzeBatch.

Un nombre incalculable de codes d’erreur possibles d’un TextAnalysisError.