Text Analysis Runtime - Analyze Text
Demander une analyse de texte sur une collection de documents.
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Version de l’API à utiliser pour cette opération. |
show
|
query |
boolean |
(Facultatif) si la valeur est true, la réponse contient des statistiques au niveau de la demande et du document. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corps de la demande
Le corps de la requête peut être l’un des suivants :
Nom | Description |
---|---|
Analyze |
Contient l’entrée de liaison d’entité de texte d’analyse. |
Analyze |
La reconnaissance d’entité analyse la demande de tâche d’entrée de texte. |
Analyze |
Contient l’entrée de tâche KeyPhraseExtraction du texte d’analyse. |
Analyze |
Contient l’entrée de tâche d’analyse de document de détection de langue. |
Analyze |
Contient l’entrée de tâche Analyser le texte PIIEntityRecognition. |
Analyze |
Contient l’entrée de tâche Analyser le texte SentimentAnalysis. |
AnalyzeTextEntityLinkingInput
Contient l’entrée de liaison d’entité de texte d’analyse.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Entity |
Type de tâche à effectuer. |
analysisInput |
Contient l’entrée d’analyse à gérer par le service. |
||
parameters |
Paramètres de tâche. |
AnalyzeTextEntityRecognitionInput
La reconnaissance d’entité analyse la demande de tâche d’entrée de texte.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Entity |
Type de tâche à effectuer. |
analysisInput |
Entrée à analyser. |
||
parameters |
Paramètres de tâche. |
AnalyzeTextKeyPhraseExtractionInput
Contient l’entrée de tâche KeyPhraseExtraction du texte d’analyse.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Key |
Type de tâche à effectuer. |
analysisInput |
Contient les documents d’entrée. |
||
parameters |
Paramètres de tâche d’extraction d’expressions clés. |
AnalyzeTextLanguageDetectionInput
Contient l’entrée de tâche d’analyse de document de détection de langue.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Language |
Type de tâche à effectuer. |
analysisInput |
Documents à analyser. |
||
parameters |
paramètres de tâche. |
AnalyzeTextPiiEntitiesRecognitionInput
Contient l’entrée de tâche Analyser le texte PIIEntityRecognition.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Pii |
Type de tâche à effectuer. |
analysisInput |
Contient les documents d’entrée. |
||
parameters |
Paramètres de tâche Pii. |
AnalyzeTextSentimentAnalysisInput
Contient l’entrée de tâche Analyser le texte SentimentAnalysis.
Nom | Obligatoire | Type | Description |
---|---|---|---|
kind | True |
string:
Sentiment |
Type de tâche à effectuer. |
analysisInput |
Contient les documents d’entrée. |
||
parameters |
Paramètres de la tâche Analyse des sentiments. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK | AnalyzeTextTaskResult: |
La demande a réussi. |
Other Status Codes |
Réponse d’erreur inattendue. En-têtes x-ms-error-code: string |
Sécurité
Ocp-Apim-Subscription-Key
Type:
apiKey
Dans:
header
Exemples
SuccessfulEntityLinkingRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityLinking",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
Exemple de réponse
{
"kind": "EntityLinkingResults",
"results": {
"documents": [
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Bill Gates",
"language": "en",
"matches": [
{
"confidenceScore": 0.52,
"length": 10,
"offset": 25,
"text": "Bill Gates"
}
],
"name": "Bill Gates",
"url": "https://en.wikipedia.org/wiki/Bill_Gates"
},
{
"dataSource": "Wikipedia",
"id": "Paul Allen",
"language": "en",
"matches": [
{
"confidenceScore": 0.54,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"name": "Paul Allen",
"url": "https://en.wikipedia.org/wiki/Paul_Allen"
},
{
"dataSource": "Wikipedia",
"id": "Microsoft",
"language": "en",
"matches": [
{
"confidenceScore": 0.49,
"length": 9,
"offset": 0,
"text": "Microsoft"
}
],
"name": "Microsoft",
"url": "https://en.wikipedia.org/wiki/Microsoft"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"dataSource": "Wikipedia",
"id": "Pike Place Market",
"language": "en",
"matches": [
{
"confidenceScore": 0.86,
"length": 17,
"offset": 0,
"text": "Pike place market"
}
],
"name": "Pike Place Market",
"url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
},
{
"dataSource": "Wikipedia",
"id": "Seattle",
"language": "en",
"matches": [
{
"confidenceScore": 0.27,
"length": 7,
"offset": 33,
"text": "Seattle"
}
],
"name": "Seattle",
"url": "https://en.wikipedia.org/wiki/Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-02-01"
}
}
SuccessfulEntityRecognitionRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "EntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Pike place market is my favorite Seattle attraction."
}
]
}
}
Exemple de réponse
{
"kind": "EntityRecognitionResults",
"results": {
"documents": [
{
"entities": [
{
"category": "Organization",
"confidenceScore": 0.84,
"length": 9,
"offset": 0,
"text": "Microsoft"
},
{
"category": "Person",
"confidenceScore": 0.85,
"length": 10,
"offset": 25,
"text": "Bill Gates"
},
{
"category": "Person",
"confidenceScore": 0.9,
"length": 10,
"offset": 40,
"text": "Paul Allen"
}
],
"id": "1",
"warnings": []
},
{
"entities": [
{
"category": "Location",
"confidenceScore": 0.55,
"length": 7,
"offset": 33,
"subcategory": "GPE",
"text": "Seattle"
}
],
"id": "2",
"warnings": []
}
],
"errors": [],
"modelVersion": "2020-04-01"
}
}
SuccessfulKeyPhraseExtractionRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "KeyPhraseExtraction",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Microsoft was founded by Bill Gates and Paul Allen."
},
{
"id": "2",
"language": "en",
"text": "Text Analytics is one of the Azure Cognitive Services."
},
{
"id": "3",
"language": "en",
"text": "My cat might need to see a veterinarian."
}
]
}
}
Exemple de réponse
{
"kind": "KeyPhraseExtractionResults",
"results": {
"documents": [
{
"id": "1",
"keyPhrases": [
"Bill Gates",
"Paul Allen",
"Microsoft"
],
"warnings": []
},
{
"id": "2",
"keyPhrases": [
"Azure Cognitive Services",
"Text Analytics"
],
"warnings": []
},
{
"id": "3",
"keyPhrases": [
"cat",
"veterinarian"
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-06-01"
}
}
SuccessfulLanguageDetectionRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "LanguageDetection",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"text": "Hello world"
},
{
"id": "2",
"text": "Bonjour tout le monde"
},
{
"id": "3",
"text": "Hola mundo"
},
{
"id": "4",
"text": "Tumhara naam kya hai?"
}
]
}
}
Exemple de réponse
{
"kind": "LanguageDetectionResults",
"results": {
"documents": [
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "en",
"name": "English"
},
"id": "1",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "fr",
"name": "French"
},
"id": "2",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "es",
"name": "Spanish"
},
"id": "3",
"warnings": []
},
{
"detectedLanguage": {
"confidenceScore": 1,
"iso6391Name": "hi",
"name": "Hindi"
},
"id": "4",
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-05"
}
}
SuccessfulPiiEntityRecognitionRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "PiiEntityRecognition",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "My SSN is 859-98-0987"
},
{
"id": "2",
"language": "en",
"text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
},
{
"id": "3",
"language": "en",
"text": "Is 998.214.865-68 your Brazilian CPF number?"
}
]
}
}
Exemple de réponse
{
"kind": "PiiEntityRecognitionResults",
"results": {
"documents": [
{
"id": "1",
"redactedText": "My SSN is ***********",
"entities": [
{
"category": "USSocialSecurityNumber",
"confidenceScore": 0.65,
"length": 11,
"offset": 28,
"text": "859-98-0987"
}
],
"warnings": []
},
{
"id": "2",
"redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
"entities": [
{
"category": "ABARoutingNumber",
"confidenceScore": 0.75,
"length": 9,
"offset": 18,
"text": "111000025"
}
],
"warnings": []
},
{
"id": "3",
"redactedText": "Is ************** your Brazilian CPF number?",
"entities": [
{
"category": "BRCPFNumber",
"confidenceScore": 0.85,
"length": 14,
"offset": 3,
"text": "998.214.865-68"
}
],
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-01-15"
}
}
SuccessfulSentimentAnalysisRequest
Exemple de requête
POST {Endpoint}/language/:analyze-text?api-version=2023-04-01
{
"kind": "SentimentAnalysis",
"parameters": {
"modelVersion": "latest"
},
"analysisInput": {
"documents": [
{
"id": "1",
"language": "en",
"text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
}
]
}
}
Exemple de réponse
{
"kind": "SentimentAnalysisResults",
"results": {
"documents": [
{
"confidenceScores": {
"negative": 0,
"neutral": 0,
"positive": 1
},
"id": "1",
"sentences": [
{
"targets": [
{
"confidenceScores": {
"negative": 0,
"positive": 1
},
"length": 10,
"offset": 6,
"relations": [
{
"ref": "#/documents/0/sentences/0/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "atmosphere"
}
],
"confidenceScores": {
"negative": 0,
"neutral": 0,
"positive": 1
},
"length": 17,
"offset": 0,
"assessments": [
{
"confidenceScores": {
"negative": 0,
"positive": 1
},
"isNegated": false,
"length": 5,
"offset": 0,
"sentiment": "positive",
"text": "great"
}
],
"sentiment": "positive",
"text": "Great atmosphere."
},
{
"targets": [
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"length": 11,
"offset": 37,
"relations": [
{
"ref": "#/documents/0/sentences/1/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "restaurants"
},
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"length": 6,
"offset": 50,
"relations": [
{
"ref": "#/documents/0/sentences/1/assessments/0",
"relationType": "assessment"
}
],
"sentiment": "positive",
"text": "hotels"
}
],
"confidenceScores": {
"negative": 0.01,
"neutral": 0.86,
"positive": 0.13
},
"length": 52,
"offset": 18,
"assessments": [
{
"confidenceScores": {
"negative": 0.01,
"positive": 0.99
},
"isNegated": false,
"length": 15,
"offset": 18,
"sentiment": "positive",
"text": "Close to plenty"
}
],
"sentiment": "neutral",
"text": "Close to plenty of restaurants, hotels, and transit!"
}
],
"sentiment": "positive",
"warnings": []
}
],
"errors": [],
"modelVersion": "2021-10-01"
}
}
Définitions
Nom | Description |
---|---|
Analyze |
Contient l’entrée de liaison d’entité de texte d’analyse. |
Analyze |
La reconnaissance d’entité analyse la demande de tâche d’entrée de texte. |
Analyze |
Contient l’entrée de tâche KeyPhraseExtraction du texte d’analyse. |
Analyze |
Contient l’entrée de tâche d’analyse de document de détection de langue. |
Analyze |
Contient l’entrée de tâche d’analyse de texte PIIEntityRecognition. |
Analyze |
Contient l’entrée de tâche d’analyse sentimentanalyse du texte. |
Analyze |
Type de tâches d’analyse de texte prises en charge. |
Analyze |
Type de l’objet de réponse retourné par la tâche d’analyse de texte. |
Detected |
Contient les détails de la langue détectée pour le texte. |
Document |
Contient les détails des erreurs rencontrées pendant l’exécution d’un travail. |
Document |
Sentiment prédit pour le document (négatif, neutre, positif ou mixte). |
Document |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
Document |
Contient l’objet warnings avec les avertissements rencontrés pour le document traité. |
Entities |
Contient le résultat de la tâche de reconnaissance d’entité pour le document. |
Entities |
Contient le résultat de la tâche de reconnaissance d’entité. |
Entities |
Paramètres pris en charge pour une tâche de reconnaissance d’entité. |
Entities |
Contient la tâche d’entité |
Entity |
Définit l’objet d’entité détecté contenant la catégorie d’entité et le texte de l’entité détecté, etc. |
Entity |
Résultat de la liaison d’entité. |
Entity |
Paramètres pris en charge pour une tâche de liaison d’entités. |
Entity |
Contient le résultat de la tâche de liaison d’entité de texte d’analyse. |
Error |
Objet de réponse d’erreur retourné lorsque le service rencontre des erreurs pendant le traitement de la demande. |
Error |
Code d’erreur lisible par l’utilisateur. |
Error |
Réponse d’erreur. |
Inner |
Code d’erreur lisible par l’utilisateur. |
Inner |
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Key |
Contient le KeyPhraseResult. |
Key |
Contient les résultats de l’extraction de phrases clés pour un document. |
Key |
Paramètres pris en charge pour une tâche d’extraction de phrases clés. |
Key |
Contient le résultat de la tâche KeyPhraseExtraction du texte d’analyse. |
Language |
Contient l’entrée d’analyse de document de détection de langue. |
Language |
Contient la détection de langue pour un document. |
Language |
Contient le résultat de la détection de langue pour la requête. |
Language |
Paramètres pris en charge pour une tâche de détection de langue. |
Language |
Contient le résultat de la tâche de détection de langue pour la requête. |
Language |
Contient l’entrée de détection de langue. |
Linked |
Résultat du document de liaison d’entités. |
Linked |
Objet LinkedEntity contenant l’entité détectée avec les sources/liens associés. |
Match |
Objet Match contenant le texte de l’entité détectée avec le décalage et la longueur. |
Multi |
Collection de documents d’entrée à analyser par le service. |
Multi |
Contient un document d’entrée à analyser par le service. |
Pii |
(Facultatif) décrit les catégories d’informations d’identification personnelle à retourner |
Pii |
Tâche Domaine pour les informations d’identification personnelle |
Pii |
Contient les résultats des informations d’identification personnelle. |
Pii |
Contient le PiiResult. |
Pii |
Paramètres pris en charge pour une tâche de reconnaissance d’entités piI. |
Pii |
Contient la tâche DRO PIIEntityRecognition d’analyse du texte. |
Request |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande. |
Sentence |
Représente une évaluation de phrase et les évaluations ou les objets cibles qui lui sont associés. |
Sentence |
Sentiment de phrase d’un document. |
Sentence |
Sentiment prédit pour la phrase. |
Sentence |
Représente une cible de phrase et les évaluations ou les objets cibles qui lui sont associés. |
Sentiment |
Paramètres pris en charge pour une tâche d’analyse des sentiments. |
Sentiment |
Représente les scores de confiance compris entre 0 et 1 dans toutes les classes de sentiments : positif, neutre, négatif. |
Sentiment |
Objet représentant les résultats prédéfinis de l’analyse des sentiments de chaque document. |
Sentiment |
Résultats de l’analyse des sentiments pour les documents d’entrée. |
Sentiment |
Contient le résultat de la tâche LRO SentimentAnalysis du texte d’analyse. |
String |
Type d’index de chaîne |
Target |
Représente les scores de confiance dans toutes les classes de sentiments : positif et négatif. |
Target |
Représente la relation entre les évaluations et/ou les cibles. |
Target |
Type lié à la cible. |
Token |
Sentiment prédit pour la phrase. |
Warning |
Définit la liste des codes d’avertissement. |
AnalyzeTextEntityLinkingInput
Contient l’entrée de liaison d’entité de texte d’analyse.
Nom | Type | Description |
---|---|---|
analysisInput |
Contient l’entrée d’analyse à gérer par le service. |
|
kind |
string:
Entity |
Type de tâche à effectuer. |
parameters |
Paramètres de tâche. |
AnalyzeTextEntityRecognitionInput
La reconnaissance d’entité analyse la demande de tâche d’entrée de texte.
Nom | Type | Description |
---|---|---|
analysisInput |
Entrée à analyser. |
|
kind |
string:
Entity |
Type de tâche à effectuer. |
parameters |
Paramètres de tâche. |
AnalyzeTextKeyPhraseExtractionInput
Contient l’entrée de tâche KeyPhraseExtraction du texte d’analyse.
Nom | Type | Description |
---|---|---|
analysisInput |
Contient les documents d’entrée. |
|
kind |
string:
Key |
Type de tâche à effectuer. |
parameters |
Paramètres de tâche d’extraction de phrases clés. |
AnalyzeTextLanguageDetectionInput
Contient l’entrée de tâche d’analyse de document de détection de langue.
Nom | Type | Description |
---|---|---|
analysisInput |
Documents à analyser. |
|
kind |
string:
Language |
Type de tâche à effectuer. |
parameters |
paramètres de tâche. |
AnalyzeTextPiiEntitiesRecognitionInput
Contient l’entrée de tâche d’analyse de texte PIIEntityRecognition.
Nom | Type | Description |
---|---|---|
analysisInput |
Contient les documents d’entrée. |
|
kind |
string:
Pii |
Type de tâche à effectuer. |
parameters |
Paramètres de tâche Pii. |
AnalyzeTextSentimentAnalysisInput
Contient l’entrée de tâche d’analyse sentimentanalyse du texte.
Nom | Type | Description |
---|---|---|
analysisInput |
Contient les documents d’entrée. |
|
kind |
string:
Sentiment |
Type de tâche à effectuer. |
parameters |
Paramètres de tâche Analyse des sentiments. |
AnalyzeTextTaskKind
Type de tâches d’analyse de texte prises en charge.
Nom | Type | Description |
---|---|---|
EntityLinking |
string |
Tâche de liaison d’entités |
EntityRecognition |
string |
Tâche de reconnaissance d’entité |
KeyPhraseExtraction |
string |
Tâche d’extraction de phrases clés |
LanguageDetection |
string |
Tâche de détection de langue |
PiiEntityRecognition |
string |
Tâche de reconnaissance d’entité PII |
SentimentAnalysis |
string |
Tâche d’analyse des sentiments |
AnalyzeTextTaskResultsKind
Type de l’objet de réponse retourné par la tâche d’analyse de texte.
Nom | Type | Description |
---|---|---|
EntityLinkingResults |
string |
Résultats de la liaison d’entités |
EntityRecognitionResults |
string |
Résultats de la reconnaissance d’entité |
KeyPhraseExtractionResults |
string |
Résultats de l’extraction d’expressions clés |
LanguageDetectionResults |
string |
Résultats de la détection de langue |
PiiEntityRecognitionResults |
string |
Résultats de la reconnaissance d’entité PII |
SentimentAnalysisResults |
string |
Résultats de l’analyse des sentiments |
DetectedLanguage
Contient les détails de la langue détectée pour le texte.
Nom | Type | Description |
---|---|---|
confidenceScore |
number |
Un score de confiance compris entre 0 et 1. Un score proche de 1 indique une certitude à 100 % que la langue identifiée est la bonne. |
iso6391Name |
string |
Représentation à deux lettres de la langue détectée selon la norme ISO 639-1 (par exemple, en, fr). |
name |
string |
Nom long d’une langue détectée (par exemple, anglais, Français). |
DocumentError
Contient les détails des erreurs rencontrées pendant l’exécution d’un travail.
Nom | Type | Description |
---|---|---|
error |
Erreur rencontrée. |
|
id |
string |
ID du document d’entrée. |
DocumentSentimentValue
Sentiment prédit pour le document (négatif, neutre, positif ou mixte).
Nom | Type | Description |
---|---|---|
mixed |
string |
Instruction mixte |
negative |
string |
Déclaration négative |
neutral |
string |
Instruction neutre |
positive |
string |
Déclaration positive |
DocumentStatistics
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document.
Nom | Type | Description |
---|---|---|
charactersCount |
integer |
Nombre d’éléments de texte reconnus dans le document. |
transactionsCount |
integer |
Nombre de transactions pour le document. |
DocumentWarning
Contient l’objet warnings avec les avertissements rencontrés pour le document traité.
Nom | Type | Description |
---|---|---|
code |
Code d’avertissement. |
|
message |
string |
Message d'avertissement. |
targetRef |
string |
Référence de pointeur JSON indiquant l’objet cible. |
EntitiesDocumentResult
Contient le résultat de la tâche de reconnaissance d’entité pour le document.
Nom | Type | Description |
---|---|---|
entities |
Entity[] |
Entités reconnues dans le document. |
id |
string |
Identificateur de document unique et non vide. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
EntitiesResult
Contient le résultat de la tâche de reconnaissance d’entité.
Nom | Type | Description |
---|---|---|
documents |
Réponse par document |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique quel modèle est utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la requête. |
EntitiesTaskParameters
Paramètres pris en charge pour une tâche de reconnaissance d’entité.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
stringIndexType | TextElements_v8 |
(Facultatif) paramètre pour fournir le type d’index de chaîne utilisé pour interpréter les décalages de chaîne. La valeur par défaut est TextElements (Graphemes). |
EntitiesTaskResult
Contient la tâche d’entité
Nom | Type | Description |
---|---|---|
kind |
string:
Entity |
Type de résultat de la tâche. |
results |
Résultats de la reconnaissance d’entité. |
Entity
Définit l’objet d’entité détecté contenant la catégorie d’entité et le texte de l’entité détecté, etc.
Nom | Type | Description |
---|---|---|
category |
string |
Type d’entité. |
confidenceScore |
number |
Score de confiance compris entre 0 et 1 de l’entité extraite. |
length |
integer |
Longueur du texte de l’entité. L’utilisation de différentes valeurs « stringIndexType » peut affecter la longueur retournée. |
offset |
integer |
Position de début du texte de l’entité. L’utilisation de différentes valeurs « stringIndexType » peut affecter le décalage retourné. |
subcategory |
string |
(Facultatif) Sous-type d’entité. |
text |
string |
Texte de l’entité tel qu’il apparaît dans la demande. |
EntityLinkingResult
Résultat de la liaison d’entité.
Nom | Type | Description |
---|---|---|
documents |
Réponse par document |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique quel modèle est utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la requête. |
EntityLinkingTaskParameters
Paramètres pris en charge pour une tâche de liaison d’entités.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
stringIndexType | TextElements_v8 |
Paramètre facultatif pour fournir le type d’index de chaîne utilisé pour interpréter les décalages de chaîne. La valeur par défaut est TextElements (Graphemes). |
EntityLinkingTaskResult
Contient le résultat de la tâche de liaison d’entité de texte d’analyse.
Nom | Type | Description |
---|---|---|
kind |
string:
Entity |
Type de résultat de la tâche. |
results |
Résultat de la liaison d’entités. |
Error
Objet de réponse d’erreur retourné lorsque le service rencontre des erreurs pendant le traitement de la demande.
Nom | Type | Description |
---|---|---|
code |
Un des ensembles de codes d’erreur définis par le serveur. |
|
details |
Error[] |
Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible de l’erreur. |
target |
string |
Cible de l’erreur. |
ErrorCode
Code d’erreur lisible par l’utilisateur.
Nom | Type | Description |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
Recherche cognitive Azure l’erreur limite d’index atteinte |
AzureCognitiveSearchIndexNotFound |
string |
Recherche cognitive Azure erreur d’index introuvable |
AzureCognitiveSearchNotFound |
string |
erreur Recherche cognitive Azure introuvable |
AzureCognitiveSearchThrottling |
string |
Recherche cognitive Azure erreur de limitation |
Conflict |
string |
Erreur de conflit |
Forbidden |
string |
Erreur d’accès interdit |
InternalServerError |
string |
Erreur interne du serveur |
InvalidArgument |
string |
Erreur d’argument non valide |
InvalidRequest |
string |
Erreur de requête non valide |
NotFound |
string |
Erreur introuvable |
OperationNotFound |
string |
Erreur d’opération introuvable |
ProjectNotFound |
string |
Erreur project introuvable |
QuotaExceeded |
string |
Erreur de dépassement de quota |
ServiceUnavailable |
string |
Erreur de service indisponible |
Timeout |
string |
Erreur de délai d’expiration |
TooManyRequests |
string |
Erreur trop de requêtes |
Unauthorized |
string |
Erreur d’accès non autorisé |
Warning |
string |
Erreur d’avertissement |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Objet error. |
InnerErrorCode
Code d’erreur lisible par l’utilisateur.
Nom | Type | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
erreur Recherche cognitive Azure introuvable |
AzureCognitiveSearchThrottling |
string |
Recherche cognitive Azure erreur de limitation |
EmptyRequest |
string |
Erreur de requête vide |
ExtractionFailure |
string |
Erreur d’échec d’extraction |
InvalidCountryHint |
string |
Erreur d’indicateur de pays non valide |
InvalidDocument |
string |
Erreur de document non valide |
InvalidDocumentBatch |
string |
Erreur de lot de documents non valide |
InvalidParameterValue |
string |
Erreur de valeur de paramètre non valide |
InvalidRequest |
string |
Erreur de requête non valide |
InvalidRequestBodyFormat |
string |
Erreur de format du corps de la demande non valide |
KnowledgeBaseNotFound |
string |
Erreur de base de connaissances introuvable |
MissingInputDocuments |
string |
Erreur de documents d’entrée manquants |
ModelVersionIncorrect |
string |
Erreur de version incorrecte du modèle |
UnsupportedLanguageCode |
string |
Erreur de code de langue non prise en charge |
InnerErrorModel
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nom | Type | Description |
---|---|---|
code |
Un des ensembles de codes d’erreur définis par le serveur. |
|
details |
object |
Détails de l’erreur. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Message d’erreur. |
target |
string |
Cible d’erreur. |
KeyPhraseResult
Contient le KeyPhraseResult.
Nom | Type | Description |
---|---|---|
documents |
Réponse par document |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique le modèle utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande. |
KeyPhrasesDocumentResult
Contient les résultats de l’extraction de phrases clés pour un document.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur de document unique et non vide. |
keyPhrases |
string[] |
Liste de mots ou d’expressions représentatifs. Le nombre d’expressions clés retournées est proportionnel au nombre de mots dans le document d’entrée. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
KeyPhraseTaskParameters
Paramètres pris en charge pour une tâche d’extraction de phrases clés.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
KeyPhraseTaskResult
Contient le résultat de la tâche KeyPhraseExtraction du texte d’analyse.
Nom | Type | Description |
---|---|---|
kind |
string:
Key |
Type de résultat de la tâche. |
results |
Liste des résultats de l’extraction de phrases clés |
LanguageDetectionAnalysisInput
Contient l’entrée d’analyse de document de détection de langue.
Nom | Type | Description |
---|---|---|
documents |
Liste des documents à analyser. |
LanguageDetectionDocumentResult
Contient la détection de langue pour un document.
Nom | Type | Description |
---|---|---|
detectedLanguage |
Langue détectée. |
|
id |
string |
Identificateur de document unique et non vide. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
LanguageDetectionResult
Contient le résultat de la détection de langue pour la requête.
Nom | Type | Description |
---|---|---|
documents |
Énumération des résultats de la détection de langue pour chaque document d’entrée. |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique le modèle utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande. |
LanguageDetectionTaskParameters
Paramètres pris en charge pour une tâche de détection de langue.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
LanguageDetectionTaskResult
Contient le résultat de la tâche de détection de langue pour la requête.
Nom | Type | Description |
---|---|---|
kind |
string:
Language |
Type de résultat de la tâche. |
results |
Contient les résultats de la détection de langue. |
LanguageInput
Contient l’entrée de détection de langue.
Nom | Type | Description |
---|---|---|
countryHint |
string |
Indicateur de pays pour faciliter la détection de langue du texte. |
id |
string |
Identificateur de document unique et non vide. |
text |
string |
Texte d’entrée à traiter. |
LinkedEntitiesDocumentResult
Résultat du document de liaison d’entités.
Nom | Type | Description |
---|---|---|
entities |
Entités connues reconnues dans le document. |
|
id |
string |
Identificateur de document unique et non vide. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
LinkedEntity
Objet LinkedEntity contenant l’entité détectée avec les sources/liens associés.
Nom | Type | Description |
---|---|---|
bingId |
string |
Identificateur unique de l’API Recherche d’entités Bing de l’entité reconnue. |
dataSource |
string |
Source de données utilisée pour extraire la liaison d’entités, telle que Wiki/Bing, etc. |
id |
string |
Identificateur unique de l’entité reconnue à partir de la source de données. |
language |
string |
Langue utilisée dans la source de données. |
matches |
Match[] |
Liste des instances de cette entité apparaît dans le texte. |
name |
string |
Nom formel de la liaison d’entités. |
url |
string |
URL de la page de l’entité à partir de la source de données. |
Match
Objet Match contenant le texte de l’entité détectée avec le décalage et la longueur.
Nom | Type | Description |
---|---|---|
confidenceScore |
number |
Si un élément connu est reconnu, un nombre décimal indiquant le niveau de confiance compris entre 0 et 1 est retourné. |
length |
integer |
Longueur du texte de correspondance d’entité. |
offset |
integer |
Position de début pour le texte de correspondance d’entité. |
text |
string |
Texte de l’entité tel qu’il apparaît dans la demande. |
MultiLanguageAnalysisInput
Collection de documents d’entrée à analyser par le service.
Nom | Type | Description |
---|---|---|
documents |
Documents d’entrée à analyser. |
MultiLanguageInput
Contient un document d’entrée à analyser par le service.
Nom | Type | Description |
---|---|---|
id |
string |
Identificateur de document unique et non vide. |
language |
string |
(Facultatif) Il s’agit de la représentation ISO 639-1 à 2 lettres d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. S’il n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut. (Ce qui suit s’applique uniquement à 2023-04-15-preview et versions ultérieures) Pour Détection automatique de la langue, utilisez « auto ». S’il n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut. |
text |
string |
Texte d’entrée à traiter. |
PiiCategory
(Facultatif) décrit les catégories d’informations d’identification personnelle à retourner
Nom | Type | Description |
---|---|---|
ABARoutingNumber |
string |
Numéro de routage ABA |
ARNationalIdentityNumber |
string |
Numéro d’identité nationale AR |
ATIdentityCard |
string |
Carte d’identité AT |
ATTaxIdentificationNumber |
string |
Numéro d’identification fiscale AT |
ATValueAddedTaxNumber |
string |
Numéro de taxe sur la valeur ajoutée AT |
AUBankAccountNumber |
string |
Carte d’identité AT |
AUBusinessNumber |
string |
Numéro d’entreprise AU |
AUCompanyNumber |
string |
Numéro d’entreprise AU |
AUDriversLicenseNumber |
string |
Numéro de permis de conduire AU |
AUMedicalAccountNumber |
string |
Numéro de compte médical AU |
AUPassportNumber |
string |
Numéro de passeport AU |
AUTaxFileNumber |
string |
Numéro de fichier fiscal AU |
Address |
string |
Adresse |
Age |
string |
Age |
All |
string |
Toutes les catégories d’informations personnelles. |
AzureDocumentDBAuthKey |
string |
Clé d’authentification Azure Document DB |
AzureIAASDatabaseConnectionAndSQLString |
string |
Connexion de base de données IAAS Azure et chaîne SQL |
AzureIoTConnectionString |
string |
Chaîne de connexion Azure IoT |
AzurePublishSettingPassword |
string |
Mot de passe de paramètre de publication Azure |
AzureRedisCacheString |
string |
Chaîne de cache Redis Azure |
AzureSAS |
string |
Azure SAAS |
AzureServiceBusString |
string |
chaîne Azure Service Bus |
AzureStorageAccountGeneric |
string |
Compte de stockage Azure Générique |
AzureStorageAccountKey |
string |
Clé du compte de Stockage Azure |
BENationalNumber |
string |
NUMÉRO NATIONAL BE |
BENationalNumberV2 |
string |
NUMÉRO NATIONAL BE V2 |
BEValueAddedTaxNumber |
string |
Numéro de taxe sur la valeur ajoutée BE |
BGUniformCivilNumber |
string |
NUMÉRO CIVIL UNIFORME BG |
BRCPFNumber |
string |
Numéro CPF BR |
BRLegalEntityNumber |
string |
Numéro d’entité juridique BR |
BRNationalIDRG |
string |
BR National ID RG |
CABankAccountNumber |
string |
Numéro de compte bancaire de l’autorité de certification |
CADriversLicenseNumber |
string |
Numéro de permis de conduire de l’autorité de certification |
CAHealthServiceNumber |
string |
Numéro du service d’intégrité de l’autorité de certification |
CAPassportNumber |
string |
Numéro de passeport de l’autorité de certification |
CAPersonalHealthIdentification |
string |
Identification de l’intégrité personnelle de l’autorité de certification |
CASocialInsuranceNumber |
string |
Numéro d’assurance sociale CA |
CHSocialSecurityNumber |
string |
Numéro de sécurité sociale CH |
CLIdentityCardNumber |
string |
Numéro de carte d’identité CL |
CNResidentIdentityCardNumber |
string |
Numéro de carte d’identité du résident du CN |
CYIdentityCard |
string |
Carte d’identité CY |
CYTaxIdentificationNumber |
string |
Numéro d’identification fiscale CY |
CZPersonalIdentityNumber |
string |
Numéro d’identité personnel CZ |
CZPersonalIdentityV2 |
string |
Identité personnelle CZ V2 |
CreditCardNumber |
string |
Numéro de carte de crédit |
DEDriversLicenseNumber |
string |
Numéro de permis de conduire DE |
DEIdentityCardNumber |
string |
Numéro de carte d’identité DE |
DEPassportNumber |
string |
Numéro de passeport DE |
DETaxIdentificationNumber |
string |
Numéro d’identification fiscale DE |
DEValueAddedNumber |
string |
Nombre de valeurs ajoutées DE |
DKPersonalIdentificationNumber |
string |
Numéro d’identification personnelle DK |
DKPersonalIdentificationV2 |
string |
DK Personal Identification V2 |
Date |
string |
Date |
Default |
string |
Catégories d’informations personnelles par défaut pour la langue. |
DrugEnforcementAgencyNumber |
string |
Numéro de l’agence d’application de la loi sur les drogues |
EEPersonalIdentificationCode |
string |
Code d’identification personnelle de l’EE |
ESDNI |
string |
ES DNI |
ESSocialSecurityNumber |
string |
Numéro de sécurité sociale ES |
ESTaxIdentificationNumber |
string |
Numéro d’identification fiscale ES |
EUDebitCardNumber |
string |
Numéro de carte de débit UE |
EUDriversLicenseNumber |
string |
Numéro de permis de conduire dans l’Union européenne |
EUGPSCoordinates |
string |
Coordonnées GPS UE |
EUNationalIdentificationNumber |
string |
Numéro d’identification nationale dans l’Union européenne |
EUPassportNumber |
string |
Numéro de passeport dans l’Union européenne |
EUSocialSecurityNumber |
string |
Numéro de sécurité sociale de l’UE |
EUTaxIdentificationNumber |
string |
Numéro d’identification fiscale de l’UE |
string |
Courrier |
|
FIEuropeanHealthNumber |
string |
Numéro de santé européen FI |
FINationalID |
string |
FI National ID |
FINationalIDV2 |
string |
FI National ID V2 |
FIPassportNumber |
string |
Numéro de passeport FI |
FRDriversLicenseNumber |
string |
Numéro de permis de conduire FR |
FRHealthInsuranceNumber |
string |
Numéro d’assurance maladie FR |
FRNationalID |
string |
FR National ID |
FRPassportNumber |
string |
Numéro de passeport FR |
FRSocialSecurityNumber |
string |
Numéro de sécurité sociale FR |
FRTaxIdentificationNumber |
string |
Numéro d’identification fiscale FR |
FRValueAddedTaxNumber |
string |
Numéro de taxe sur la valeur ajoutée FR |
GRNationalIDCard |
string |
Carte d’identité nationale GR |
GRNationalIDV2 |
string |
GR National ID V2 |
GRTaxIdentificationNumber |
string |
Numéro d’identification fiscale GR |
HKIdentityCardNumber |
string |
Numéro de carte d’identité HK |
HRIdentityCardNumber |
string |
Numéro de carte d’identité RH |
HRNationalIDNumber |
string |
Numéro d’identification national RH |
HRPersonalIdentificationNumber |
string |
Numéro d’identification personnel RH |
HRPersonalIdentificationOIBNumberV2 |
string |
Numéro D’identification personnelle RH OIB V2 |
HUPersonalIdentificationNumber |
string |
Numéro d’identification personnel hu |
HUTaxIdentificationNumber |
string |
Numéro d’identification fiscale HU |
HUValueAddedNumber |
string |
Numéro ajouté de la valeur HU |
IDIdentityCardNumber |
string |
Numéro de carte d’identité |
IEPersonalPublicServiceNumber |
string |
Numéro de service public personnel d’Internet Explorer |
IEPersonalPublicServiceNumberV2 |
string |
Numéro de service public personnel IE V2 |
ILBankAccountNumber |
string |
Numéro de compte bancaire IL |
ILNationalID |
string |
IL National ID |
INPermanentAccount |
string |
IN Permanent Account |
INUniqueIdentificationNumber |
string |
IN Numéro d’identification unique |
IPAddress |
string |
Adresse IP |
ITDriversLicenseNumber |
string |
Numéro de permis de conduire informatique |
ITFiscalCode |
string |
Code fiscal informatique |
ITValueAddedTaxNumber |
string |
Numéro de taxe sur la valeur ajoutée informatique |
InternationalBankingAccountNumber |
string |
Numéro de compte bancaire international |
JPBankAccountNumber |
string |
Numéro de compte bancaire JP |
JPDriversLicenseNumber |
string |
Numéro de permis de conduire JP |
JPMyNumberCorporate |
string |
JP My Number Corporate |
JPMyNumberPersonal |
string |
JP My Number Personal |
JPPassportNumber |
string |
Numéro de passeport JP |
JPResidenceCardNumber |
string |
Numéro de carte de résidence JP |
JPResidentRegistrationNumber |
string |
Numéro d’inscription de résident JP |
JPSocialInsuranceNumber |
string |
Numéro d’assurance sociale JP |
KRResidentRegistrationNumber |
string |
Numéro d’inscription du résident KR |
LTPersonalCode |
string |
Code personnel LT |
LUNationalIdentificationNumberNatural |
string |
NUMÉRO D’IDENTIFICATION NATIONAL NATURAL |
LUNationalIdentificationNumberNonNatural |
string |
Numéro d’identification national lu non naturel |
LVPersonalCode |
string |
Code personnel LV |
MTIdentityCardNumber |
string |
Numéro de carte d’identité MT |
MTTaxIDNumber |
string |
Numéro d’ID fiscal MT |
MYIdentityCardNumber |
string |
NUMÉRO DE CARTE D’IDENTITÉ MY |
NLCitizensServiceNumber |
string |
Numéro de service aux citoyens de Terre-Neuve-et-Labrador |
NLCitizensServiceNumberV2 |
string |
NL Citizens Service Number V2 |
NLTaxIdentificationNumber |
string |
Numéro d’identification fiscale NL |
NLValueAddedTaxNumber |
string |
NUMÉRO DE TAXE SUR LA VALEUR AJOUTÉE NL |
NOIdentityNumber |
string |
AUCUN numéro d’identité |
NZBankAccountNumber |
string |
Numéro de compte bancaire NZ |
NZDriversLicenseNumber |
string |
Numéro de permis de conduire NZ |
NZInlandRevenueNumber |
string |
NZ Inland Revenue Number |
NZMinistryOfHealthNumber |
string |
Numéro du ministère de la Santé de la NZ |
NZSocialWelfareNumber |
string |
Numéro de protection sociale de la NZ |
Organization |
string |
Organisation |
PHUnifiedMultiPurposeIDNumber |
string |
Numéro d’ID multi-usage unifié de PH |
PLIdentityCard |
string |
Carte d’identité PL |
PLNationalID |
string |
PL National ID |
PLNationalIDV2 |
string |
PL National ID V2 |
PLPassportNumber |
string |
Numéro de passeport PL |
PLREGONNumber |
string |
Numéro PL REGON |
PLTaxIdentificationNumber |
string |
Numéro d’identification fiscale PL |
PTCitizenCardNumber |
string |
Numéro de carte de citoyen PT |
PTCitizenCardNumberV2 |
string |
NUMÉRO DE CARTE DE CITOYEN PT V2 |
PTTaxIdentificationNumber |
string |
Numéro d’identification fiscale PT |
Person |
string |
Personne |
PhoneNumber |
string |
Numéro de téléphone |
ROPersonalNumericalCode |
string |
Code numérique personnel RO |
RUPassportNumberDomestic |
string |
Numéro de passeport RU National |
RUPassportNumberInternational |
string |
Numéro de passeport RU International |
SANationalID |
string |
SA National ID |
SENationalID |
string |
SE National ID |
SENationalIDV2 |
string |
SE National ID V2 |
SEPassportNumber |
string |
Numéro de passeport SE |
SETaxIdentificationNumber |
string |
Numéro d’identification fiscale SE |
SGNationalRegistrationIdentityCardNumber |
string |
Numéro de carte d’identité d’inscription nationale SG |
SITaxIdentificationNumber |
string |
Numéro d’identification fiscale SI |
SIUniqueMasterCitizenNumber |
string |
Numéro de citoyen maître unique SI |
SKPersonalNumber |
string |
Numéro personnel SK |
SQLServerConnectionString |
string |
Chaîne de connexion SQL Server |
SWIFTCode |
string |
Code SWIFT |
THPopulationIdentificationCode |
string |
Code d’identification de la population TH |
TRNationalIdentificationNumber |
string |
Numéro d’identification national TR |
TWNationalID |
string |
TW National ID |
TWPassportNumber |
string |
Numéro de passeport TW |
TWResidentCertificate |
string |
Certificat de résident TW |
UAPassportNumberDomestic |
string |
Numéro de passeport UA National |
UAPassportNumberInternational |
string |
Numéro de passeport UA International |
UKDriversLicenseNumber |
string |
Numéro de permis de conduire au Royaume-Uni |
UKElectoralRollNumber |
string |
Numéro de liste électorale britannique |
UKNationalHealthNumber |
string |
Numéro de santé national du Royaume-Uni |
UKNationalInsuranceNumber |
string |
Numéro d’assurance nationale du Royaume-Uni |
UKUniqueTaxpayerNumber |
string |
Numéro de contribuable unique au Royaume-Uni |
URL |
string |
URL |
USBankAccountNumber |
string |
Numéro de compte bancaire américain |
USDriversLicenseNumber |
string |
Numéro de permis de conduire américain |
USIndividualTaxpayerIdentification |
string |
Identification des contribuables individuels américains |
USSocialSecurityNumber |
string |
Numéro de sécurité sociale américain |
USUKPassportNumber |
string |
Numéro de passeport au Royaume-Uni |
ZAIdentificationNumber |
string |
Numéro d’identification ZA |
PiiDomain
Tâche Domaine pour les informations d’identification personnelle
Nom | Type | Description |
---|---|---|
none |
string |
Indique qu’aucun domaine n’est spécifié. |
phi |
string |
Indique que les entités du domaine Informations médicales personnelles doivent être supprimées. |
PiiEntitiesDocumentResult
Contient les résultats des informations d’identification personnelle.
Nom | Type | Description |
---|---|---|
entities |
Entity[] |
Entités reconnues dans le document. |
id |
string |
Identificateur de document unique et non vide. |
redactedText |
string |
Retourne le texte expurgée. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
PiiResult
Contient le PiiResult.
Nom | Type | Description |
---|---|---|
documents |
Réponse par document |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique le modèle utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande. |
PiiTaskParameters
Paramètres pris en charge pour une tâche de reconnaissance d’entités piI.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
domain | none |
Tâche Domaine pour les informations d’identification personnelle |
|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
piiCategories |
Énumération des catégories d’informations personnelles à retourner dans la réponse. |
||
stringIndexType | TextElements_v8 |
StringIndexType à utiliser pour l’analyse. |
PiiTaskResult
Contient la tâche DRO PIIEntityRecognition d’analyse du texte.
Nom | Type | Description |
---|---|---|
kind |
string:
Pii |
Type de résultat de la tâche. |
results |
Liste des résultats pii |
RequestStatistics
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande.
Nom | Type | Description |
---|---|---|
documentsCount |
integer |
Nombre de documents soumis dans la demande. |
erroneousDocumentsCount |
integer |
Nombre de documents non valides. Cela inclut les documents vides, de taille maximale ou de langues non prises en charge. |
transactionsCount |
integer |
Nombre de transactions pour la demande. |
validDocumentsCount |
integer |
Nombre de documents valides. Cela exclut les documents vides, de taille maximale ou de langues non prises en charge. |
SentenceAssessment
Représente une évaluation de phrase et les évaluations ou les objets cibles qui lui sont associés.
Nom | Type | Description |
---|---|---|
confidenceScores |
Représente les scores de confiance dans toutes les classes de sentiments : positif et négatif. |
|
isNegated |
boolean |
Indicateur indiquant si l’évaluation est annulée. |
length |
integer |
Longueur de la cible. |
offset |
integer |
Décalage cible par rapport au début de la phrase. |
sentiment |
Sentiment de la phrase. |
|
text |
string |
Texte cible détecté. |
SentenceSentiment
Sentiment de phrase d’un document.
Nom | Type | Description |
---|---|---|
assessments |
Tableau des évaluations pour la phrase. |
|
confidenceScores |
Score de confiance de sentiment compris entre 0 et 1 pour la phrase pour toutes les classes. |
|
length |
integer |
Longueur de la cible. |
offset |
integer |
Décalage cible par rapport au début de la phrase. |
sentiment |
Sentiment prédit pour la phrase. |
|
targets |
Tableau des cibles de phrase pour la phrase. |
|
text |
string |
Texte de la phrase. |
SentenceSentimentValue
Sentiment prédit pour la phrase.
Nom | Type | Description |
---|---|---|
negative |
string |
Sentiment négatif |
neutral |
string |
Sentiment neutre |
positive |
string |
Sentiment positif |
SentenceTarget
Représente une cible de phrase et les évaluations ou les objets cibles qui lui sont associés.
Nom | Type | Description |
---|---|---|
confidenceScores |
Représente les scores de confiance dans toutes les classes de sentiments : positif et négatif. |
|
length |
integer |
Longueur de la cible. |
offset |
integer |
Décalage cible par rapport au début de la phrase. |
relations |
Tableau d’objets d’évaluation ou cibles liés à la cible. |
|
sentiment |
Sentiment de la phrase. |
|
text |
string |
Texte cible détecté. |
SentimentAnalysisTaskParameters
Paramètres pris en charge pour une tâche d’analyse des sentiments.
Nom | Type | Valeur par défaut | Description |
---|---|---|---|
loggingOptOut |
boolean |
False |
désactivation de la journalisation |
modelVersion |
string |
latest |
version du modèle |
opinionMining |
boolean |
False |
Indique s’il faut ou non utiliser l’exploration des opinions dans la demande. |
stringIndexType | TextElements_v8 |
Spécifie la méthode utilisée pour interpréter les décalages de chaîne. |
SentimentConfidenceScores
Représente les scores de confiance compris entre 0 et 1 dans toutes les classes de sentiments : positif, neutre, négatif.
Nom | Type | Description |
---|---|---|
negative |
number |
Score de confiance pour le sentiment négatif |
neutral |
number |
Score de confiance pour le sentiment neutre |
positive |
number |
Score de confiance pour un sentiment positif |
SentimentDocumentResult
Objet représentant les résultats prédéfinis de l’analyse des sentiments de chaque document.
Nom | Type | Description |
---|---|---|
confidenceScores |
Score de confiance de sentiment compris entre 0 et 1 pour la phrase pour toutes les classes. |
|
id |
string |
Identificateur de document unique et non vide. |
sentences |
Sentiment de phrases du document. |
|
sentiment |
Sentiment prédit pour le document (négatif, neutre, positif ou mixte). |
|
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile du document. |
|
warnings |
Avertissements rencontrés lors du traitement du document. |
SentimentResponse
Résultats de l’analyse des sentiments pour les documents d’entrée.
Nom | Type | Description |
---|---|---|
documents |
Résultats de l’analyse des sentiments pour chaque document dans l’entrée. |
|
errors |
Erreurs par ID de document. |
|
modelVersion |
string |
Ce champ indique le modèle utilisé pour le scoring. |
statistics |
si showStats=true a été spécifié dans la requête, ce champ contient des informations sur la charge utile de la demande. |
SentimentTaskResult
Contient le résultat de la tâche LRO SentimentAnalysis du texte d’analyse.
Nom | Type | Description |
---|---|---|
kind |
string:
Sentiment |
Type de résultat de la tâche. |
results |
Résultats de l’analyse des sentiments |
StringIndexType
Type d’index de chaîne
Nom | Type | Description |
---|---|---|
TextElements_v8 |
string |
Les valeurs de décalage et de longueur retournées correspondent à 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 |
string |
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 |
string |
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 Java, JavaScript. |
TargetConfidenceScoreLabel
Représente les scores de confiance dans toutes les classes de sentiments : positif et négatif.
Nom | Type | Description |
---|---|---|
negative |
number |
Score de confiance pour le sentiment négatif |
positive |
number |
Score de confiance pour un sentiment positif |
TargetRelation
Représente la relation entre les évaluations et/ou les cibles.
Nom | Type | Description |
---|---|---|
ref |
string |
Pointeur JSON indiquant l’objet lié. |
relationType |
Type lié à la cible. |
TargetRelationType
Type lié à la cible.
Nom | Type | Description |
---|---|---|
assessment |
string |
Relation d’évaluation. |
target |
string |
Relation cible. |
TokenSentimentValue
Sentiment prédit pour la phrase.
Nom | Type | Description |
---|---|---|
mixed |
string |
Sentiments mixtes |
negative |
string |
Sentiment négatif |
positive |
string |
Sentiment positif |
WarningCodeValue
Définit la liste des codes d’avertissement.
Nom | Type | Description |
---|---|---|
DocumentTruncated |
string |
Avertissement de document tronqué |
LongWordsInDocument |
string |
Avertissement de mots longs dans le document |