Text Analysis Runtime - Analyze Text

Service:

Azure AI Services

Version d'API:

2024-11-01

Demander une analyse de texte sur une collection de documents.

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

Avec des paramètres facultatifs:

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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.
showStats	query		boolean	(Facultatif) si la valeur est true, la réponse contient des statistiques au niveau de la demande et du document.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
AnalyzeTextEntityLinkingInput	Contient l’entrée de liaison d’entité de texte d’analyse.
AnalyzeTextEntityRecognitionInput	La reconnaissance d’entité analyse la demande de tâche d’entrée de texte.
AnalyzeTextKeyPhraseExtractionInput	Contient l’entrée de tâche d’analyse KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contient l’entrée de tâche d’analyse de document de détection de langue.
AnalyzeTextPiiEntitiesRecognitionInput	Contient l’entrée de tâche d’analyse PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contient l’entrée de tâche SentimentAnalysis de texte d’analyse.

AnalyzeTextEntityLinkingInput

Contient l’entrée de liaison d’entité de texte d’analyse.

Nom	Obligatoire	Type	Description
kind	True	string: EntityLinking	Type de tâche à effectuer.
analysisInput		MultiLanguageAnalysisInput	Contient l’entrée d’analyse à gérer par le service.
parameters		EntityLinkingTaskParameters	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: EntityRecognition	Type de tâche à effectuer.
analysisInput		MultiLanguageAnalysisInput	Entrée à analyser.
parameters		EntitiesTaskParameters	Paramètres de tâche.

AnalyzeTextKeyPhraseExtractionInput

Contient l’entrée de tâche d’analyse KeyPhraseExtraction.

Nom	Obligatoire	Type	Description
kind	True	string: KeyPhraseExtraction	Type de tâche à effectuer.
analysisInput		MultiLanguageAnalysisInput	Contient les documents d’entrée.
parameters		KeyPhraseTaskParameters	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: LanguageDetection	Type de tâche à effectuer.
analysisInput		LanguageDetectionAnalysisInput	Documents à analyser.
parameters		LanguageDetectionTaskParameters	paramètres de tâche.

AnalyzeTextPiiEntitiesRecognitionInput

Contient l’entrée de tâche d’analyse PIIEntityRecognition.

Nom	Obligatoire	Type	Description
kind	True	string: PiiEntityRecognition	Type de tâche à effectuer.
analysisInput		MultiLanguageAnalysisInput	Contient les documents d’entrée.
parameters		PiiTaskParameters	Paramètres de tâche Pii.

AnalyzeTextSentimentAnalysisInput

Contient l’entrée de tâche SentimentAnalysis de texte d’analyse.

Nom	Obligatoire	Type	Description
kind	True	string: SentimentAnalysis	Type de tâche à effectuer.
analysisInput		MultiLanguageAnalysisInput	Contient les documents d’entrée.
parameters		SentimentAnalysisTaskParameters	Paramètres de tâche Analyse des sentiments.

Réponses

Nom	Type	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	La demande a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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

Code d’état:

200

{
  "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"
  }
}

SuccessfulEntityRecognitionExclusionRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Exemple de réponse

Code d’état:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Exemple de réponse

Code d’état:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Exemple de réponse

Code d’état:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Exemple de réponse

Code d’état:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Exemple de réponse

Code d’état:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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

Code d’état:

200

{
  "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

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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

Code d’état:

200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi",
          "scriptName": "Latin",
          "scriptIso15924Code": "Latn"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-12-01"
  }
}

SuccessfulPiiEntityRecognitionRequest

Exemple de requête

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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

Code d’état:

200

{
  "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

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2024-11-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

Code d’état:

200

{
  "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
AgeMetadata	Représente le modèle de métadonnées d’entité Age.
AgeUnit	Unité d’âge de mesure
AllowOverlapEntityPolicyType	Représente la stratégie de chevauchement d’autorisation. Applique aucune logique de post-traitement pour les entités. Quel que soit le modèle prédit, c’est ce qui sera retourné à l’utilisateur. Cela permet à l’utilisateur d’obtenir une vue complète des valeurs possibles de chaque modèle unique et d’appliquer sa propre logique personnalisée à la sélection d’entités
AnalyzeTextEntityLinkingInput	Contient l’entrée de liaison d’entité de texte d’analyse.
AnalyzeTextEntityRecognitionInput	La reconnaissance d’entité analyse la demande de tâche d’entrée de texte.
AnalyzeTextKeyPhraseExtractionInput	Contient l’entrée de tâche d’analyse KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contient l’entrée de tâche d’analyse de document de détection de langue.
AnalyzeTextPiiEntitiesRecognitionInput	Contient l’entrée de tâche d’analyse PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contient l’entrée de tâche SentimentAnalysis de texte d’analyse.
AnalyzeTextTaskKind	Type des tâches d’analyse de texte prises en charge.
AnalyzeTextTaskResultsKind	Type de l’objet de réponse retourné par la tâche de texte d’analyse.
AreaMetadata	Représente le modèle de métadonnées d’entité de zone.
AreaUnit	Unité de mesure de zone.
CurrencyMetadata	Représente le modèle de métadonnées d’entité Currency ).
DateMetadata	Métadonnées pour les instances d’entité de date.
DateTimeMetadata	Métadonnées pour les instances d’entité datetime.
DateValue	Représente la valeur de date.
DetectedLanguage	Contient les détails de la langue détectée pour le texte.
DocumentError	Contient les détails des erreurs rencontrées pendant l’exécution d’un travail.
DocumentSentimentValue	Sentiment prédit pour le document (négatif, neutre, positif ou mixte).
DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
DocumentWarning	Contient l’objet d’avertissements avec des avertissements rencontrés pour le document traité.
EntitiesDocumentResultWithMetadata	Résultat des documents d’entité avec des métadonnées.
EntitiesResult	Contient le résultat de la tâche de reconnaissance d’entité.
EntitiesTaskParameters	Paramètres pris en charge pour une tâche De reconnaissance d’entité.
EntitiesTaskResult	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és, etc.
EntityCategory	Contient toutes les catégories d’entités détectées par la reconnaissance d’entité.
EntityInferenceOptions	Classe qui héberge les options d’inférence autorisées pour la reconnaissance d’entité nommée.
EntityLinkingResult	Résultat de la liaison d’entité.
EntityLinkingTaskParameters	Paramètres pris en charge pour une tâche de liaison d’entité.
EntityLinkingTaskResult	Contient le résultat de la tâche de liaison d’entité de texte d’analyse.
EntityTag	Objet d’étiquette d’entité qui contient le nom des balises abd tout score de confiance associé. Les balises d’entité sont utilisées pour exprimer certaines similitudes/affinités entre les entités.
EntityWithMetadata	Objet d’entité avec des balises et des métadonnées.
Error	Objet de réponse d’erreur retourné lorsque le service rencontre des erreurs pendant le traitement de la demande.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InformationMetadata	Représente le modèle de métadonnées d’entité Information (données).
InformationUnit	Unité d’information (données) de mesure.
InnerErrorCode	Code d’erreur lisible par l’homme.
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.
KeyPhraseResult	Contient keyPhraseResult.
KeyPhrasesDocumentResult	Contient les résultats de l’extraction d’expressions clés pour un document.
KeyPhraseTaskParameters	Paramètres pris en charge pour une tâche d’extraction d’expressions clés.
KeyPhraseTaskResult	Contient le résultat de la tâche d’analyse KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contient l’entrée d’analyse de document de détection de langue.
LanguageDetectionDocumentResult	Contient la détection de langue d’un document.
LanguageDetectionResult	Contient le résultat de la détection de langue pour la requête.
LanguageDetectionTaskParameters	Paramètres pris en charge pour une tâche de détection de langue.
LanguageDetectionTaskResult	Contient le résultat de la tâche de détection de langue pour la requête.
LanguageInput	Contient l’entrée de détection de langue.
LengthMetadata	Représente le modèle de métadonnées de l’entité Length.
LengthUnit	Unité de longueur de mesure.
LinkedEntitiesDocumentResult	Résultat du document de liaison d’entité.
LinkedEntity	Objet LinkedEntity contenant l’entité détectée avec les sources/liens associés.
Match	Objet Match contenant le texte d’entité détecté avec le décalage et la longueur.
MatchLongestEntityPolicyType	Représente la stratégie de chevauchement la plus longue correspondance. Aucune entité qui se chevauche autant qu’il est possible. 1. S’il existe des entités qui se chevauchent, la plus longue est retournée. 2. Si l’ensemble de caractères prédit pour 2 entités ou plus est exactement le même, sélectionnez l’entité dont le score de confiance est supérieur.3. Si les scores d’entité sont identiques, retournez toutes les entités qui sont toujours présentes après l’application des règles précédentes. 3. S’il existe un chevauchement partiel (comme dans Hello Text Analytics) suivez les étapes ci-dessus à partir de 1.
MetadataKind	Type d’objet Metadata d’entité.
MultiLanguageAnalysisInput	Collection de documents d’entrée à analyser par le service.
MultiLanguageInput	Contient un document d’entrée à analyser par le service.
NumberKind	Type de l’entité de nombre extrait.
NumberMetadata	Métadonnées pour les instances d’entité numérique.
NumericRangeMetadata	représente les métadonnées des intervalles numériques.
OrdinalMetadata	Métadonnées pour les instances d’entité numérique.
PiiCategory	(Facultatif) décrit les catégories d’informations personnelles à retourner
PiiDomain	Domaine pour la tâche PII
PiiEntitiesDocumentResult	Contient les résultats des informations d’identification personnelle.
PiiResult	Contient le PiiResult.
PiiTaskParameters	Paramètres pris en charge pour une tâche de reconnaissance des entités PII.
PiiTaskResult	Contient la tâche LRO d’analyse piiEntityRecognition.
RangeInclusivity	Inclusion de la plage de cette propriété de propriété.
RangeKind	Type de l’entité de plage de nombres.
RelativeTo	Point de référence que le nombre ordinal désigne.
RequestStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.
ScriptCode	Identifie le script du document d’entrée. Mappe au code de script standard ISO 15924.
ScriptKind	Identifie le script du document d’entrée. Correspond au nom formel standard ISO 15924.
SentenceAssessment	Représente une évaluation de phrase et les évaluations ou les objets cibles associés.
SentenceSentiment	Sentiment de phrase d’un document.
SentenceSentimentValue	Sentiment prédit pour la phrase.
SentenceTarget	Représente une cible de phrase et les évaluations ou les objets cibles associés.
SentimentAnalysisTaskParameters	Paramètres pris en charge pour une tâche Analyse des sentiments.
SentimentConfidenceScores	Représente les scores de confiance compris entre 0 et 1 dans toutes les classes de sentiment : positif, neutre, négatif.
SentimentDocumentResult	Objet représentant les résultats prédéfinis de l’analyse des sentiments de chaque document.
SentimentResponse	Résultats de l’analyse des sentiments pour les documents d’entrée.
SentimentTaskResult	Contient le résultat de la tâche SentimentAnalysis LRO d’analyse de texte.
SpeedMetadata	Représente le modèle de métadonnées de l’entité Speed.
SpeedUnit	Unité de mesure de vitesse
StringIndexType	Type d’index de chaîne
TargetConfidenceScoreLabel	Représente les scores de confiance dans toutes les classes de sentiment : positifs et négatifs.
TargetRelation	Représente la relation entre les évaluations et/ou les cibles.
TargetRelationType	Type lié à la cible.
TemperatureMetadata	Représente le modèle de métadonnées d’entité Information.
TemperatureUnit	Unité de température de mesure.
TemporalModifier	Modificateur facultatif d’une instance de date/heure.
TemporalSetMetadata	Métadonnées pour les instances d’entité de jeu temporel.
TemporalSpanMetadata	représente les métadonnées d’une période de date et/ou d’heure.
TemporalSpanValues	Objet d’étendue temporelle.
TimeMetadata	Métadonnées pour les instances d’entité de temps.
TokenSentimentValue	Sentiment prédit pour la phrase.
VolumeMetadata	Représente le modèle de métadonnées d’entité de volume.
VolumeUnit	Unité de mesure du volume
WarningCodeValue	Définit la liste des codes d’avertissement.
WeightMetadata	Représente le modèle de métadonnées d’entité Weight ).
WeightUnit	Unité de mesure de poids.

AgeMetadata

Représente le modèle de métadonnées d’entité Age.

Nom	Type	Description
metadataKind	string: AgeMetadata	Type d’objet Metadata d’entité.
unit	AgeUnit	Unité de mesure pour l’âge.
value	number	Valeur numérique que le texte extrait désigne.

AgeUnit

Unité d’âge de mesure

Nom	Type	Description
Day	string	Période d’un jour
Month	string	Période d’un mois
Unspecified	string	Période non spécifiée
Week	string	Période d’une semaine
Year	string	Période d’un an

AllowOverlapEntityPolicyType

Représente la stratégie de chevauchement d’autorisation. Applique aucune logique de post-traitement pour les entités. Quel que soit le modèle prédit, c’est ce qui sera retourné à l’utilisateur. Cela permet à l’utilisateur d’obtenir une vue complète des valeurs possibles de chaque modèle unique et d’appliquer sa propre logique personnalisée à la sélection d’entités

Nom	Type	Valeur par défaut	Description
policyKind	string: allowOverlap	matchLongest	Type d’objet OverlapPolicy de l’entité.

AnalyzeTextEntityLinkingInput

Contient l’entrée de liaison d’entité de texte d’analyse.

Nom	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contient l’entrée d’analyse à gérer par le service.
kind	string: EntityLinking	Type de tâche à effectuer.
parameters	EntityLinkingTaskParameters	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	MultiLanguageAnalysisInput	Entrée à analyser.
kind	string: EntityRecognition	Type de tâche à effectuer.
parameters	EntitiesTaskParameters	Paramètres de tâche.

AnalyzeTextKeyPhraseExtractionInput

Contient l’entrée de tâche d’analyse KeyPhraseExtraction.

Nom	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contient les documents d’entrée.
kind	string: KeyPhraseExtraction	Type de tâche à effectuer.
parameters	KeyPhraseTaskParameters	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	Type	Description
analysisInput	LanguageDetectionAnalysisInput	Documents à analyser.
kind	string: LanguageDetection	Type de tâche à effectuer.
parameters	LanguageDetectionTaskParameters	paramètres de tâche.

AnalyzeTextPiiEntitiesRecognitionInput

Contient l’entrée de tâche d’analyse PIIEntityRecognition.

Nom	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contient les documents d’entrée.
kind	string: PiiEntityRecognition	Type de tâche à effectuer.
parameters	PiiTaskParameters	Paramètres de tâche Pii.

AnalyzeTextSentimentAnalysisInput

Contient l’entrée de tâche SentimentAnalysis de texte d’analyse.

Nom	Type	Description
analysisInput	MultiLanguageAnalysisInput	Contient les documents d’entrée.
kind	string: SentimentAnalysis	Type de tâche à effectuer.
parameters	SentimentAnalysisTaskParameters	Paramètres de tâche Analyse des sentiments.

AnalyzeTextTaskKind

Type des 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 d’expressions 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 de texte d’analyse.

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

AreaMetadata

Représente le modèle de métadonnées d’entité de zone.

Nom	Type	Description
metadataKind	string: AreaMetadata	Type d’objet Metadata d’entité.
unit	AreaUnit	Unité de mesure pour la zone.
value	number	Valeur numérique que le texte extrait désigne.

AreaUnit

Unité de mesure de zone.

Nom	Type	Description
Acre	string	Unité de superficie en acres
SquareCentimeter	string	Unité de zone en centimètres carrés
SquareDecameter	string	Unité de zone dans les décamètres carrés
SquareDecimeter	string	Unité de zone en déccimètres carrés
SquareFoot	string	Unité de zone en pieds carrés
SquareHectometer	string	Unité de zone dans les hectomètres carrés
SquareInch	string	Unité de zone en pouces carrés
SquareKilometer	string	Unité de zone en kilomètres carrés
SquareMeter	string	Unité de zone en mètres carrés
SquareMile	string	Unité de zone en milles carrés
SquareMillimeter	string	Unité de zone en millimètres carrés
SquareYard	string	Unité de zone dans les cours carrées
Unspecified	string	Unité de zone non spécifiée

CurrencyMetadata

Représente le modèle de métadonnées d’entité Currency ).

Nom	Type	Description
iso4217	string	Code alphabétique basé sur une autre norme ISO, ISO 3166, qui répertorie les codes des noms de pays. Les deux premières lettres du code à trois lettres ISO 4217 sont identiques au code du nom du pays, et, dans la mesure du possible, la troisième lettre correspond à la première lettre du nom de la devise.
metadataKind	string: CurrencyMetadata	Type d’objet Metadata d’entité.
unit	string	Unité monétaire.
value	number	Valeur numérique que le texte extrait désigne.

DateMetadata

Métadonnées pour les instances d’entité de date.

Nom	Type	Description
dateValues	DateValue[]	Liste des valeurs de date.
metadataKind	string: DateMetadata	Type d’objet Metadata d’entité.

DateTimeMetadata

Métadonnées pour les instances d’entité datetime.

Nom	Type	Description
dateValues	DateValue[]	Liste des valeurs de date.
metadataKind	string: DateTimeMetadata	Type d’objet Metadata d’entité.

DateValue

Représente la valeur de date.

Nom	Type	Description
modifier	TemporalModifier	Modificateur pour datetime pour indiquer le point de référence comme avant, après, etc.
timex	string	Représentation de date/heure ISO 8601 étendue, comme décrit dans (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Heure réelle que le texte extrait désigne.

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. Les scores proches de 1 indiquent 100% certitude que la langue identifiée est vraie.
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).
scriptIso15924Code	ScriptCode	Identifie le code de script du document d’entrée conformément à la norme ISO 15924.
scriptName	ScriptKind	Identifie le nom de script du document d’entrée conformément à la norme ISO 15924.

DocumentError

Contient les détails des erreurs rencontrées pendant l’exécution d’un travail.

Nom	Type	Description
error	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	Instruction négative
neutral	string	Instruction neutre
positive	string	Instruction positive

DocumentStatistics

si showStats=true a été spécifié dans la requête que 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 d’avertissements avec des avertissements rencontrés pour le document traité.

Nom	Type	Description
code	WarningCodeValue	Code d’avertissement.
message	string	Message d’avertissement.
targetRef	string	Référence de pointeur JSON indiquant l’objet cible.

EntitiesDocumentResultWithMetadata

Résultat des documents d’entité avec des métadonnées.

Nom	Type	Description
entities	EntityWithMetadata[]	Entités reconnues dans le document.
id	string	Identificateur de document unique et non vide.
statistics	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	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	EntitiesDocumentResultWithMetadata[]	Réponse par document
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que 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
exclusionList	EntityCategory[]		(Facultatif) paramètre de requête qui filtre toutes les entités incluses dans excludeList. Lorsqu’un utilisateur spécifie une excludeList, il ne peut pas obtenir une prédiction retournée avec une entité dans cette liste. Nous appliquerons inclusionList avant exclusionList
inclusionList	EntityCategory[]		(Facultatif) paramètre de requête qui limite la sortie aux types d’entités demandés inclus dans cette liste. Nous appliquerons inclusionList avant exclusionList
inferenceOptions	EntityInferenceOptions		(Facultatif) paramètre de requête qui permet à l’utilisateur de fournir des paramètres pour l’exécution de l’inférence.
loggingOptOut	boolean	False	désactivation de la déconnexion
modelVersion	string	latest	version du modèle
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Facultatif) décrit le type de stratégie de chevauchement à appliquer à la sortie du ner.
stringIndexType	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).

EntitiesTaskResult

Contient la tâche d’entité

Nom	Type	Description
kind	string: EntityRecognitionResults	Type de résultat de tâche.
results	EntitiesResult	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és, 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 d’entité tel qu’il apparaît dans la requête.

EntityCategory

Contient toutes les catégories d’entités détectées par la reconnaissance d’entité.

Nom	Type	Description
Address	string	Mentions spécifiques au niveau de la rue des emplacements : numéros de maison/bâtiment, rues, avenues, autoroutes, intersections référencées par nom.
Age	string	Valeurs liées à l’âge.
Airport	string	Aéroports.
Area	string	Zone d’un objet.
City	string	Valeurs liées à la ville.
ComputingProduct	string	Produits informatiques.
Continent	string	Valeurs liées au continent.
CountryRegion	string	Valeurs relatives au pays ou à la région.
CulturalEvent	string	Valeurs liées aux événements culturels.
Currency	string	Valeurs liées à la devise.
Date	string	Dates du calendrier.
DateRange	string	Plage de dates.
DateTime	string	Dates de calendrier avec heure.
DateTimeRange	string	Plage de dates et d’heure.
Dimension	string	Dimension des mesures
Duration	string	Durée.
Email	string	Adresses e-mail.
Event	string	Social, sports, business, politique, éducatif, naturel, historique, criminel, violent, légal, militaire avec une période prolongée.
GPE	string	Villes, pays/régions, états.
Geological	string	Caractéristiques géographiques et naturelles telles que les rivières, les océans et les déserts.
Height	string	Hauteur d’un objet.
IP	string	adresses IP réseau.
Information	string	Unité de mesure pour les informations numériques.
Length	string	Longueur d’un objet.
Location	string	Point ou emplacement particulier dans l’espace physique.
NaturalEvent	string	Valeurs naturelles liées aux événements.
Number	string	Nombres sans unité
NumberRange	string	Plage de nombres
Numeric	string	Valeurs numériques, y compris les chiffres et les mots numériques.
Ordinal	string	Nombres ordinaux.
Organization	string	Sociétés, agences et autres groupes de personnes définis par une structure organisationnelle établie. Ces étiquettes peuvent inclure des entreprises, des partis politiques/mouvements, des groupes musicaux, des clubs sportifs, des organismes gouvernementaux et des organisations publiques. Les nationalités ou religions ne sont pas ORGANISATION.
OrganizationMedical	string	Sociétés médicales et groupes.
OrganizationSports	string	Organisations sportives.
OrganizationStockExchange	string	Groupes boursiers.
Percentage	string	Valeurs liées au pourcentage.
Person	string	Prénom, dernier et prénom, noms de personnages fictifs et alias. Titres, tels que « Mr. » ou « Président », ne sont pas considérés comme faisant partie de l’entité nommée.
PersonType	string	Rôles humains classés par appartenance à un groupe.
PhoneNumber	string	Numéros de téléphone (numéros de téléphone des États-Unis et de l’UE uniquement).
Product	string	Groupe ou unique d’objets commerciaux, consommables, électronique, véhicules, groupes alimentaires.
SetTemporal	string	Ensemble de valeurs liées à l’heure.
Skill	string	Une capacité, une compétence ou une expertise.
Speed	string	Vitesse d’un objet.
SportsEvent	string	Valeurs liées aux événements sportifs.
State	string	Valeurs liées à l’état.
Structural	string	Structures mandéfines.
Temperature	string	Valeurs liées à la température.
Temporal	string	Éléments relatifs à l’heure.
Time	string	Heures de la journée.
TimeRange	string	Intervalles de temps.
URL	string	URL des sites web.
Volume	string	Volume d’un objet.
Weight	string	Poids d’un objet.

EntityInferenceOptions

Classe qui héberge les options d’inférence autorisées pour la reconnaissance d’entité nommée.

Nom	Type	Valeur par défaut	Description
excludeNormalizedValues	boolean	False	Option permettant d’inclure/exclure les valeurs d’entité détectées à normaliser et d’inclure dans les métadonnées. Les types d’entités numériques et temporelles prennent en charge la normalisation des valeurs.

EntityLinkingResult

Résultat de la liaison d’entité.

Nom	Type	Description
documents	LinkedEntitiesDocumentResult[]	Réponse par document
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que 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é.

Nom	Type	Valeur par défaut	Description
loggingOptOut	boolean	False	désactivation de la déconnexion
modelVersion	string	latest	version du modèle
stringIndexType	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: EntityLinkingResults	Type de résultat de tâche.
results	EntityLinkingResult	Résultat de la liaison d’entité.

EntityTag

Objet d’étiquette d’entité qui contient le nom des balises abd tout score de confiance associé. Les balises d’entité sont utilisées pour exprimer certaines similitudes/affinités entre les entités.

Nom	Type	Description
confidenceScore	number	Score de détection compris entre 0 et 1 de l’entité extraite.
name	string	Nom de la balise. Les noms des balises d’entité seront uniques globalement.

EntityWithMetadata

Objet d’entité avec des balises et des métadonnées.

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.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Objet de métadonnées d’entité.
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é.
tags	EntityTag[]	Liste des balises d’entité. Les balises doivent exprimer certaines similitudes/affinités entre les entités.
text	string	Texte d’entité tel qu’il apparaît dans la requête.
type	string	Un type d’entité est la granularité la plus basse (ou la plus fine) à laquelle l’entité a été détectée. Le type est mappé aux attributs de métadonnées spécifiques associés à l’entité détectée.

Error

Objet de réponse d’erreur retourné lorsque le service rencontre des erreurs pendant le traitement de la demande.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
AzureCognitiveSearchIndexLimitReached	string	Erreur atteinte à la limite d’index Recherche cognitive Azure
AzureCognitiveSearchIndexNotFound	string	Erreur introuvable dans l’index Recherche cognitive Azure
AzureCognitiveSearchNotFound	string	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchThrottling	string	Erreur de limitation de Recherche cognitive Azure
Conflict	string	Erreur de conflit
Forbidden	string	Erreur d’accès interdit
InternalServerError	string	Erreur de serveur interne
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 de projet introuvable
QuotaExceeded	string	Erreur de dépassement du quota
ServiceUnavailable	string	Erreur d’indisponibilité du service
Timeout	string	Erreur de délai d’expiration
TooManyRequests	string	Trop d’erreurs 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	Error	Objet d’erreur.

InformationMetadata

Représente le modèle de métadonnées d’entité Information (données).

Nom	Type	Description
metadataKind	string: InformationMetadata	Type d’objet Metadata d’entité.
unit	InformationUnit	Unité de mesure pour obtenir des informations.
value	number	Valeur numérique que le texte extrait désigne.

InformationUnit

Unité d’information (données) de mesure.

Nom	Type	Description
Bit	string	Unité de taille de données en bits
Byte	string	Unité de taille de données en octets
Gigabit	string	Unité de taille de données en gigaoctets
Gigabyte	string	Unité de taille de données en gigaoctets
Kilobit	string	Unité de taille de données en kilobits
Kilobyte	string	Unité de taille de données en kilo-octets
Megabit	string	Unité de taille de données en mégabits
Megabyte	string	Unité de taille de données en mégaoctets
Petabit	string	Unité de taille de données dans pétabits
Petabyte	string	Unité de taille de données en pétaoctets
Terabit	string	Unité de taille de données en térabits
Terabyte	string	Unité de taille de données en téraoctets
Unspecified	string	Unité de taille de données non spécifiée

InnerErrorCode

Code d’erreur lisible par l’homme.

Nom	Type	Description
AzureCognitiveSearchNotFound	string	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchThrottling	string	Erreur de limitation de Recherche cognitive Azure
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 introuvable dans la base de connaissances
MissingInputDocuments	string	Erreur des documents d’entrée manquants
ModelVersionIncorrect	string	Erreur incorrecte de version 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	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	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 keyPhraseResult.

Nom	Type	Description
documents	KeyPhrasesDocumentResult[]	Réponse par document
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.

KeyPhrasesDocumentResult

Contient les résultats de l’extraction d’expressions 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	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	Avertissements rencontrés lors du traitement du document.

KeyPhraseTaskParameters

Paramètres pris en charge pour une tâche d’extraction d’expressions clés.

Nom	Type	Valeur par défaut	Description
loggingOptOut	boolean	False	désactivation de la déconnexion
modelVersion	string	latest	version du modèle

KeyPhraseTaskResult

Contient le résultat de la tâche d’analyse KeyPhraseExtraction.

Nom	Type	Description
kind	string: KeyPhraseExtractionResults	Type de résultat de tâche.
results	KeyPhraseResult	Liste des résultats d’extraction d’expressions clés

LanguageDetectionAnalysisInput

Contient l’entrée d’analyse de document de détection de langue.

Nom	Type	Description
documents	LanguageInput[]	Liste des documents à analyser.

LanguageDetectionDocumentResult

Contient la détection de langue d’un document.

Nom	Type	Description
detectedLanguage	DetectedLanguage	Langue détectée.
id	string	Identificateur de document unique et non vide.
statistics	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	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	LanguageDetectionDocumentResult[]	Énumération des résultats de détection de langue pour chaque document d’entrée.
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.

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 déconnexion
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: LanguageDetectionResults	Type de résultat de tâche.
results	LanguageDetectionResult	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 linguistique du texte.
id	string	Identificateur de document unique et non vide.
text	string	Texte d’entrée à traiter.

LengthMetadata

Représente le modèle de métadonnées de l’entité Length.

Nom	Type	Description
metadataKind	string: LengthMetadata	Type d’objet Metadata d’entité.
unit	LengthUnit	Unité de mesure pour la longueur.
value	number	Valeur numérique que le texte extrait désigne.

LengthUnit

Unité de longueur de mesure.

Nom	Type	Description
Centimeter	string	Unité de longueur en centimètres.
Decameter	string	Unité de longueur en décamètres.
Decimeter	string	Unité de longueur en décmètres.
Foot	string	Unité de longueur en pieds.
Hectometer	string	Unité de longueur dans les hectomètres.
Inch	string	Unité de longueur en pouces.
Kilometer	string	Unité de longueur en kilomètres.
LightYear	string	Unité de longueur en années légères.
Meter	string	Unité de longueur en mètres.
Micrometer	string	Unité de longueur en micromètres.
Mile	string	Unité de longueur en miles.
Millimeter	string	Unité de longueur en millimètres.
Nanometer	string	Unité de longueur en nanomètres.
Picometer	string	Unité de longueur dans les picomètres.
Point	string	Unité de longueur en points.
Unspecified	string	Unité de longueur non spécifiée.
Yard	string	Unité de longueur dans les cours.

LinkedEntitiesDocumentResult

Résultat du document de liaison d’entité.

Nom	Type	Description
entities	LinkedEntity[]	Entités connues reconnues dans le document.
id	string	Identificateur de document unique et non vide.
statistics	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	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[]	La liste des instances que cette entité apparaît dans le texte.
name	string	Nom formel de liaison d’entité.
url	string	URL de la page de l’entité à partir de la source de données.

Match

Objet Match contenant le texte d’entité détecté avec le décalage et la longueur.

Nom	Type	Description
confidenceScore	number	Si un élément bien 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 du texte de correspondance d’entité.
text	string	Texte d’entité tel qu’il apparaît dans la requête.

MatchLongestEntityPolicyType

Représente la stratégie de chevauchement la plus longue correspondance. Aucune entité qui se chevauche autant qu’il est possible. 1. S’il existe des entités qui se chevauchent, la plus longue est retournée. 2. Si l’ensemble de caractères prédit pour 2 entités ou plus est exactement le même, sélectionnez l’entité dont le score de confiance est supérieur.3. Si les scores d’entité sont identiques, retournez toutes les entités qui sont toujours présentes après l’application des règles précédentes. 3. S’il existe un chevauchement partiel (comme dans Hello Text Analytics) suivez les étapes ci-dessus à partir de 1.

Nom	Type	Valeur par défaut	Description
policyKind	string: matchLongest	matchLongest	Type d’objet OverlapPolicy de l’entité.

MetadataKind

Type d’objet Metadata d’entité.

Nom	Type	Description
AgeMetadata	string	Métadonnées pour les valeurs liées à l’âge.
AreaMetadata	string	Métadonnées pour les valeurs liées à la zone.
CurrencyMetadata	string	Métadonnées pour les valeurs liées à la devise.
DateMetadata	string	Métadonnées pour les valeurs liées à la date.
DateTimeMetadata	string	Métadonnées pour les valeurs liées à la date et à l’heure.
InformationMetadata	string	Métadonnées pour les valeurs liées aux informations.
LengthMetadata	string	Métadonnées pour les valeurs liées à la longueur.
NumberMetadata	string	Métadonnées pour les valeurs numériques.
NumericRangeMetadata	string	Métadonnées pour les valeurs de plage numérique.
OrdinalMetadata	string	Métadonnées pour les nombres ordinaux.
SpeedMetadata	string	Métadonnées pour les valeurs liées à la vitesse.
TemperatureMetadata	string	Métadonnées pour les valeurs liées à la température.
TemporalSetMetadata	string	Métadonnées pour l’ensemble de valeurs liées au temps.
TemporalSpanMetadata	string	Métadonnées pour les valeurs d’étendue temporelle.
TimeMetadata	string	Métadonnées pour les valeurs liées au temps.
VolumeMetadata	string	Métadonnées pour les valeurs liées au volume.
WeightMetadata	string	Métadonnées pour les valeurs liées à la pondération.

MultiLanguageAnalysisInput

Collection de documents d’entrée à analyser par le service.

Nom	Type	Description
documents	MultiLanguageInput[]	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 de 2 lettres d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut. (Le code suivant s’applique uniquement à 2023-04-15-preview et versions ultérieures) Pour la détection automatique de la langue, utilisez « auto ». Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
text	string	Texte d’entrée à traiter.

NumberKind

Type de l’entité de nombre extrait.

Nom	Type	Description
Decimal	string	Nombre décimal
Fraction	string	Nombre de fractions
Integer	string	Nombre entier
Percent	string	Nombre de pourcentages
Power	string	Numéro d’alimentation
Unspecified	string	Type de nombre non spécifié

NumberMetadata

Métadonnées pour les instances d’entité numérique.

Nom	Type	Description
metadataKind	string: NumberMetadata	Type d’objet Metadata d’entité.
numberKind	NumberKind	Type du type de nombre.
value	number	Représentation numérique de ce que le texte extrait désigne.

NumericRangeMetadata

représente les métadonnées des intervalles numériques.

Nom	Type	Description
maximum	number	Valeur de fin de l’intervalle.
metadataKind	string: NumericRangeMetadata	Type d’objet Metadata d’entité.
minimum	number	Valeur de début de l’intervalle.
rangeInclusivity	RangeInclusivity	L’inclusion de cette plage.
rangeKind	RangeKind	Type de plages numériques prises en charge : nombre, vitesse, etc.

OrdinalMetadata

Métadonnées pour les instances d’entité numérique.

Nom	Type	Description
metadataKind	string: OrdinalMetadata	Type d’objet Metadata d’entité.
offset	string	Décalage par rapport à la référence (par exemple, offset = -1 indique la seconde à la dernière)
relativeTo	RelativeTo	Point de référence que le nombre ordinal désigne.
value	string	Expression arithmétique simple que l’ordinal désigne.

PiiCategory

(Facultatif) décrit les catégories d’informations personnelles à 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 d’AU
AUCompanyNumber	string	Numéro d’entreprise d’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	Âge
All	string	Toutes les catégories d’informations personnelles.
AzureDocumentDBAuthKey	string	Clé d’authentification Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Connexion à la base de données Azure IAAS et chaîne SQL
AzureIoTConnectionString	string	Chaîne de connexion Azure IoT
AzurePublishSettingPassword	string	Mot de passe du paramètre de publication Azure
AzureRedisCacheString	string	Chaîne du cache Redis Azure
AzureSAS	string	SAP Azure
AzureServiceBusString	string	Chaîne Azure Service Bus
AzureStorageAccountGeneric	string	Compte de stockage Azure générique
AzureStorageAccountKey	string	Clé de compte de stockage Azure
BENationalNumber	string	BE National Number
BENationalNumberV2	string	BE National Number 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 du pilote d’autorité de certification
CAHealthServiceNumber	string	Numéro du service d’intégrité de l’autorité de certification
CAPassportNumber	string	Numéro de passeport d’autorité de certification
CAPersonalHealthIdentification	string	Identification de l’intégrité personnelle de l’autorité de certification
CASocialInsuranceNumber	string	Numéro d’assurance sociale de l’AUTORITÉ de certification
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é résidente CN
CYIdentityCard	string	Carte d’identité CY
CYTaxIdentificationNumber	string	Numéro d’identification fiscale CY
CZPersonalIdentityNumber	string	Numéro d’identité personnelle 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	Identification personnelle DK 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 des drogues
EEPersonalIdentificationCode	string	Code d’identification personnelle 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 de l’UE
EUDriversLicenseNumber	string	Numéro de permis de conduire de l’UE
EUGPSCoordinates	string	Coordonnées GPS de l’UE
EUNationalIdentificationNumber	string	Numéro d’identification national de l’UE
EUPassportNumber	string	Numéro de passeport de l’UE
EUSocialSecurityNumber	string	Numéro de sécurité sociale de l’UE
EUTaxIdentificationNumber	string	Numéro d’identification fiscale de l’UE
Email	string	Messagerie électronique
FIEuropeanHealthNumber	string	Numéro de santé européen FI
FINationalID	string	FI National ID
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	Numéro fi Passport
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 fr Passport
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’ID national RH
HRPersonalIdentificationNumber	string	Numéro d’identification personnelle RH
HRPersonalIdentificationOIBNumberV2	string	Numéro OIB d’identification personnelle RH V2
HUPersonalIdentificationNumber	string	Numéro d’identification personnelle 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é d’ID
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	Compte permanent IN
INUniqueIdentificationNumber	string	Numéro d’identification unique IN
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 des résidents JP
JPSocialInsuranceNumber	string	Numéro d’assurance sociale JP
KRResidentRegistrationNumber	string	Numéro d’inscription des résidents KR
LTPersonalCode	string	Code personnel LT
LUNationalIdentificationNumberNatural	string	Numéro d’identification national lu naturel
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’IDENTIFICATION fiscale MT
MYIdentityCardNumber	string	Numéro de ma carte d’identité
NLCitizensServiceNumber	string	Numéro de service des citoyens NL
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	NZ Bank Account Number
NZDriversLicenseNumber	string	Numéro de permis de conduire NZ
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	NZ Ministry Of Health Number
NZSocialWelfareNumber	string	NZ Social Welfare Number
Organization	string	Organisation
PHUnifiedMultiPurposeIDNumber	string	Numéro d’ID multi-usage unifié PH
PLIdentityCard	string	Carte d’identité PL
PLNationalID	string	PL National ID
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Numéro pl Passport
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	RU Passport Number 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	SWIFT Code
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 tw Passport
TWResidentCertificate	string	Certificat résident TW
UAPassportNumberDomestic	string	Numéro de passeport d’UA national
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	Numéro de permis de conduire du Royaume-Uni
UKElectoralRollNumber	string	Nombre de listes électorales du Royaume-Uni
UKNationalHealthNumber	string	Numéro national de santé 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 individuelle des contribuables américains
USSocialSecurityNumber	string	Numéro de sécurité sociale des États-Unis
USUKPassportNumber	string	Numéro de passeport des États-Unis
ZAIdentificationNumber	string	Numéro d’identification ZA

PiiDomain

Domaine pour la tâche PII

Nom	Type	Description
none	string	Indique qu’aucun domaine n’est spécifié.
phi	string	Indique que les entités du domaine Informations de santé personnelles doivent être régéré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 supprimé.
statistics	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	Avertissements rencontrés lors du traitement du document.

PiiResult

Contient le PiiResult.

Nom	Type	Description
documents	PiiEntitiesDocumentResult[]	Réponse par document
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.

PiiTaskParameters

Paramètres pris en charge pour une tâche de reconnaissance des entités PII.

Nom	Type	Valeur par défaut	Description
domain	PiiDomain	none	Domaine pour la tâche PII
loggingOptOut	boolean	False	désactivation de la déconnexion
modelVersion	string	latest	version du modèle
piiCategories	PiiCategory[]		Énumération des catégories d’informations personnelles à renvoyer dans la réponse.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType à utiliser pour l’analyse.

PiiTaskResult

Contient la tâche LRO d’analyse piiEntityRecognition.

Nom	Type	Description
kind	string: PiiEntityRecognitionResults	Type de résultat de tâche.
results	PiiResult	Liste des résultats pii

RangeInclusivity

Inclusion de la plage de cette propriété de propriété.

Nom	Type	Description
LeftInclusive	string	Inclusive côté gauche
LeftRightInclusive	string	Les deux côtés inclusifs
NoneInclusive	string	Aucune inclusivité
RightInclusive	string	Inclusive côté droit

RangeKind

Type de l’entité de plage de nombres.

Nom	Type	Description
Age	string	Plage d’âge
Area	string	Plage de zones
Currency	string	Plage monétaire
Information	string	Plage d’informations
Length	string	Plage de longueur
Number	string	Plage de nombres
Speed	string	Plage de vitesse
Temperature	string	Plage de températures
Volume	string	Plage de volumes
Weight	string	Plage de poids

RelativeTo

Point de référence que le nombre ordinal désigne.

Nom	Type	Description
Current	string	État ou position actuel
End	string	État ou position de fin
Start	string	État de démarrage ou position

RequestStatistics

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

Nom	Type	Description
documentsCount	integer	Nombre de documents envoyés dans la demande.
erroneousDocumentsCount	integer	Nombre de documents non valides. Cela inclut des documents de langues vides, surdimensionner ou non pris en charge.
transactionsCount	integer	Nombre de transactions pour la demande.
validDocumentsCount	integer	Nombre de documents valides. Cela exclut les documents de langues vides, de surdimensionner ou non pris en charge.

ScriptCode

Identifie le script du document d’entrée. Mappe au code de script standard ISO 15924.

Nom	Type	Description
Arab	string	Code de script pour le script arabe.
Armn	string	Code de script pour le script arménien.
Beng	string	Code de script pour le script Bangla.
Cans	string	Code de script pour le script UnifiedCanadianAboriginalSyllabics.
Cyrl	string	Code de script pour le script cyrillique.
Deva	string	Code de script pour le script Devanagari.
Ethi	string	Code de script pour le script échiopice.
Geor	string	Code de script pour le script géorgien.
Grek	string	Code de script pour le script grec.
Gujr	string	Code de script pour le script Gujarati.
Guru	string	Code de script pour le script Gurmukhi.
Hang	string	Code de script pour le script Hangul.
Hani	string	Code de script pour le script HanLiteral.
Hans	string	Code de script pour le script HanSimplified.
Hant	string	Code de script pour le script HanTraditional.
Hebr	string	Code de script pour le script hébreu.
Jpan	string	Code de script pour le script japonais.
Khmr	string	Code de script pour le script Khmer.
Knda	string	Code de script pour le script Kannada.
Laoo	string	Code de script pour le script lao.
Latn	string	Code de script pour le script latin.
Mlym	string	Code de script pour le script Malayalam.
Mong	string	Code de script pour le script mongol.
Mtei	string	Code de script pour le script Meitei.
Mymr	string	Code de script pour le script myanmar.
Olck	string	Code de script pour le script Santali.
Orya	string	Code de script pour le script Odia.
Shrd	string	Code de script pour le script Sharada.
Sinh	string	Code de script pour le script sinalaïal.
Taml	string	Code de script pour le script tamoul.
Telu	string	Code de script pour le script Telugu.
Thaa	string	Code de script pour le script Thaana.
Thai	string	Code de script pour le script thaïlandais.
Tibt	string	Code de script pour le script tibétain.

ScriptKind

Identifie le script du document d’entrée. Correspond au nom formel standard ISO 15924.

Nom	Type	Description
Arabic	string	Nom du script pour le script arabe.
Armenian	string	Nom du script pour le script arménien.
Bangla	string	Nom du script Bangla.
Cyrillic	string	Nom du script cyrillique.
Devanagari	string	Nom du script Devanagari.
Ethiopic	string	Nom du script échiopice.
Georgian	string	Nom du script géorgien.
Greek	string	Nom du script pour le script grec.
Gujarati	string	Nom de script pour le script Gujarati.
Gurmukhi	string	Nom du script pour le script Gurmukhi.
HanLiteral	string	Nom du script HanLiteral.
HanSimplified	string	Nom du script HanSimplified.
HanTraditional	string	Nom du script HanTraditional.
Hangul	string	Nom du script Hangul.
Hebrew	string	Nom du script pour le script hébreu.
Japanese	string	Nom du script japonais.
Kannada	string	Nom du script pour le script Kannada.
Khmer	string	Nom du script pour le script khmer.
Lao	string	Nom du script lao.
Latin	string	Nom du script pour le script latin.
Malayalam	string	Nom du script malayalam.
Meitei	string	Nom du script Meitei.
Mongolian	string	Nom du script mongol.
Myanmar	string	Nom du script du Myanmar.
Odia	string	Nom du script Odia.
Santali	string	Nom du script Santali.
Sharada	string	Nom du script Sharada.
Sinhala	string	Nom de script pour le script sinalaïal.
Tamil	string	Nom du script pour le script tamoul.
Telugu	string	Nom du script Telugu.
Thaana	string	Nom du script Thaana.
Thai	string	Nom du script thaïlandais.
Tibetan	string	Nom du script tibétain.
UnifiedCanadianAboriginalSyllabics	string	Nom du script pour le script UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Représente une évaluation de phrase et les évaluations ou les objets cibles associés.

Nom	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Représente les scores de confiance dans toutes les classes de sentiment : positifs et négatifs.
isNegated	boolean	Indicateur représentant si l’évaluation est négation.
length	integer	Longueur de la cible.
offset	integer	Décalage cible à partir du début de la phrase.
sentiment	TokenSentimentValue	Sentiment de la phrase.
text	string	Texte cible détecté.

SentenceSentiment

Sentiment de phrase d’un document.

Nom	Type	Description
assessments	SentenceAssessment[]	Tableau d’évaluations pour la phrase.
confidenceScores	SentimentConfidenceScores	Score de confiance des sentiments compris entre 0 et 1 pour la phrase pour toutes les classes.
length	integer	Longueur de la cible.
offset	integer	Décalage cible à partir du début de la phrase.
sentiment	SentenceSentimentValue	Sentiment prédit pour la phrase.
targets	SentenceTarget[]	Tableau de cibles de phrase pour la phrase.
text	string	Texte de 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 associés.

Nom	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Représente les scores de confiance dans toutes les classes de sentiment : positifs et négatifs.
length	integer	Longueur de la cible.
offset	integer	Décalage cible à partir du début de la phrase.
relations	TargetRelation[]	Tableau d’objets d’évaluation ou cibles associés à la cible.
sentiment	TokenSentimentValue	Sentiment de la phrase.
text	string	Texte cible détecté.

SentimentAnalysisTaskParameters

Paramètres pris en charge pour une tâche Analyse des sentiments.

Nom	Type	Valeur par défaut	Description
loggingOptOut	boolean	False	désactivation de la déconnexion
modelVersion	string	latest	version du modèle
opinionMining	boolean	False	Indique s’il faut utiliser l’exploration des opinions dans la demande ou non.
stringIndexType	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 sentiment : positif, neutre, négatif.

Nom	Type	Description
negative	number	Score de confiance pour le sentiment négatif
neutral	number	Score de confiance pour les sentiments neutres
positive	number	Score de confiance pour le sentiment positif

SentimentDocumentResult

Objet représentant les résultats prédéfinis de l’analyse des sentiments de chaque document.

Nom	Type	Description
confidenceScores	SentimentConfidenceScores	Score de confiance des sentiments compris entre 0 et 1 pour la phrase pour toutes les classes.
id	string	Identificateur de document unique et non vide.
sentences	SentenceSentiment[]	Sentiment des phrases du document.
sentiment	DocumentSentimentValue	Sentiment prédit pour le document (négatif, neutre, positif ou mixte).
statistics	DocumentStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile du document.
warnings	DocumentWarning[]	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	SentimentDocumentResult[]	Résultats de l’analyse des sentiments pour chaque document dans l’entrée.
errors	DocumentError[]	Erreurs par ID de document.
modelVersion	string	Ce champ indique quel modèle est utilisé pour le scoring.
statistics	RequestStatistics	si showStats=true a été spécifié dans la requête que ce champ contient des informations sur la charge utile de la requête.

SentimentTaskResult

Contient le résultat de la tâche SentimentAnalysis LRO d’analyse de texte.

Nom	Type	Description
kind	string: SentimentAnalysisResults	Type de résultat de tâche.
results	SentimentResponse	Résultats de l’analyse des sentiments

SpeedMetadata

Représente le modèle de métadonnées de l’entité Speed.

Nom	Type	Description
metadataKind	string: SpeedMetadata	Type d’objet Metadata d’entité.
unit	SpeedUnit	Unité de mesure pour la vitesse.
value	number	Valeur numérique que le texte extrait désigne.

SpeedUnit

Unité de mesure de vitesse

Nom	Type	Description
CentimetersPerMillisecond	string	Unité de vitesse en centimètres par milliseconde.
FeetPerMinute	string	Unité de vitesse en pieds par minute.
FeetPerSecond	string	Unité de vitesse en pieds par seconde.
KilometersPerHour	string	Unité de vitesse en kilomètres par heure.
KilometersPerMillisecond	string	Unité de vitesse en kilomètres par milliseconde.
KilometersPerMinute	string	Unité de vitesse en kilomètres par minute.
KilometersPerSecond	string	Unité de vitesse en kilomètres par seconde.
Knots	string	Unité de vitesse en nœuds.
MetersPerMillisecond	string	Unité de vitesse en mètres par milliseconde.
MetersPerSecond	string	Unité de vitesse en mètres par seconde.
MilesPerHour	string	Unité de vitesse en miles par heure.
Unspecified	string	Unité de vitesse non spécifiée.
YardsPerMinute	string	Unité de vitesse en yards par minute.
YardsPerSecond	string	Unité de vitesse en yards par seconde.

StringIndexType

Type d’index de chaîne

Nom	Type	Description
TextElements_v8	string	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	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 JavaScript.

TargetConfidenceScoreLabel

Représente les scores de confiance dans toutes les classes de sentiment : positifs et négatifs.

Nom	Type	Description
negative	number	Score de confiance pour le sentiment négatif
positive	number	Score de confiance pour le 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	TargetRelationType	Type lié à la cible.

TargetRelationType

Type lié à la cible.

Nom	Type	Description
assessment	string	Relation d’évaluation.
target	string	Relation cible.

TemperatureMetadata

Représente le modèle de métadonnées d’entité Information.

Nom	Type	Description
metadataKind	string: TemperatureMetadata	Type d’objet Metadata d’entité.
unit	TemperatureUnit	Unité de mesure pour la température.
value	number	Valeur numérique que le texte extrait désigne.

TemperatureUnit

Unité de température de mesure.

Nom	Type	Description
Celsius	string	Unité de température en Celsius
Fahrenheit	string	Unité de température dans Fahrenheit
Kelvin	string	Unité de température dans Kelvin
Rankine	string	Unité de température dans Rankine
Unspecified	string	Unité de température non spécifiée

TemporalModifier

Modificateur facultatif d’une instance de date/heure.

Nom	Type	Description
After	string	Après une heure spécifique
AfterApprox	string	Après une heure approximative
AfterMid	string	Après le milieu d’une période
AfterStart	string	Après le début d’une période
Approx	string	Approximativement à un moment spécifique
Before	string	Avant une heure spécifique
BeforeApprox	string	Avant une heure approximative
BeforeEnd	string	Avant la fin d’une période
BeforeStart	string	Avant le début d’une période
End	string	À la fin d’une période
Less	string	Moins d’une heure spécifique
Mid	string	Au milieu d’une période
More	string	Plus qu’une heure spécifique
ReferenceUndefined	string	Référence à une heure non définie
Since	string	Depuis une heure spécifique
SinceEnd	string	Depuis la fin d’une période
Start	string	Au début d’une période
Until	string	Jusqu’à une heure spécifique

TemporalSetMetadata

Métadonnées pour les instances d’entité de jeu temporel.

Nom	Type	Description
dateValues	DateValue[]	Liste des valeurs de date.
metadataKind	string: TemporalSetMetadata	Type d’objet Metadata d’entité.

TemporalSpanMetadata

représente les métadonnées d’une période de date et/ou d’heure.

Nom	Type	Description
metadataKind	string: TemporalSpanMetadata	Type d’objet Metadata d’entité.
spanValues	TemporalSpanValues[]	Liste des étendues temporelles détectées.

TemporalSpanValues

Objet d’étendue temporelle.

Nom	Type	Description
begin	string	Valeur de début de l’étendue.
duration	string	Valeur de durée facultative mise en forme en fonction de la norme ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Valeur de fin de l’étendue.
modifier	TemporalModifier	Modificateur pour datetime pour indiquer le point de référence comme avant, après, etc.
timex	string	Triplet facultatif contenant le début, la fin et la durée indiquées sous forme de chaînes au format ISO 8601.

TimeMetadata

Métadonnées pour les instances d’entité de temps.

Nom	Type	Description
dateValues	DateValue[]	Liste des valeurs de date.
metadataKind	string: TimeMetadata	Type d’objet Metadata d’entité.

TokenSentimentValue

Sentiment prédit pour la phrase.

Nom	Type	Description
mixed	string	Sentiment mixte
negative	string	Sentiment négatif
positive	string	Sentiment positif

VolumeMetadata

Représente le modèle de métadonnées d’entité de volume.

Nom	Type	Description
metadataKind	string: VolumeMetadata	Type d’objet Metadata d’entité.
unit	VolumeUnit	Unité de mesure pour le volume.
value	number	Valeur numérique que le texte extrait désigne.

VolumeUnit

Unité de mesure du volume

Nom	Type	Description
Barrel	string	Unité de volume en barils.
Bushel	string	Unité de volume dans les boisseaux.
Centiliter	string	Unité de volume en centiliters.
Cord	string	Unité de volume dans les cordons.
CubicCentimeter	string	Unité de volume en centimètres cubes.
CubicFoot	string	Unité de volume en pieds cubes.
CubicInch	string	Unité de volume en pouces cubes.
CubicMeter	string	Unité de volume en mètres cubes.
CubicMile	string	Unité de volume en milles cubes.
CubicMillimeter	string	Unité de volume en millimètres cubes.
CubicYard	string	Unité de volume dans les cours cubes.
Cup	string	Unité de volume en tasses.
Decaliter	string	Unité de volume dans les décaliters.
FluidDram	string	Unité de volume dans des drams fluides.
FluidOunce	string	Unité de volume en onces fluides.
Gill	string	Unité de volume dans les branchies.
Hectoliter	string	Unité de volume dans les hectoliters.
Hogshead	string	Unité de volume dans les têtes de porc.
Liter	string	Unité de volume en litres.
Milliliter	string	Unité de volume en milliliters.
Minim	string	Unité de volume en minims.
Peck	string	Unité de volume en taches.
Pinch	string	Unité de volume en pincements.
Pint	string	Unité de volume en pints.
Quart	string	Unité de volume en quarts.
Tablespoon	string	Unité de volume en cuillères à soupe.
Teaspoon	string	Unité de volume en cuillères à café.
Unspecified	string	Unité de volume non spécifiée.

WarningCodeValue

Définit la liste des codes d’avertissement.

Nom	Type	Description
DocumentTruncated	string	Avertissement tronqué du document
LongWordsInDocument	string	Mots longs dans l’avertissement de document

WeightMetadata

Représente le modèle de métadonnées d’entité Weight ).

Nom	Type	Description
metadataKind	string: WeightMetadata	Type d’objet Metadata d’entité.
unit	WeightUnit	Unité de mesure pour le poids.
value	number	Valeur numérique que le texte extrait désigne.

WeightUnit

Unité de mesure de poids.

Nom	Type	Description
Dram	string	Unité de poids dans les drams
Gallon	string	Unité de volume en gallons
Grain	string	Unité de poids dans les grains
Gram	string	Unité de poids en grammes
Kilogram	string	Unité de poids en kilogrammes
LongTonBritish	string	Unité de poids en tonnes longues (Britannique)
MetricTon	string	Unité de poids en tonnes de métriques
Milligram	string	Unité de poids en millisecondes
Ounce	string	Unité de poids en onces
PennyWeight	string	Unité de poids en pennyweights
Pound	string	Unité de poids en livres
ShortHundredWeightUS	string	Unité de poids en cent poids courts (États-Unis)
ShortTonUS	string	Unité de poids en tonnes courtes (États-Unis)
Stone	string	Unité de poids en pierres
Ton	string	Unité de poids en tonnes
Unspecified	string	Unité de poids non spécifiée