Text Analysis Runtime - Analyze Text

Referentie

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Tekstanalyse aanvragen voor een verzameling documenten.

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
showStats	query		boolean	(Optioneel) als dit is ingesteld op true, bevat het antwoord statistieken op aanvraag- en documentniveau.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
AnalyzeTextEntityLinkingInput	Bevat de invoer voor het koppelen van entiteiten in de analysetekst.
AnalyzeTextEntityRecognitionInput	De aanvraag voor de taak voor het analyseren van tekstinvoer door de entiteitsherkenning.
AnalyzeTextKeyPhraseExtractionInput	Bevat de invoer van de analysetekst KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van de documentanalysetaak voor taaldetectie.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de invoer van de analysetekst PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Bevat de invoer van de taak SentimentAnalysis analyseren.

AnalyzeTextEntityLinkingInput

Bevat de invoer voor het koppelen van entiteiten in de analysetekst.

Name	Vereist	Type	Description
kind	True	string: EntityLinking	Het type taak dat moet worden uitgevoerd.
analysisInput		MultiLanguageAnalysisInput	Bevat de analyse-invoer die moet worden verwerkt door de service.
parameters		EntityLinkingTaskParameters	Taakparameters.

AnalyzeTextEntityRecognitionInput

De aanvraag voor de taak voor het analyseren van tekstinvoer door de entiteitsherkenning.

Name	Vereist	Type	Description
kind	True	string: EntityRecognition	Het type taak dat moet worden uitgevoerd.
analysisInput		MultiLanguageAnalysisInput	De invoer die moet worden geanalyseerd.
parameters		EntitiesTaskParameters	Taakparameters.

AnalyzeTextKeyPhraseExtractionInput

Bevat de invoer van de analysetekst KeyPhraseExtraction.

Name	Vereist	Type	Description
kind	True	string: KeyPhraseExtraction	Het soort taak dat moet worden uitgevoerd.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		KeyPhraseTaskParameters	Parameters voor sleuteltermextractietaken.

AnalyzeTextLanguageDetectionInput

Bevat de invoer van de documentanalysetaak voor taaldetectie.

Name	Vereist	Type	Description
kind	True	string: LanguageDetection	Het soort taak dat moet worden uitgevoerd.
analysisInput		LanguageDetectionAnalysisInput	Documenten die moeten worden geanalyseerd.
parameters		LanguageDetectionTaskParameters	taakparameters.

AnalyzeTextPiiEntitiesRecognitionInput

Bevat de invoer van de analysetekst PIIEntityRecognition.

Name	Vereist	Type	Description
kind	True	string: PiiEntityRecognition	Het soort taak dat moet worden uitgevoerd.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		PiiTaskParameters	Pii-taakparameters.

AnalyzeTextSentimentAnalysisInput

Bevat de invoer van de taak SentimentAnalysis analyseren.

Name	Vereist	Type	Description
kind	True	string: SentimentAnalysis	Het soort taak dat moet worden uitgevoerd.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		SentimentAnalysisTaskParameters	Parameters voor sentimentanalysetaken.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	De aanvraag is geslaagd.
Other Status Codes	ErrorResponse	Een onverwacht foutbericht. Headers x-ms-error-code: string

Name

Type

Description

200 OK

AnalyzeTextTaskResult:

EntitiesTaskResult
EntityLinkingTaskResult
KeyPhraseTaskResult
LanguageDetectionTaskResult
PiiTaskResult
SentimentTaskResult

De aanvraag is geslaagd.

Other Status Codes

ErrorResponse

Een onverwacht foutbericht.

Headers

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 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"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample Response

Status code:: 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

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample Response

Status code:: 200

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

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample Response

Status code:: 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

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample Response

Status code:: 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"
  }
}

Definities

Name	Description
AnalyzeTextEntityLinkingInput	Bevat de invoer voor het koppelen van entiteiten in de analysetekst.
AnalyzeTextEntityRecognitionInput	De aanvraag voor de taak voor het analyseren van tekstinvoer door de entiteitsherkenning.
AnalyzeTextKeyPhraseExtractionInput	Bevat de invoer van de analysetekst KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van de documentanalysetaak voor taaldetectie.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de invoer van de analysetekst PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Bevat de invoer van de taak SentimentAnalysis.
AnalyzeTextTaskKind	Het type analyse-teksttaken dat wordt ondersteund.
AnalyzeTextTaskResultsKind	Het type antwoordobject dat door de taak analyze-text wordt geretourneerd.
DetectedLanguage	Bevat de details van de gedetecteerde taal voor de tekst.
DocumentError	Bevat details van fouten die zijn opgetreden tijdens het uitvoeren van een taak.
DocumentSentimentValue	Voorspeld gevoel voor document (negatief, neutraal, positief of gemengd).
DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
DocumentWarning	Bevat het waarschuwingenobject met waarschuwingen voor het verwerkte document.
EntitiesDocumentResult	Bevat het resultaat van de entiteitsherkenningstaak voor het document.
EntitiesResult	Bevat het resultaat van de entiteitsherkenningstaak.
EntitiesTaskParameters	Ondersteunde parameters voor een entiteitsherkenningstaak.
EntitiesTaskResult	Bevat de entiteitstaak
Entity	Definieert het gedetecteerde entiteitsobject met de entiteitscategorie en gedetecteerde entiteitstekst, enzovoort.
EntityLinkingResult	Resultaat van entiteitskoppeling.
EntityLinkingTaskParameters	Ondersteunde parameters voor een entiteitskoppelingstaak.
EntityLinkingTaskResult	Bevat het resultaat van de taak voor het koppelen van entiteiten.
Error	Het foutreactieobject dat wordt geretourneerd wanneer de service fouten tegenkomt tijdens het verwerken van de aanvraag.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Bevat de KeyPhraseResult.
KeyPhrasesDocumentResult	Bevat de sleuteltermextractieresultaten voor een document.
KeyPhraseTaskParameters	Ondersteunde parameters voor een sleuteltermextractietaak.
KeyPhraseTaskResult	Bevat het resultaat van de analysetekst KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Bevat de invoer voor documentanalyse voor taaldetectie.
LanguageDetectionDocumentResult	Bevat de taaldetectie voor een document.
LanguageDetectionResult	Bevat het taaldetectieresultaat voor de aanvraag.
LanguageDetectionTaskParameters	Ondersteunde parameters voor een taaldetectietaak.
LanguageDetectionTaskResult	Bevat het resultaat van de taaldetectietaak voor de aanvraag.
LanguageInput	Bevat de invoer voor taaldetectie.
LinkedEntitiesDocumentResult	Documentresultaat entiteitskoppeling.
LinkedEntity	Het LinkedEntity-object met de gedetecteerde entiteit met de gekoppelde bronnen/koppelingen.
Match	Het object Match met de gedetecteerde entiteitstekst met de verschuiving en de lengte.
MultiLanguageAnalysisInput	Verzameling invoerdocumenten die door de service moeten worden geanalyseerd.
MultiLanguageInput	Bevat een invoerdocument dat moet worden geanalyseerd door de service.
PiiCategory	(Optioneel) beschrijft de PII-categorieën die moeten worden geretourneerd
PiiDomain	Domein voor PII-taak
PiiEntitiesDocumentResult	Bevat de PII-resultaten.
PiiResult	Bevat de PiiResult.
PiiTaskParameters	Ondersteunde parameters voor een herkenningstaak voor PII-entiteiten.
PiiTaskResult	Bevat de LRO-taak PIIEntityRecognition analyseren.
RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.
SentenceAssessment	Vertegenwoordigt een zinsevaluatie en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentenceSentiment	Het zinsgevoel van een document.
SentenceSentimentValue	Het voorspelde gevoel voor de zin.
SentenceTarget	Vertegenwoordigt een zinsdoel en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentimentAnalysisTaskParameters	Ondersteunde parameters voor een sentimentanalysetaak.
SentimentConfidenceScores	Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 in alle sentimentklassen: positief, neutraal, negatief.
SentimentDocumentResult	Een object dat de vooraf gemaakte sentimentanalyseresultaten van elk document vertegenwoordigt.
SentimentResponse	Resultaten van sentimentanalyse voor de invoerdocumenten.
SentimentTaskResult	Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.
StringIndexType	Type tekenreeksindex
TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
TargetRelation	Vertegenwoordigt de relatie tussen evaluaties en/of doelen.
TargetRelationType	Het type dat is gerelateerd aan het doel.
TokenSentimentValue	Het voorspelde gevoel voor de zin.
WarningCodeValue	Hiermee definieert u de lijst met waarschuwingscodes.

AnalyzeTextEntityLinkingInput

Bevat de invoer voor het koppelen van entiteiten in de analysetekst.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de analyse-invoer die moet worden verwerkt door de service.
kind	string: EntityLinking	Het type taak dat moet worden uitgevoerd.
parameters	EntityLinkingTaskParameters	Taakparameters.

AnalyzeTextEntityRecognitionInput

De aanvraag voor de taak voor het analyseren van tekstinvoer door de entiteitsherkenning.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	De invoer die moet worden geanalyseerd.
kind	string: EntityRecognition	Het type taak dat moet worden uitgevoerd.
parameters	EntitiesTaskParameters	Taakparameters.

AnalyzeTextKeyPhraseExtractionInput

Bevat de invoer van de analysetekst KeyPhraseExtraction.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: KeyPhraseExtraction	Het type taak dat moet worden uitgevoerd.
parameters	KeyPhraseTaskParameters	Parameters voor sleuteltermextractietaken.

AnalyzeTextLanguageDetectionInput

Bevat de invoer van de documentanalysetaak voor taaldetectie.

Name	Type	Description
analysisInput	LanguageDetectionAnalysisInput	Documenten die moeten worden geanalyseerd.
kind	string: LanguageDetection	Het type taak dat moet worden uitgevoerd.
parameters	LanguageDetectionTaskParameters	taakparameters.

AnalyzeTextPiiEntitiesRecognitionInput

Bevat de invoer van de analysetekst PIIEntityRecognition.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: PiiEntityRecognition	Het type taak dat moet worden uitgevoerd.
parameters	PiiTaskParameters	Parameters voor pii-taken.

AnalyzeTextSentimentAnalysisInput

Bevat de invoer van de taak SentimentAnalysis.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: SentimentAnalysis	Het type taak dat moet worden uitgevoerd.
parameters	SentimentAnalysisTaskParameters	Parameters voor sentimentanalysetaken.

AnalyzeTextTaskKind

Het type analyse-teksttaken dat wordt ondersteund.

Name	Type	Description
EntityLinking	string	Taak voor entiteitskoppeling
EntityRecognition	string	Entiteitsherkenningstaak
KeyPhraseExtraction	string	Sleuteltermextractietaak
LanguageDetection	string	Taaldetectietaak
PiiEntityRecognition	string	Herkenningstaak voor PII-entiteiten
SentimentAnalysis	string	Sentimentanalysetaak

AnalyzeTextTaskResultsKind

Het type antwoordobject dat door de taak analyze-text wordt geretourneerd.

Name	Type	Description
EntityLinkingResults	string	Resultaten van entiteitskoppeling
EntityRecognitionResults	string	Resultaten van entiteitsherkenning
KeyPhraseExtractionResults	string	Resultaten van sleuteltermextractie
LanguageDetectionResults	string	Resultaten van taaldetectie
PiiEntityRecognitionResults	string	Resultaten van PII-entiteitsherkenning
SentimentAnalysisResults	string	Resultaten van sentimentanalyse

DetectedLanguage

Bevat de details van de gedetecteerde taal voor de tekst.

Name	Type	Description
confidenceScore	number	Een betrouwbaarheidsscore tussen 0 en 1. Scores dicht bij 1 geven 100% zekerheid aan dat de geïdentificeerde taal waar is.
iso6391Name	string	Een tweeletterige weergave van de gedetecteerde taal volgens de ISO 639-1-norm (bijv. en, fr).
name	string	Lange naam van een gedetecteerde taal (bijvoorbeeld Engels, Frans).

DocumentError

Bevat details van fouten die zijn opgetreden tijdens het uitvoeren van een taak.

Name	Type	Description
error	Error	Er is een fout opgetreden.
id	string	De id van het invoerdocument.

DocumentSentimentValue

Voorspeld gevoel voor document (negatief, neutraal, positief of gemengd).

Name	Type	Description
mixed	string	Gemengde instructie
negative	string	Negatieve verklaring
neutral	string	Neutrale instructie
positive	string	Positieve verklaring

DocumentStatistics

Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.

Name	Type	Description
charactersCount	integer	Het aantal tekstelementen dat in het document wordt herkend.
transactionsCount	integer	Aantal transacties voor het document.

DocumentWarning

Bevat het waarschuwingenobject met waarschuwingen voor het verwerkte document.

Name	Type	Description
code	WarningCodeValue	Waarschuwingscode.
message	string	Waarschuwingsbericht.
targetRef	string	Een JSON-aanwijzerverwijzing die het doelobject aangeeft.

EntitiesDocumentResult

Bevat het resultaat van de entiteitsherkenningstaak voor het document.

Name	Type	Description
entities	Entity[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

EntitiesResult

Bevat het resultaat van de entiteitsherkenningstaak.

Name	Type	Description
documents	EntitiesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

EntitiesTaskParameters

Ondersteunde parameters voor een entiteitsherkenningstaak.

Name	Type	Standaardwaarde	Description
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie
stringIndexType	StringIndexType	TextElements_v8	(Optioneel) parameter om het type tekenreeksindex op te geven dat wordt gebruikt om tekenreeks offsets te interpreteren. Standaard ingesteld op TextElements (Graphemes).

EntitiesTaskResult

Bevat de entiteitstaak

Name	Type	Description
kind	string: EntityRecognitionResults	Het soort taakresultaat.
results	EntitiesResult	Resultaten voor entiteitsherkenning.

Entity

Definieert het gedetecteerde entiteitsobject met de entiteitscategorie en gedetecteerde entiteitstekst, enzovoort.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer	Lengte voor de entiteitstekst. Het gebruik van verschillende 'stringIndexType'-waarden kan van invloed zijn op de geretourneerde lengte.
offset	integer	Beginpositie voor de entiteitstekst. Het gebruik van verschillende 'stringIndexType'-waarden kan van invloed zijn op de geretourneerde offset.
subcategory	string	(Optioneel) Subtype entiteit.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

EntityLinkingResult

Resultaat van entiteitskoppeling.

Name	Type	Description
documents	LinkedEntitiesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

EntityLinkingTaskParameters

Ondersteunde parameters voor een entiteitskoppelingstaak.

Name	Type	Standaardwaarde	Description
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie
stringIndexType	StringIndexType	TextElements_v8	Optionele parameter voor het type tekenreeksindex dat wordt gebruikt om tekenreeks offsets te interpreteren. Standaard ingesteld op TextElements (Graphemes).

EntityLinkingTaskResult

Bevat het resultaat van de taak voor het koppelen van entiteiten.

Name	Type	Description
kind	string: EntityLinkingResults	Het soort taakresultaat.
results	EntityLinkingResult	Resultaat van entiteitskoppeling.

Error

Het foutreactieobject dat wordt geretourneerd wanneer de service fouten tegenkomt tijdens het verwerken van de aanvraag.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Door mensen leesbare foutcode.

Name	Type	Description
AzureCognitiveSearchIndexLimitReached	string	fout Azure Cognitive Search indexlimiet is bereikt
AzureCognitiveSearchIndexNotFound	string	fout Azure Cognitive Search index niet gevonden
AzureCognitiveSearchNotFound	string	fout Azure Cognitive Search niet gevonden
AzureCognitiveSearchThrottling	string	Azure Cognitive Search beperkingsfout
Conflict	string	Conflictfout
Forbidden	string	Fout over verboden toegang
InternalServerError	string	Interne serverfout
InvalidArgument	string	Fout met ongeldig argument
InvalidRequest	string	Fout met ongeldige aanvraag
NotFound	string	Fout Niet gevonden
OperationNotFound	string	Fout Bewerking niet gevonden
ProjectNotFound	string	Fout Project niet gevonden
QuotaExceeded	string	Fout Quotum overschreden
ServiceUnavailable	string	Fout Service niet beschikbaar
Timeout	string	Time-outfout
TooManyRequests	string	Fout te veel aanvragen
Unauthorized	string	Fout met niet-geautoriseerde toegang
Warning	string	Waarschuwingsfout

ErrorResponse

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Door mensen leesbare foutcode.

Name	Type	Description
AzureCognitiveSearchNotFound	string	fout Azure Cognitive Search niet gevonden
AzureCognitiveSearchThrottling	string	Azure Cognitive Search beperkingsfout
EmptyRequest	string	Lege aanvraagfout
ExtractionFailure	string	Fout bij extractiefout
InvalidCountryHint	string	Ongeldige landhintfout
InvalidDocument	string	Ongeldige documentfout
InvalidDocumentBatch	string	Ongeldige documentbatchfout
InvalidParameterValue	string	Fout met ongeldige parameterwaarde
InvalidRequest	string	Fout met ongeldige aanvraag
InvalidRequestBodyFormat	string	Fout met ongeldige indeling van aanvraagbody
KnowledgeBaseNotFound	string	De fout Knowledge Base is niet gevonden
MissingInputDocuments	string	Fout met ontbrekende invoerdocumenten
ModelVersionIncorrect	string	Fout met onjuiste modelversie
UnsupportedLanguageCode	string	Fout met niet-ondersteunde taalcode

InnerErrorModel

Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

KeyPhraseResult

Bevat de KeyPhraseResult.

Name	Type	Description
documents	KeyPhrasesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor het scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

KeyPhrasesDocumentResult

Bevat de sleuteltermextractieresultaten voor een document.

Name	Type	Description
id	string	Unieke, niet-lege document-id.
keyPhrases	string[]	Een lijst met representatieve woorden of woordgroepen. Het aantal geretourneerde sleutelzinnen is evenredig met het aantal woorden in het invoerdocument.
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

KeyPhraseTaskParameters

Ondersteunde parameters voor een sleuteltermextractietaak.

Name	Type	Standaardwaarde	Description
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie

KeyPhraseTaskResult

Bevat het resultaat van de analysetekst KeyPhraseExtraction.

Name	Type	Description
kind	string: KeyPhraseExtractionResults	Het soort taakresultaat.
results	KeyPhraseResult	De lijst met resultaten van sleuteltermextractie

LanguageDetectionAnalysisInput

Bevat de invoer voor documentanalyse voor taaldetectie.

Name	Type	Description
documents	LanguageInput[]	Lijst met documenten die moeten worden geanalyseerd.

LanguageDetectionDocumentResult

Bevat de taaldetectie voor een document.

Name	Type	Description
detectedLanguage	DetectedLanguage	Taal gedetecteerd.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

LanguageDetectionResult

Bevat het taaldetectieresultaat voor de aanvraag.

Name	Type	Description
documents	LanguageDetectionDocumentResult[]	Opsomming van taaldetectieresultaten voor elk invoerdocument.
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor het scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

LanguageDetectionTaskParameters

Ondersteunde parameters voor een taaldetectietaak.

Name	Type	Standaardwaarde	Description
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie

LanguageDetectionTaskResult

Bevat het resultaat van de taaldetectietaak voor de aanvraag.

Name	Type	Description
kind	string: LanguageDetectionResults	Het soort taakresultaat.
results	LanguageDetectionResult	Bevat de taaldetectieresultaten.

LanguageInput

Bevat de invoer voor taaldetectie.

Name	Type	Description
countryHint	string	De landhint om te helpen bij de taaldetectie van de tekst.
id	string	Een unieke, niet-lege document-id.
text	string	De invoertekst die moet worden verwerkt.

LinkedEntitiesDocumentResult

Documentresultaat entiteitskoppeling.

Name	Type	Description
entities	LinkedEntity[]	Bekende entiteiten in het document worden herkend.
id	string	Unieke, niet-lege document-id.
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

LinkedEntity

Het LinkedEntity-object met de gedetecteerde entiteit met de gekoppelde bronnen/koppelingen.

Name	Type	Description
bingId	string	De unieke id van de Bing Entiteiten zoeken-API van de herkende entiteit.
dataSource	string	Gegevensbron die wordt gebruikt voor het extraheren van entiteitskoppelingen, zoals Wiki/Bing, enzovoort.
id	string	De unieke id van de herkende entiteit uit de gegevensbron.
language	string	Taal die wordt gebruikt in de gegevensbron.
matches	Match[]	Lijst met exemplaren van deze entiteit wordt weergegeven in de tekst.
name	string	Formele naam van Entity Linking.
url	string	URL voor de pagina van de entiteit uit de gegevensbron.

Match

Het object Match met de gedetecteerde entiteitstekst met de verschuiving en de lengte.

Name	Type	Description
confidenceScore	number	Als een bekend item wordt herkend, wordt een decimaal getal geretourneerd dat het betrouwbaarheidsniveau tussen 0 en 1 aangeeft.
length	integer	Lengte voor de entiteit komt overeen met tekst.
offset	integer	Beginpositie voor de overeenkomende tekst van de entiteit.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

MultiLanguageAnalysisInput

Verzameling invoerdocumenten die door de service moeten worden geanalyseerd.

Name	Type	Description
documents	MultiLanguageInput[]	De invoerdocumenten die moeten worden geanalyseerd.

MultiLanguageInput

Bevat een invoerdocument dat moet worden geanalyseerd door de service.

Name	Type	Description
id	string	Een unieke, niet-lege document-id.
language	string	(Optioneel) Dit is de 2 letter ISO 639-1 weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als dit niet is ingesteld, gebruikt u 'en' voor Engels als standaardinstelling. (Volgen is alleen van toepassing op 2023-04-15-preview en hoger) Voor Automatische taaldetectie gebruikt u 'auto'. Als dit niet is ingesteld, gebruikt u 'en' voor Engels als standaardinstelling.
text	string	De invoertekst die moet worden verwerkt.

PiiCategory

(Optioneel) beschrijft de PII-categorieën die moeten worden geretourneerd

Name	Type	Description
ABARoutingNumber	string	ABA-routeringsnummer
ARNationalIdentityNumber	string	AR National Identity Number
ATIdentityCard	string	AT-identiteitskaart
ATTaxIdentificationNumber	string	AT Belastingidentificatienummer
ATValueAddedTaxNumber	string	AT Btw-nummer
AUBankAccountNumber	string	AT-identiteitskaart
AUBusinessNumber	string	ZAKELIJK NUMMER AU
AUCompanyNumber	string	AU-bedrijfsnummer
AUDriversLicenseNumber	string	Au-rijbewijsnummer
AUMedicalAccountNumber	string	Au medisch rekeningnummer
AUPassportNumber	string	AU-paspoortnummer
AUTaxFileNumber	string	AU-belastingbestandsnummer
Address	string	Adres
Age	string	Leeftijd
All	string	Alle PII-categorieën.
AzureDocumentDBAuthKey	string	Azure Document DB-verificatiesleutel
AzureIAASDatabaseConnectionAndSQLString	string	Azure IAAS-databaseverbinding en SQL-tekenreeks
AzureIoTConnectionString	string	Azure IoT-verbindingsreeks
AzurePublishSettingPassword	string	Wachtwoord voor azure-publicatie-instelling
AzureRedisCacheString	string	Azure Redis Cache-tekenreeks
AzureSAS	string	Azure SAS
AzureServiceBusString	string	Azure Service Bus tekenreeks
AzureStorageAccountGeneric	string	Algemeen Azure Storage-account
AzureStorageAccountKey	string	Azure Storage-accountsleutel
BENationalNumber	string	BE Nationaal nummer
BENationalNumberV2	string	BE Nationaal nummer V2
BEValueAddedTaxNumber	string	BE Btw-nummer
BGUniformCivilNumber	string	BG Uniform Civiel Nummer
BRCPFNumber	string	BR CPF-nummer
BRLegalEntityNumber	string	BR-rechtspersoonnummer
BRNationalIDRG	string	BR Nationale ID RG
CABankAccountNumber	string	Ca-bankrekeningnummer
CADriversLicenseNumber	string	Licentienummer van CA-stuurprogramma
CAHealthServiceNumber	string	CA Health Service-nummer
CAPassportNumber	string	CA-paspoortnummer
CAPersonalHealthIdentification	string	Persoonlijke statusidentificatie van CA
CASocialInsuranceNumber	string	CA-nummer sociale verzekering
CHSocialSecurityNumber	string	CH Burgerservicenummer
CLIdentityCardNumber	string	CL-id-kaartnummer
CNResidentIdentityCardNumber	string	CN Resident Identity Card Number
CYIdentityCard	string	CY-identiteitskaart
CYTaxIdentificationNumber	string	CY-belastingidentificatienummer
CZPersonalIdentityNumber	string	CZ-persoonlijk id-nummer
CZPersonalIdentityV2	string	CZ Personal Identity V2
CreditCardNumber	string	Creditcardnummer
DEDriversLicenseNumber	string	DE-rijbewijsnummer
DEIdentityCardNumber	string	DE-id-kaartnummer
DEPassportNumber	string	DE-paspoortnummer
DETaxIdentificationNumber	string	DE Belastingidentificatienummer
DEValueAddedNumber	string	Toegevoegde waarde voor DE
DKPersonalIdentificationNumber	string	DK Persoonlijk identificatienummer
DKPersonalIdentificationV2	string	DK Persoonlijke identificatie V2
Date	string	Date
Default	string	Standaard PII-categorieën voor de taal.
DrugEnforcementAgencyNumber	string	Nummer van de drughandhavingsagent
EEPersonalIdentificationCode	string	EE-persoonlijke identificatiecode
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	ES Burgerservicenummer
ESTaxIdentificationNumber	string	ES Belastingidentificatienummer
EUDebitCardNumber	string	NUMMER VAN EU-betaalpas
EUDriversLicenseNumber	string	EU-rijbewijsnummer
EUGPSCoordinates	string	EU GPS-coördinaten
EUNationalIdentificationNumber	string	Nationaal EU-identificatienummer
EUPassportNumber	string	EU-paspoortnummer
EUSocialSecurityNumber	string	EU-burgerservicenummer
EUTaxIdentificationNumber	string	EU-belastingidentificatienummer
Email	string	E-mail
FIEuropeanHealthNumber	string	FI Europees gezondheidsnummer
FINationalID	string	NATIONALE FI-id
FINationalIDV2	string	NATIONALE FI-id V2
FIPassportNumber	string	FI-paspoortnummer
FRDriversLicenseNumber	string	FR-rijbewijsnummer
FRHealthInsuranceNumber	string	FR Ziekteverzekeringsnummer
FRNationalID	string	FR Nationaal ID
FRPassportNumber	string	FR-paspoortnummer
FRSocialSecurityNumber	string	FR Burgerservicenummer
FRTaxIdentificationNumber	string	FR Belastingidentificatienummer
FRValueAddedTaxNumber	string	FR Btw-nummer
GRNationalIDCard	string	GR Nationale identiteitskaart
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	GR Belastingidentificatienummer
HKIdentityCardNumber	string	HK-id-kaartnummer
HRIdentityCardNumber	string	NUMMER VAN HR-identiteitskaart
HRNationalIDNumber	string	HR Nationaal id-nummer
HRPersonalIdentificationNumber	string	PERSOONLIJK HR-identificatienummer
HRPersonalIdentificationOIBNumberV2	string	HR-persoonlijke identificatie OIB-nummer V2
HUPersonalIdentificationNumber	string	HU Persoonlijk identificatienummer
HUTaxIdentificationNumber	string	HU Belastingidentificatienummer
HUValueAddedNumber	string	Toegevoegde waarde hu
IDIdentityCardNumber	string	Id-id-kaartnummer
IEPersonalPublicServiceNumber	string	IE Personal Public Service Number
IEPersonalPublicServiceNumberV2	string	IE Personal Public Service Number V2
ILBankAccountNumber	string	IL-bankrekeningnummer
ILNationalID	string	IL Nationale id
INPermanentAccount	string	IN Permanent Account
INUniqueIdentificationNumber	string	IN Uniek identificatienummer
IPAddress	string	IP-adres
ITDriversLicenseNumber	string	Licentienummer voor IT-stuurprogramma's
ITFiscalCode	string	FISCALE IT-code
ITValueAddedTaxNumber	string	IT-btw-nummer
InternationalBankingAccountNumber	string	Internationaal bankrekeningnummer
JPBankAccountNumber	string	JP-bankrekeningnummer
JPDriversLicenseNumber	string	JP-rijbewijsnummer
JPMyNumberCorporate	string	JP Mijn nummer zakelijk
JPMyNumberPersonal	string	JP Mijn nummer Persoonlijk
JPPassportNumber	string	JP-paspoortnummer
JPResidenceCardNumber	string	JP Residence Card Number
JPResidentRegistrationNumber	string	JP Resident Registration Number
JPSocialInsuranceNumber	string	JP Social Insurance Number
KRResidentRegistrationNumber	string	KR Resident Registration Number
LTPersonalCode	string	Persoonlijke LT-code
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	LU Nationaal identificatienummer niet natuurlijk
LVPersonalCode	string	PERSOONLIJKE LV-code
MTIdentityCardNumber	string	NUMMER VAN MT-identiteitskaart
MTTaxIDNumber	string	MT-btw-nummer
MYIdentityCardNumber	string	MIJN identiteitskaartnummer
NLCitizensServiceNumber	string	Servicenummer nl-burgers
NLCitizensServiceNumberV2	string	NL Citizens Service Number V2
NLTaxIdentificationNumber	string	NL Btw-identificatienummer
NLValueAddedTaxNumber	string	NL Btw-nummer
NOIdentityNumber	string	GEEN identiteitsnummer
NZBankAccountNumber	string	Bankrekeningnummer NZ
NZDriversLicenseNumber	string	NZ-rijbewijsnummer
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	NZ Ministerie van Gezondheid Nummer
NZSocialWelfareNumber	string	NZ Social Welfare Number
Organization	string	Organisatie
PHUnifiedMultiPurposeIDNumber	string	PH Unified Multi Purpose ID Number
PLIdentityCard	string	PL-identiteitskaart
PLNationalID	string	PL Nationale id
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	PL-paspoortnummer
PLREGONNumber	string	PL REGON-nummer
PLTaxIdentificationNumber	string	PL Belastingidentificatienummer
PTCitizenCardNumber	string	PT-burgerkaartnummer
PTCitizenCardNumberV2	string	PT-burgerkaartnummer V2
PTTaxIdentificationNumber	string	PT-belastingidentificatienummer
Person	string	Person
PhoneNumber	string	Telefoonnummer
ROPersonalNumericalCode	string	Persoonlijke numerieke RO-code
RUPassportNumberDomestic	string	RU-paspoortnummer binnenlands
RUPassportNumberInternational	string	RU-paspoortnummer internationaal
SANationalID	string	Nationale SA-id
SENationalID	string	NATIONALE SE-id
SENationalIDV2	string	NATIONALE SE-id V2
SEPassportNumber	string	SE-paspoortnummer
SETaxIdentificationNumber	string	SE-belastingidentificatienummer
SGNationalRegistrationIdentityCardNumber	string	SG Nationaal registratie-id-kaartnummer
SITaxIdentificationNumber	string	SI-belastingidentificatienummer
SIUniqueMasterCitizenNumber	string	SI Unique Master Citizen Number
SKPersonalNumber	string	PERSOONLIJK SK-nummer
SQLServerConnectionString	string	SQL Server verbindingsreeks
SWIFTCode	string	SWIFT-code
THPopulationIdentificationCode	string	TH-populatieidentificatiecode
TRNationalIdentificationNumber	string	TR Nationaal identificatienummer
TWNationalID	string	TW Nationale id
TWPassportNumber	string	TW-paspoortnummer
TWResidentCertificate	string	Tw Resident-certificaat
UAPassportNumberDomestic	string	UA-paspoortnummer Binnenlands
UAPassportNumberInternational	string	UA Passport Number International
UKDriversLicenseNumber	string	UK Driver's License Number
UKElectoralRollNumber	string	Nummer van het Britse kieslijsten
UKNationalHealthNumber	string	UK National Health Number
UKNationalInsuranceNumber	string	UK National Insurance Number
UKUniqueTaxpayerNumber	string	UK Unique Taxpayer Number
URL	string	URL
USBankAccountNumber	string	Amerikaans bankrekeningnummer
USDriversLicenseNumber	string	Amerikaans rijbewijsnummer
USIndividualTaxpayerIdentification	string	Amerikaanse identificatie van individuele belastingbetalers
USSocialSecurityNumber	string	Amerikaans burgerservicenummer
USUKPassportNumber	string	Amerikaans-Brits paspoortnummer
ZAIdentificationNumber	string	ZA-identificatienummer

PiiDomain

Domein voor PII-taak

Name	Type	Description
none	string	Geeft aan dat er geen domein is opgegeven.
phi	string	Geeft aan dat entiteiten in het domein Persoonlijke statusgegevens moeten worden bewerkt.

PiiEntitiesDocumentResult

Bevat de PII-resultaten.

Name	Type	Description
entities	Entity[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
redactedText	string	Hiermee wordt geredigeerde tekst geretourneerd.
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

PiiResult

Bevat de PiiResult.

Name	Type	Description
documents	PiiEntitiesDocumentResult[]	Antwoord per document
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor het scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

PiiTaskParameters

Ondersteunde parameters voor een herkenningstaak voor PII-entiteiten.

Name	Type	Standaardwaarde	Description
domain	PiiDomain	none	Domein voor PII-taak
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie
piiCategories	PiiCategory[]		Opsomming van PII-categorieën die in het antwoord moeten worden geretourneerd.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType dat moet worden gebruikt voor analyse.

PiiTaskResult

Bevat de LRO-taak PIIEntityRecognition analyseren.

Name	Type	Description
kind	string: PiiEntityRecognitionResults	Het soort taakresultaat.
results	PiiResult	De lijst met pii-resultaten

RequestStatistics

Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

Name	Type	Description
documentsCount	integer	Het aantal documenten dat in de aanvraag is ingediend.
erroneousDocumentsCount	integer	Aantal ongeldige documenten. Dit omvat lege documenten met een te grote limiet of niet-ondersteunde talen.
transactionsCount	integer	Aantal transacties voor de aanvraag.
validDocumentsCount	integer	Aantal geldige documenten. Dit sluit lege documenten met een te grote limiet of niet-ondersteunde talen uit.

SentenceAssessment

Vertegenwoordigt een zinsevaluatie en de evaluaties of doelobjecten die eraan zijn gerelateerd.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
isNegated	boolean	De indicator die aangeeft of de evaluatie wordt genegeerd.
length	integer	De lengte van het doel.
offset	integer	Het doelverschil vanaf het begin van de zin.
sentiment	TokenSentimentValue	Het gevoel van de zin.
text	string	De doeltekst gedetecteerd.

SentenceSentiment

Het zinsgevoel van een document.

Name	Type	Description
assessments	SentenceAssessment[]	De matrix van evaluaties voor de zin.
confidenceScores	SentimentConfidenceScores	De gevoelsvertrouwensscore tussen 0 en 1 voor de zin voor alle klassen.
length	integer	De lengte van het doel.
offset	integer	Het doelverschil vanaf het begin van de zin.
sentiment	SentenceSentimentValue	Het voorspelde gevoel voor de zin.
targets	SentenceTarget[]	De matrix met zindoelen voor de zin.
text	string	De tekst van de zin.

SentenceSentimentValue

Het voorspelde gevoel voor de zin.

Name	Type	Description
negative	string	Negatief gevoel
neutral	string	Neutraal gevoel
positive	string	Positief gevoel

SentenceTarget

Vertegenwoordigt een zinsdoel en de evaluaties of doelobjecten die eraan zijn gerelateerd.

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
length	integer	De lengte van het doel.
offset	integer	Het doelverschil vanaf het begin van de zin.
relations	TargetRelation[]	De matrix van evaluatie- of doelobjecten die is gerelateerd aan het doel.
sentiment	TokenSentimentValue	Het gevoel van de zin.
text	string	De doeltekst gedetecteerd.

SentimentAnalysisTaskParameters

Ondersteunde parameters voor een sentimentanalysetaak.

Name	Type	Standaardwaarde	Description
loggingOptOut	boolean	False	afmelden voor logboekregistratie
modelVersion	string	latest	modelversie
opinionMining	boolean	False	Of u meninganalyse in de aanvraag wilt gebruiken of niet.
stringIndexType	StringIndexType	TextElements_v8	Hiermee geeft u de methode op die wordt gebruikt voor het interpreteren van tekenreeks offsets.

SentimentConfidenceScores

Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 in alle sentimentklassen: positief, neutraal, negatief.

Name	Type	Description
negative	number	Betrouwbaarheidsscore voor negatief gevoel
neutral	number	Betrouwbaarheidsscore voor neutraal gevoel
positive	number	Betrouwbaarheidsscore voor positief gevoel

SentimentDocumentResult

Een object dat de vooraf gemaakte sentimentanalyseresultaten van elk document vertegenwoordigt.

Name	Type	Description
confidenceScores	SentimentConfidenceScores	De gevoelsvertrouwensscore tussen 0 en 1 voor de zin voor alle klassen.
id	string	Unieke, niet-lege document-id.
sentences	SentenceSentiment[]	Het gevoel van zinnen in het document.
sentiment	DocumentSentimentValue	Voorspeld gevoel voor document (negatief, neutraal, positief of gemengd).
statistics	DocumentStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van het document.
warnings	DocumentWarning[]	Er zijn waarschuwingen opgetreden tijdens het verwerken van het document.

SentimentResponse

Resultaten van sentimentanalyse voor de invoerdocumenten.

Name	Type	Description
documents	SentimentDocumentResult[]	De resultaten van de sentimentanalyse voor elk document in de invoer.
errors	DocumentError[]	Fouten per document-id.
modelVersion	string	Dit veld geeft aan welk model wordt gebruikt voor het scoren.
statistics	RequestStatistics	Als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

SentimentTaskResult

Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.

Name	Type	Description
kind	string: SentimentAnalysisResults	Het soort taakresultaat.
results	SentimentResponse	De resultaten van sentimentanalyse

StringIndexType

Type tekenreeksindex

Name	Type	Description
TextElements_v8	string	Geretourneerde offset- en lengtewaarden komen overeen met TextElements (Graphemes- en Grapheme-clusters) die de Unicode 8.0.0-standaard bevestigen. Gebruik deze optie als uw toepassing is geschreven in .Net Framework of .Net Core en u StringInfo gebruikt.
UnicodeCodePoint	string	Geretourneerde offset- en lengtewaarden komen overeen met Unicode-codepunten. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Python.
Utf16CodeUnit	string	Geretourneerde offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Java, JavaScript.

TargetConfidenceScoreLabel

Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.

Name	Type	Description
negative	number	Betrouwbaarheidsscore voor negatief gevoel
positive	number	Betrouwbaarheidsscore voor positief gevoel

TargetRelation

Vertegenwoordigt de relatie tussen evaluaties en/of doelen.

Name	Type	Description
ref	string	De JSON-aanwijzer die het gekoppelde object aangeeft.
relationType	TargetRelationType	Het type dat is gerelateerd aan het doel.

TargetRelationType

Het type dat is gerelateerd aan het doel.

Name	Type	Description
assessment	string	Evaluatierelatie.
target	string	Doelrelatie.

TokenSentimentValue

Het voorspelde gevoel voor de zin.

Name	Type	Description
mixed	string	Gemengd gevoel
negative	string	Negatief gevoel
positive	string	Positief gevoel

WarningCodeValue

Hiermee definieert u de lijst met waarschuwingscodes.

Name	Type	Description
DocumentTruncated	string	Waarschuwing afgekapt document
LongWordsInDocument	string	Waarschuwing voor lange woorden in document

Delen via

Text Analysis Runtime - Analyze Text

URI-parameters

Aanvraagkoptekst

Aanvraagbody

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

SuccessfulEntityLinkingRequest

Sample Request

Sample Response

SuccessfulEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulKeyPhraseExtractionRequest

Sample Request

Sample Response

SuccessfulLanguageDetectionRequest

Sample Request

Sample Response

SuccessfulPiiEntityRecognitionRequest

Sample Request

Sample Response

SuccessfulSentimentAnalysisRequest

Sample Request

Sample Response

Definities

AnalyzeTextEntityLinkingInput

AnalyzeTextEntityRecognitionInput

AnalyzeTextKeyPhraseExtractionInput

AnalyzeTextLanguageDetectionInput

AnalyzeTextPiiEntitiesRecognitionInput

AnalyzeTextSentimentAnalysisInput

AnalyzeTextTaskKind

AnalyzeTextTaskResultsKind

DetectedLanguage

DocumentError

DocumentSentimentValue

DocumentStatistics

DocumentWarning

EntitiesDocumentResult

EntitiesResult

EntitiesTaskParameters

EntitiesTaskResult

Entity

EntityLinkingResult

EntityLinkingTaskParameters

EntityLinkingTaskResult

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

KeyPhraseResult

KeyPhrasesDocumentResult

KeyPhraseTaskParameters

KeyPhraseTaskResult

LanguageDetectionAnalysisInput

LanguageDetectionDocumentResult

LanguageDetectionResult

LanguageDetectionTaskParameters

LanguageDetectionTaskResult

LanguageInput

LinkedEntitiesDocumentResult

LinkedEntity

Match

MultiLanguageAnalysisInput

MultiLanguageInput

PiiCategory

PiiDomain

PiiEntitiesDocumentResult

PiiResult

PiiTaskParameters