Analyze Text - Analyze Text

Service:

Azure AI Services

API-versie:

2026-05-01

Vraag tekstanalyse aan over een verzameling documenten.

POST {Endpoint}/language/:analyze-text?api-version=2026-05-01

Met optionele parameters:

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

URI-parameters

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

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
AnalyzeTextEntityLinkingInput	Bevat de analysetekst Entiteit die invoer koppelt.
AnalyzeTextEntityRecognitionInput	De entiteitsherkenning analyseert de taakaanvraag voor tekstinvoer.
AnalyzeTextKeyPhraseExtractionInput	Bevat de invoer van de taak KeyPhraseExtraction van de tekst analyseren.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van de analyse van het taaldetectiedocument.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de analysetekst PIIEntityRecognition taakinvoer.
AnalyzeTextSentimentAnalysisInput	Bevat de taakinvoer van de tekst SentimentAnalysis analyseren.

AnalyzeTextEntityLinkingInput

Bevat de analysetekst Entiteit die invoer koppelt.

Name	Vereist	Type	Description
kind	True	string: EntityLinking	Het soort taak om uit te voeren.
analysisInput		MultiLanguageAnalysisInput	Bevat de analyse-invoer die door de service moet worden verwerkt.
parameters		EntityLinkingTaskParameters	Taak parameters.

AnalyzeTextEntityRecognitionInput

De entiteitsherkenning analyseert de taakaanvraag voor tekstinvoer.

Name	Vereist	Type	Description
kind	True	string: EntityRecognition	Het soort taak om uit te voeren.
analysisInput		MultiLanguageAnalysisInput	De input die geanalyseerd moet worden.
parameters		EntitiesTaskParameters	Taak parameters.

AnalyzeTextKeyPhraseExtractionInput

Bevat de invoer van de taak KeyPhraseExtraction van de tekst analyseren.

Name	Vereist	Type	Description
kind	True	string: KeyPhraseExtraction	Het soort taak om uit te voeren.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		KeyPhraseTaskParameters	Taakparameters voor het extraheren van sleutelzinnen.

AnalyzeTextLanguageDetectionInput

Bevat de invoer van de analyse van het taaldetectiedocument.

Name	Vereist	Type	Description
kind	True	string: LanguageDetection	Het soort taak om uit te voeren.
analysisInput		LanguageDetectionAnalysisInput	Te analyseren documenten.
parameters		LanguageDetectionTaskParameters	taak parameters.

AnalyzeTextPiiEntitiesRecognitionInput

Bevat de analysetekst PIIEntityRecognition taakinvoer.

Name	Vereist	Type	Description
kind	True	string: PiiEntityRecognition	Het soort taak om uit te voeren.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		PiiTaskParameters	Pii taak parameters.

AnalyzeTextSentimentAnalysisInput

Bevat de taakinvoer van de tekst SentimentAnalysis analyseren.

Name	Vereist	Type	Description
kind	True	string: SentimentAnalysis	Het soort taak om uit te voeren.
analysisInput		MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
parameters		SentimentAnalysisTaskParameters	Taakparameters voor sentimentanalyse.

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionExclusionRequest

SuccessfulPiiEntityRecognitionMaskedEntitiesRequest

SuccessfulPiiEntityRecognitionRedactionPolicyRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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?"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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

SuccessfulPiiEntityRecognitionExclusionRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-01

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "excludePiiCategories": [
      "USSocialSecurityNumber"
    ]
  },
  "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?"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionMaskedEntitiesRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-01

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "redactionPolicies": [
      {
        "policyKind": "entityMask"
      }
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My name is John Doe My phone number is 424 878 9192"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My name is [PERSON_1] My phone number is [PHONENUMBER_1]",
        "entities": [
          {
            "category": "Person",
            "type": "Person",
            "tags": [
              {
                "name": "Person",
                "confidenceScore": 0.65
              }
            ],
            "length": 8,
            "offset": 11,
            "mask": "[Person_1]",
            "maskOffset": 11,
            "maskLength": 9,
            "text": "John Doe",
            "confidenceScore": 0.65
          },
          {
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ],
            "length": 12,
            "offset": 36,
            "mask": "[PHONENUMBER_1]",
            "maskOffset": 41,
            "maskLength": 13,
            "text": "424 878 9192",
            "confidenceScore": 0.8
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionRedactionPolicyRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-01

{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "redactionPolicies": [
      {
        "policyKind": "characterMask",
        "redactionCharacter": "-"
      }
    ]
  },
  "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?"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is -----------",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "type": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "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",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is -------------- your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulPiiEntityRecognitionRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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?"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "type": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "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",
            "type": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "type": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68",
            "tags": [
              {
                "name": "Number",
                "confidenceScore": 0.8
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Voorbeeldaanvraag

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2026-05-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."
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:

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
AgeMetadata	Vertegenwoordigt het metagegevensmodel van de leeftijdsentiteit.
AgeUnit	De maateenheid Leeftijd
AllowOverlapEntityPolicyType	Vertegenwoordigt het beleid voor overlapping toestaan. Past geen nabewerkingslogica toe voor de entiteiten. Wat het model ook voorspelt, is wat er wordt teruggegeven aan de gebruiker. Dit stelt de gebruiker in staat om een volledig beeld te krijgen van de mogelijke waarden van elk afzonderlijk model en zijn eigen aangepaste logica toe te passen op entiteitsselectie
AnalyzeTextEntityLinkingInput	Bevat de analysetekst Entiteit die invoer koppelt.
AnalyzeTextEntityRecognitionInput	De entiteitsherkenning analyseert de taakaanvraag voor tekstinvoer.
AnalyzeTextKeyPhraseExtractionInput	Bevat de invoer van de taak KeyPhraseExtraction van de tekst analyseren.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van de analyse van het taaldetectiedocument.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de analysetekst PIIEntityRecognition taakinvoer.
AnalyzeTextSentimentAnalysisInput	Bevat de taakinvoer van de tekst SentimentAnalysis analyseren.
AnalyzeTextTaskKind	Het soort analyseteksttaken dat wordt ondersteund.
AnalyzeTextTaskResultsKind	Het type antwoordobject dat wordt geretourneerd door de taak Analysetekst.
AreaMetadata	Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.
AreaUnit	De maateenheid.
CharacterMaskPolicyType	Vertegenwoordigt het beleid van redacting met een redaction-teken
ConfidenceScoreThreshold	Configuratie voor betrouwbaarheidsscoredrempel voor herkenning van PII-entiteiten
ConfidenceScoreThresholdOverride	Overschrijven van de drempelwaarde voor de betrouwbaarheidsscore voor een specifieke PII-categorie
CurrencyMetadata	Vertegenwoordigt de entiteit Valuta ) Metagegevensmodel.
DateMetadata	Een metagegevens voor instanties van datumentiteiten.
DateTimeMetadata	Een metagegevens voor instanties van de datetime-entiteit.
DateValue	Vertegenwoordigt de datumwaarde.
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 sentiment 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 waarschuwingsobject met waarschuwingen die zijn aangetroffen voor het verwerkte document.
EntitiesDocumentResultWithMetadata	Resultaat entiteitsdocumenten met metagegevens.
EntitiesResult	Bevat het resultaat van de entiteitsherkenningstaak.
EntitiesTaskParameters	Ondersteunde parameters voor een entiteitsherkenningstaak.
EntitiesTaskResult	Bevat de entiteitstaak
EntityCategory	Bevat alle entiteitscategorieën die worden gedetecteerd door entiteitsherkenning.
EntityInferenceOptions	De klasse die de deductieopties bevat, maakte herkenning van benoemde entiteiten mogelijk.
EntityLinkingResult	Resultaat van de entiteitskoppeling.
EntityLinkingTaskParameters	Ondersteunde parameters voor een taak voor het koppelen van entiteiten.
EntityLinkingTaskResult	Bevat het resultaat van de analysetekst Entiteit die taken koppelt.
EntityMaskPolicyType	Vertegenwoordigt het beleid voor het redacteren van PII met het entiteitstype.
EntitySynonym	De entiteitssynoniemen die worden gebruikt om de detectie van pii-entiteiten te verbeteren
EntitySynonyms	Object waarmee de gebruiker synoniemen kan opgeven voor contextwoorden die de detectie van pii-entiteiten verbeteren.
EntityTag	Entiteitstagobject dat de naam van de tags en een bijbehorende betrouwbaarheidsscore bevat. Entiteitstags worden gebruikt om bepaalde overeenkomsten/affiniteit tussen entiteiten uit te drukken.
EntityWithMetadata	Entiteitsobject met tags en metagegevens.
Error	Het foutantwoordobject wordt geretourneerd wanneer de service enkele fouten tegenkomt tijdens het verwerken van de aanvraag.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InformationMetadata	Vertegenwoordigt het metagegevensmodel van de entiteit Informatie (gegevens).
InformationUnit	De meeteenheid (gegevens).
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens Microsoft One API-richtlijnen - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Bevat de KeyPhraseResult.
KeyPhrasesDocumentResult	Bevat de resultaten van de sleutelwoordgroep voor een document.
KeyPhraseTaskParameters	Ondersteunde parameters voor een taak voor het extraheren van sleuteltermen.
KeyPhraseTaskResult	Bevat het resultaat van de analysetekst KeyPhraseExtraction-taak.
LanguageDetectionAnalysisInput	Bevat de invoer van de analyse van het taaldetectiedocument.
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.
LengthMetadata	Vertegenwoordigt het metagegevensmodel van de entiteit Lengte.
LengthUnit	De lengte-eenheid van de meting.
LinkedEntitiesDocumentResult	Entiteit die documentresultaat koppelt.
LinkedEntity	Het LinkedEntity-object dat de gedetecteerde entiteit met de bijbehorende bronnen/koppelingen bevat.
Match	Het object Vergelijken dat de tekst van de gedetecteerde entiteit bevat met de offset en de lengte.
MatchLongestEntityPolicyType	Vertegenwoordigt het beleid voor de langste overlapping van overeenkomsten. Geen overlappende entiteiten voor zover dat mogelijk is. 1. Als er overlappende entiteiten zijn, wordt de langste geretourneerd. 2. Als de set tekens die voor 2 of meer entiteiten is voorspeld exact hetzelfde is, selecteert u de entiteit met de hoogste betrouwbaarheidsscore.3. Als de entiteitsscores identiek zijn, retourneert u alle entiteiten die nog steeds aanwezig zijn na het toepassen van de vorige regels. 3. Als er sprake is van gedeeltelijke overlap (zoals in Hello Text Analytics), volg dan de bovenstaande stappen vanaf 1.
MetadataKind	De entiteit Metagegevens, objectsoort.
MultiLanguageAnalysisInput	Verzameling van invoerdocumenten die door de dienst moeten worden geanalyseerd.
MultiLanguageInput	Bevat een invoerdocument dat door de service moet worden geanalyseerd.
NoMaskPolicyType	Vertegenwoordigt het beleid voor het niet redacteren van gevonden PII.
NumberKind	Het type geëxtraheerde getalentiteit.
NumberMetadata	Een metagegevens voor instanties van numerieke entiteiten.
NumericRangeMetadata	vertegenwoordigt de metagegevens van numerieke intervallen.
OrdinalMetadata	Een metagegevens voor instanties van numerieke entiteiten.
PiiCategoriesExclude	(Optioneel) beschrijft de PII-categorieën die moeten worden geretourneerd
PiiCategory	(Optioneel) beschrijft de PII-categorieën die moeten worden geretourneerd
PiiDomain	Domein voor PII-taak
PiiEntitiesDocumentResult	Bevat de PII-resultaten.
PiiEntityWithTags	Entiteitsobject met tags.
PiiResult	Bevat de PiiResult.
PiiTaskParameters	Ondersteunde parameters voor een herkenningstaak voor PII-entiteiten.
PiiTaskResult	Bevat de analysetekst PIIEntityRecognition LRO-taak.
RangeInclusivity	De aanbodinclusiviteit van deze woning.
RangeKind	Het type entiteit van het getallenbereik.
redactionCharacter	Optionele parameter voor het gebruik van een aangepast teken dat moet worden gebruikt voor redaction in PII-antwoorden. Het standaardteken zal bce * zijn zoals eerder. We staan specifieke ascii-tekens toe voor redaction.
RelativeTo	Het verwijzingspunt dat het rangnummer aangeeft.
RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.
ScriptCode	Identificeert het script van het invoerdocument. Wordt toegewezen aan de ISO 15924 standaard scriptcode.
ScriptKind	Identificeert het script van het invoerdocument. Komt overeen met de formele naam van de ISO 15924-standaard.
SentenceAssessment	Vertegenwoordigt een zinsbeoordeling en de beoordelingen of doelobjecten die ermee verband houden.
SentenceSentiment	Het zinssentiment van een document.
SentenceSentimentValue	Het voorspelde gevoel voor de zin.
SentenceTarget	Vertegenwoordigt een zinsdoel en de beoordelingen of doelobjecten die daarmee verband houden.
SentimentAnalysisTaskParameters	Ondersteunde parameters voor een taak voor gevoelsanalyse.
SentimentConfidenceScores	Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 voor alle sentimentklassen: positief, neutraal, negatief.
SentimentDocumentResult	Een object dat de vooraf gebouwde resultaten van de sentimentanalyse van elk document vertegenwoordigt.
SentimentResponse	Resultaten van de sentimentanalyse voor de invoerdocumenten.
SentimentTaskResult	Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.
SpeedMetadata	Vertegenwoordigt het metagegevensmodel van de entiteit Snelheid.
SpeedUnit	De snelheidseenheid van de meting
StringIndexType	Type tekenreeksindex
SyntheticReplacementPolicyType	Vertegenwoordigt het beleid van het vervangen van gedetecteerde PII door synthetische waarden.
TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
TargetRelation	Geeft de relatie weer tussen assessments en/of targets.
TargetRelationType	Het type dat is gerelateerd aan het doel.
TemperatureMetadata	Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.
TemperatureUnit	De temperatuureenheid van de meting.
TemporalModifier	Een optionele wijziging van een datum/tijd-exemplaar.
TemporalSetMetadata	A Metagegevens voor tijdelijke set-entiteitsinstanties.
TemporalSpanMetadata	vertegenwoordigt de metadata van een datum en/of tijdspanne.
TemporalSpanValues	Tijdelijke spanwijdte object.
TimeMetadata	A Metagegevens voor instanties van tijdentiteiten.
TokenSentimentValue	Het voorspelde gevoel voor de zin.
ValueExclusionPolicy	Beleid voor specifieke woorden en termen die moeten worden uitgesloten van detectie door de PII-detectieservice
VolumeMetadata	Vertegenwoordigt het metagegevensmodel van de entiteit Volume.
VolumeUnit	De volume-eenheid van de meting
WarningCodeValue	Definieert de lijst met waarschuwingscodes.
WeightMetadata	Vertegenwoordigt het metagegevensmodel van de entiteit Gewicht.
WeightUnit	De gewichtseenheid van de meting.

AgeMetadata

Object

Vertegenwoordigt het metagegevensmodel van de leeftijdsentiteit.

Name	Type	Description
metadataKind	string: AgeMetadata	De entiteit Metagegevens, objectsoort.
unit	AgeUnit	Maateenheid voor leeftijd.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AgeUnit

Opsomming

De maateenheid Leeftijd

Waarde	Description
Unspecified	Onbepaalde tijdsperiode
Year	Tijdsperiode van een jaar
Month	Tijdsperiode van een maand
Week	Tijdsperiode van een week
Day	Tijdsperiode van een dag

AllowOverlapEntityPolicyType

Object

Vertegenwoordigt het beleid voor overlapping toestaan. Past geen nabewerkingslogica toe voor de entiteiten. Wat het model ook voorspelt, is wat er wordt teruggegeven aan de gebruiker. Dit stelt de gebruiker in staat om een volledig beeld te krijgen van de mogelijke waarden van elk afzonderlijk model en zijn eigen aangepaste logica toe te passen op entiteitsselectie

Name	Type	Default value	Description
policyKind	string: allowOverlap	matchLongest	De objectsoort OverlapPolicy.

AnalyzeTextEntityLinkingInput

Object

Bevat de analysetekst Entiteit die invoer koppelt.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de analyse-invoer die door de service moet worden verwerkt.
kind	string: EntityLinking	Het soort taak om uit te voeren.
parameters	EntityLinkingTaskParameters	Taak parameters.

AnalyzeTextEntityRecognitionInput

Object

De entiteitsherkenning analyseert de taakaanvraag voor tekstinvoer.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	De input die geanalyseerd moet worden.
kind	string: EntityRecognition	Het soort taak om uit te voeren.
parameters	EntitiesTaskParameters	Taak parameters.

AnalyzeTextKeyPhraseExtractionInput

Object

Bevat de invoer van de taak KeyPhraseExtraction van de tekst analyseren.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: KeyPhraseExtraction	Het soort taak om uit te voeren.
parameters	KeyPhraseTaskParameters	Taakparameters voor het extraheren van sleutelzinnen.

AnalyzeTextLanguageDetectionInput

Object

Bevat de invoer van de analyse van het taaldetectiedocument.

Name	Type	Description
analysisInput	LanguageDetectionAnalysisInput	Te analyseren documenten.
kind	string: LanguageDetection	Het soort taak om uit te voeren.
parameters	LanguageDetectionTaskParameters	taak parameters.

AnalyzeTextPiiEntitiesRecognitionInput

Object

Bevat de analysetekst PIIEntityRecognition taakinvoer.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: PiiEntityRecognition	Het soort taak om uit te voeren.
parameters	PiiTaskParameters	Pii taak parameters.

AnalyzeTextSentimentAnalysisInput

Object

Bevat de taakinvoer van de tekst SentimentAnalysis analyseren.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: SentimentAnalysis	Het soort taak om uit te voeren.
parameters	SentimentAnalysisTaskParameters	Taakparameters voor sentimentanalyse.

AnalyzeTextTaskKind

Opsomming

Het soort analyseteksttaken dat wordt ondersteund.

Waarde	Description
SentimentAnalysis	Taak voor gevoelsanalyse
EntityRecognition	Taak voor entiteitsherkenning
PiiEntityRecognition	Taak voor herkenning van PII-entiteiten
KeyPhraseExtraction	Taak voor het extraheren van sleutelzinnen
LanguageDetection	Taak voor taaldetectie
EntityLinking	Taak voor het koppelen van entiteiten

AnalyzeTextTaskResultsKind

Opsomming

Het type antwoordobject dat wordt geretourneerd door de taak Analysetekst.

Waarde	Description
SentimentAnalysisResults	Resultaten van de sentimentanalyse
EntityRecognitionResults	Resultaten van entiteitsherkenning
PiiEntityRecognitionResults	Resultaten van herkenning van PII-entiteiten
KeyPhraseExtractionResults	Resultaten van extractie van sleutelzinnen
LanguageDetectionResults	Resultaten van taaldetectie
EntityLinkingResults	Entiteit die resultaten koppelt

AreaMetadata

Object

Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.

Name	Type	Description
metadataKind	string: AreaMetadata	De entiteit Metagegevens, objectsoort.
unit	AreaUnit	Maateenheid voor oppervlakte.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AreaUnit

Opsomming

De maateenheid.

Waarde	Description
Unspecified	Niet-opgegeven vlakeenheid
SquareKilometer	Oppervlakte-eenheid in vierkante kilometers
SquareHectometer	Oppervlakte-eenheid in vierkante hectometer
SquareDecameter	Oppervlakte-eenheid in vierkante decameters
SquareDecimeter	Oppervlakte-eenheid in vierkante decimeters
SquareMeter	Oppervlakte-eenheid in vierkante meters
SquareCentimeter	Oppervlakte-eenheid in vierkante centimeters
SquareMillimeter	Oppervlakte-eenheid in vierkante millimeters
SquareInch	Oppervlakte-eenheid in vierkante inches
SquareFoot	Oppervlakte-eenheid in vierkante voet
SquareMile	Oppervlakte-eenheid in vierkante mijlen
SquareYard	Oppervlakte-eenheid in vierkante meters
Acre	Oppervlakte-eenheid in acres

CharacterMaskPolicyType

Object

Vertegenwoordigt het beleid van redacting met een redaction-teken

Name	Type	Default value	Description
entityTypes	PiiCategoriesExclude[]		(Optioneel) beschrijft de PII-categorieën waarop het redactiebeleid wordt toegepast. Als dit niet is opgegeven, wordt het redactiebeleid toegepast op alle PII-categorieën.
isDefault	boolean	False	(Optioneel) om aan te geven of dit redactiebeleid het standaardbeleid is dat moet worden toegepast wanneer er geen specifiek beleid is gedefinieerd voor een PII-categorie. Slechts één beleid kan als standaard worden gemarkeerd.
policyKind	string: characterMask	characterMask	Het objecttype RedactionPolicy van de entiteit.
policyName	string		(Optionele) naam van het redactiebeleid voor identificatiedoeleinden.
redactionCharacter	redactionCharacter	*	Optionele parameter voor het gebruik van een aangepast teken dat moet worden gebruikt voor redaction in PII-antwoorden. Het standaardteken zal bce * zijn zoals eerder. We staan specifieke ascii-tekens toe voor redaction.

ConfidenceScoreThreshold

Object

Configuratie voor betrouwbaarheidsscoredrempel voor herkenning van PII-entiteiten

Name	Type	Description
default	number (float)	Minimale drempelwaarde voor de betrouwbaarheidsscore voor de PII-entiteiten die in het antwoord moeten worden geretourneerd. Entiteiten met een betrouwbaarheidsscore onder deze drempel worden uitgefilterd. De waarde moet tussen 0,0 en 1,0 liggen
overrides	ConfidenceScoreThresholdOverride[]	Lijst met overschrijdingen van de betrouwbaarheidsscore voor specifieke PII-categorieën

ConfidenceScoreThresholdOverride

Object

Overschrijven van de drempelwaarde voor de betrouwbaarheidsscore voor een specifieke PII-categorie

Name	Type	Description
entity	PiiCategoriesExclude	De PII-categorie waarvoor de drempelwaarde voor de betrouwbaarheidsscore moet worden overschreven
language	string	De 2-letterige ISO 639-1-taal waarvoor de overschrijving van toepassing is. Als dit niet is opgegeven, is de overschrijving van toepassing op alle talen.
value	number (float)	De drempelwaarde voor de betrouwbaarheidsscore voor de opgegeven PII-categorie

CurrencyMetadata

Object

Vertegenwoordigt de entiteit Valuta ) Metagegevensmodel.

Name	Type	Description
iso4217	string	De alfabetische code op basis van een andere ISO-standaard, ISO 3166, waarin de codes voor landnamen worden vermeld. De eerste twee letters van de ISO 4217 drieletterige code zijn hetzelfde als de code voor de landnaam, en, indien mogelijk, komt de derde letter overeen met de eerste letter van de valutanaam.
metadataKind	string: CurrencyMetadata	De entiteit Metagegevens, objectsoort.
unit	string	Munteenheid.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

DateMetadata

Object

Een metagegevens voor instanties van datumentiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateMetadata	De entiteit Metagegevens, objectsoort.

DateTimeMetadata

Object

Een metagegevens voor instanties van de datetime-entiteit.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateTimeMetadata	De entiteit Metagegevens, objectsoort.

DateValue

Object

Vertegenwoordigt de datumwaarde.

Name	Type	Description
modifier	TemporalModifier	Modifier voor datum/tijd om het referentiepunt aan te geven, zoals voor, na enz.
timex	string	Een uitgebreide ISO 8601-datum-/tijdweergave zoals beschreven in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	De werkelijke tijd die de geëxtraheerde tekst aangeeft.

DetectedLanguage

Object

Bevat de details van de gedetecteerde taal voor de tekst.

Name	Type	Description
confidenceScore	number (double)	Een betrouwbaarheidsscore tussen 0 en 1. Scores dichtbij 1 geven aan dat het 100% zeker is dat de geïdentificeerde taal waar is.
iso6391Name	string	Een tweeletterige weergave van de gedetecteerde taal volgens de ISO 639-1-standaard (bijvoorbeeld en fr).
name	string	Lange naam van een gedetecteerde taal (bijvoorbeeld Engels, Frans).
scriptIso15924Code	ScriptCode	Identificeert de scriptcode van het invoerdocument volgens de ISO 15924-norm.
scriptName	ScriptKind	Identificeert de scriptnaam van het invoerdocument volgens de ISO 15924-norm.

DocumentError

Object

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

Name	Type	Description
error	Error	Fout opgetreden.
id	string	De ID van het invoerdocument.

DocumentSentimentValue

Opsomming

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

Waarde	Description
positive	Positieve verklaring
neutral	Neutrale verklaring
negative	Negatieve verklaring
mixed	Gemengde verklaring

DocumentStatistics

Object

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

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

DocumentWarning

Object

Bevat het waarschuwingsobject met waarschuwingen die zijn aangetroffen voor het verwerkte document.

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

EntitiesDocumentResultWithMetadata

Object

Resultaat entiteitsdocumenten met metagegevens.

Name	Type	Description
entities	EntityWithMetadata[]	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

Object

Bevat het resultaat van de entiteitsherkenningstaak.

Name	Type	Description
documents	EntitiesDocumentResultWithMetadata[]	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

Object

Ondersteunde parameters voor een entiteitsherkenningstaak.

Name	Type	Default value	Description
exclusionList	EntityCategory[]		(Optionele) aanvraagparameter die alle entiteiten filtert die zijn opgenomen in de excludeList. Wanneer een gebruiker een excludeList opgeeft, kan deze geen voorspelling terugkrijgen met een entiteit in die lijst. We zullen inclusie toepassenLijst voor uitsluitingLijst
inclusionList	EntityCategory[]		(Optionele) aanvraagparameter die de uitvoer beperkt tot de aangevraagde entiteitstypen die in deze lijst zijn opgenomen. We zullen inclusie toepassenLijst voor uitsluitingLijst
inferenceOptions	EntityInferenceOptions		(Optionele) aanvraagparameter waarmee de gebruiker instellingen kan opgeven voor het uitvoeren van de deductie.
loggingOptOut	boolean	False	Afmelden voor inloggen
modelVersion	string	latest	Model versie
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Optioneel) beschrijft het type overlappingsbeleid dat moet worden toegepast op de ner-uitvoer.
stringIndexType	StringIndexType	TextElements_v8	(Optioneel) parameter om het type tekenreeksindex op te geven dat wordt gebruikt om tekenreeksoffsets te interpreteren. Is standaard ingesteld op TextElements (Graphemen).

EntitiesTaskResult

Object

Bevat de entiteitstaak

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

EntityCategory

Opsomming

Bevat alle entiteitscategorieën die worden gedetecteerd door entiteitsherkenning.

Waarde	Description
Address	Specifieke vermeldingen op straatniveau van locaties: huis-/gebouwnummers, straten, lanen, snelwegen, kruispunten waarnaar bij naam wordt verwezen.
Numeric	Numerieke waarden, waaronder cijfers en getalwoorden.
Age	Leeftijdsgebonden waarden.
Currency	Valutagerelateerde waarden.
Number	Getallen zonder eenheid
NumberRange	Bereik van getallen
Percentage	Percentage-gerelateerde waarden.
Ordinal	Rangtelwoorden.
Temperature	Temperatuurgerelateerde waarden.
Dimension	Afmeting van de afmetingen
Length	Lengte van een object.
Weight	Gewicht van een object.
Height	Hoogte van een object.
Speed	Snelheid van een object.
Area	Oppervlakte van een object.
Volume	Volume van een object.
Information	Maateenheid voor digitale informatie.
Temporal	Items die betrekking hebben op tijd.
Date	Kalenderdatums.
Time	Tijden van de dag.
DateTime	Kalenderdata met tijd.
DateRange	Bereik van data.
TimeRange	Bereik van tijden.
DateTimeRange	Bereik van datum en tijd.
Duration	Duur van de tijd.
SetTemporal	Set van tijdgerelateerde waarden.
Event	Sociale, sportieve, zakelijke, politieke, educatieve, natuurlijke, historische, criminele, gewelddadige, juridische, militaire gebeurtenissen met een getimede periode.
SportsEvent	Waarden die verband houden met sportevenementen.
CulturalEvent	Waarden die verband houden met culturele evenementen.
NaturalEvent	Waarden die verband houden met natuurlijke gebeurtenissen.
Location	Bepaald punt of plaats in de fysieke ruimte.
GPE	Steden, landen/regio's, staten.
City	Stadsgebonden waarden.
State	Staatsgerelateerde waarden.
CountryRegion	Landen- of regiogerelateerde waarden.
Continent	Continent-gerelateerde waarden.
Structural	Door de mens gemaakte structuren.
Airport	Luchthavens.
Geological	Geografische en natuurlijke kenmerken zoals rivieren, oceanen en woestijnen.
Organization	Bedrijven, agentschappen en andere groepen mensen die worden gedefinieerd door een gevestigde organisatiestructuur. Deze labels kunnen bedrijven, politieke partijen/bewegingen, muziekbands, sportclubs, overheidsinstanties en publieke organisaties omvatten. Nationaliteiten of religies zijn geen ORGANISATIE.
OrganizationMedical	Medische bedrijven en groepen.
OrganizationStockExchange	Beursgroepen.
OrganizationSports	Sportgerelateerde organisaties.
Person	Voor-, achter- en tweede namen, namen van fictieve personages en aliassen. Titels, zoals 'Mr.' of 'President', worden niet beschouwd als onderdeel van de genoemde entiteit.
PersonType	Menselijke rollen geclassificeerd door een groepslidmaatschap.
Email	E-mailadressen.
URL	URLs naar websites.
IP	IP-adressen van het netwerk.
PhoneNumber	Telefoonnummers (alleen amerikaanse en EU-telefoonnummers).
Product	Enkele of groep commerciële, verbruiksartikelen, elektronica, voertuigen, voedselgroepen.
ComputingProduct	Computerproducten.
Skill	Een vermogen, vaardigheid of expertise.

EntityInferenceOptions

Object

De klasse die de deductieopties bevat, maakte herkenning van benoemde entiteiten mogelijk.

Name	Type	Default value	Description
excludeNormalizedValues	boolean	False	Optie om de gedetecteerde entiteitswaarden op te nemen/uit te sluiten die moeten worden genormaliseerd en opgenomen in de metagegevens. De numerieke en tijdelijke entiteitstypen ondersteunen normalisatie van waarden.

EntityLinkingResult

Object

Resultaat van de 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

Object

Ondersteunde parameters voor een taak voor het koppelen van entiteiten.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor inloggen
modelVersion	string	latest	Model versie
stringIndexType	StringIndexType	TextElements_v8	Optionele parameter voor het type tekenreeksindex dat wordt gebruikt om tekenreeksoffsets te interpreteren. Is standaard ingesteld op TextElements (Graphemen).

EntityLinkingTaskResult

Object

Bevat het resultaat van de analysetekst Entiteit die taken koppelt.

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

EntityMaskPolicyType

Object

Vertegenwoordigt het beleid voor het redacteren van PII met het entiteitstype.

Name	Type	Default value	Description
entityTypes	PiiCategoriesExclude[]		(Optioneel) beschrijft de PII-categorieën waarop het redactiebeleid wordt toegepast. Als dit niet is opgegeven, wordt het redactiebeleid toegepast op alle PII-categorieën.
isDefault	boolean	False	(Optioneel) om aan te geven of dit redactiebeleid het standaardbeleid is dat moet worden toegepast wanneer er geen specifiek beleid is gedefinieerd voor een PII-categorie. Slechts één beleid kan als standaard worden gemarkeerd.
policyKind	string: entityMask	characterMask	Het objecttype RedactionPolicy van de entiteit.
policyName	string		(Optionele) naam van het redactiebeleid voor identificatiedoeleinden.

EntitySynonym

Object

De entiteitssynoniemen die worden gebruikt om de detectie van pii-entiteiten te verbeteren

Name	Type	Description
language	string	De 2-letterige ISO 639-1-taal is het synoniem
synonym	string	Het synoniem dat voor de context moet worden gebruikt

EntitySynonyms

Object

Object waarmee de gebruiker synoniemen kan opgeven voor contextwoorden die de detectie van pii-entiteiten verbeteren.

Name	Type	Description
entityType	PiiCategoriesExclude	De naam van de entiteit
synonyms	EntitySynonym[]	De synoniemen van de entiteit

EntityTag

Object

Entiteitstagobject dat de naam van de tags en een bijbehorende betrouwbaarheidsscore bevat. Entiteitstags worden gebruikt om bepaalde overeenkomsten/affiniteit tussen entiteiten uit te drukken.

Name	Type	Description
confidenceScore	number (double)	Detectiescore tussen 0 en 1 van de geëxtraheerde entiteit.
name	string	Naam van de tag. Namen van entiteitstags zijn wereldwijd uniek.

EntityWithMetadata

Object

Entiteitsobject met tags en metagegevens.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer (int32)	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Het metagegevensobject van de entiteit.
offset	integer (int32)	Beginpositie voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.
subcategory	string	(Optioneel) Subtype entiteit.
tags	EntityTag[]	Lijst met entiteitstags. Tags zijn bedoeld om enkele overeenkomsten/affiniteit tussen entiteiten uit te drukken.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.
type	string	Een entiteitstype is de laagste (of fijnste) granulariteit waarbij de entiteit is gedetecteerd. Het type wordt toegewezen aan de specifieke metagegevenskenmerken die zijn gekoppeld aan de gedetecteerde entiteit.

Error

Object

Het foutantwoordobject wordt geretourneerd wanneer de service enkele 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 hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Opsomming

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidArgument	Ongeldig argumentfout
Unauthorized	Fout bij onbevoegde toegang
Forbidden	Fout bij verboden toegang
NotFound	Fout niet gevonden
ProjectNotFound	Project niet gevonden fout
OperationNotFound	Fout bij bewerking niet gevonden
AzureCognitiveSearchNotFound	Azure Cognitive Search niet gevonden fout
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search index not found error
TooManyRequests	Fout bij te veel aanvragen
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search index limit bereikt error
InternalServerError	Interne serverfout
ServiceUnavailable	Fout over niet-beschikbaar service
Timeout	Time-outfout
QuotaExceeded	Fout overschreden quotum
Conflict	Conflict fout
Warning	Waarschuwingsfout

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InformationMetadata

Object

Vertegenwoordigt het metagegevensmodel van de entiteit Informatie (gegevens).

Name	Type	Description
metadataKind	string: InformationMetadata	De entiteit Metagegevens, objectsoort.
unit	InformationUnit	Maateenheid ter informatie.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

InformationUnit

Opsomming

De meeteenheid (gegevens).

Waarde	Description
Unspecified	Eenheid voor niet-gespecificeerde gegevensgrootte
Bit	Gegevensgrootte-eenheid in bits
Kilobit	Gegevensgrootte eenheid in kilobits
Megabit	Gegevensgrootte-eenheid in megabits
Gigabit	Gegevensgrootte-eenheid in gigabit
Terabit	Eenheid van gegevensgrootte in terabits
Petabit	Gegevensgrootte-eenheid in petabits
Byte	Gegevensgrootte-eenheid in bytes
Kilobyte	Gegevensgrootte-eenheid in kilobytes
Megabyte	Gegevensgrootte-eenheid in megabytes
Gigabyte	Gegevensgrootte in gigabytes
Terabyte	Gegevensgrootte-eenheid in terabytes
Petabyte	Gegevensgrootte eenheid in petabytes

InnerErrorCode

Opsomming

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidParameterValue	Fout met ongeldige parameterwaarde
KnowledgeBaseNotFound	Fout in Knowledge Base is niet gevonden
AzureCognitiveSearchNotFound	Azure Cognitive Search niet gevonden fout
AzureCognitiveSearchThrottling	Azure Cognitive Search throttling error
ExtractionFailure	Fout bij extractiefout
InvalidRequestBodyFormat	Fout bij ongeldige indeling van aanvraagtekst
EmptyRequest	Fout bij lege aanvraag
MissingInputDocuments	Fout bij ontbrekende invoerdocumenten
InvalidDocument	Ongeldige documentfout
ModelVersionIncorrect	Fout bij onjuiste modelversie
InvalidDocumentBatch	Ongeldige documentbatchfout
UnsupportedLanguageCode	Fout met niet-ondersteunde taalcode
InvalidCountryHint	Fout met ongeldige landhint

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens Microsoft One API-richtlijnen - 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 meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

KeyPhraseResult

Object

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 scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

KeyPhrasesDocumentResult

Object

Bevat de resultaten van de sleutelwoordgroep 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 sleuteltermen 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

Object

Ondersteunde parameters voor een taak voor het extraheren van sleuteltermen.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor inloggen
modelVersion	string	latest	Model versie

KeyPhraseTaskResult

Object

Bevat het resultaat van de analysetekst KeyPhraseExtraction-taak.

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

LanguageDetectionAnalysisInput

Object

Bevat de invoer van de analyse van het taaldetectiedocument.

Name	Type	Description
documents	LanguageInput[]	Lijst van te analyseren documenten.

LanguageDetectionDocumentResult

Object

Bevat de taaldetectie voor een document.

Name	Type	Description
detectedLanguage	DetectedLanguage	Gedetecteerde taal.
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

Object

Bevat het taaldetectieresultaat voor de aanvraag.

Name	Type	Description
documents	LanguageDetectionDocumentResult[]	Opsomming van de taaldetectieresultaten voor elk invoerdocument.
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.

LanguageDetectionTaskParameters

Object

Ondersteunde parameters voor een taaldetectietaak.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor inloggen
modelVersion	string	latest	Model versie

LanguageDetectionTaskResult

Object

Bevat het resultaat van de taaldetectietaak voor de aanvraag.

Name	Type	Description
kind	string: LanguageDetectionResults	Het soort taakresultaat.
results	LanguageDetectionResult	Bevat de resultaten van de taaldetectie.

LanguageInput

Object

Bevat de invoer voor taaldetectie.

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

LengthMetadata

Object

Vertegenwoordigt het metagegevensmodel van de entiteit Lengte.

Name	Type	Description
metadataKind	string: LengthMetadata	De entiteit Metagegevens, objectsoort.
unit	LengthUnit	Maateenheid voor lengte.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

LengthUnit

Opsomming

De lengte-eenheid van de meting.

Waarde	Description
Unspecified	Eenheid zonder gespecificeerde lengte.
Kilometer	Lengte-eenheid in kilometers.
Hectometer	Lengte-eenheid in hectometers.
Decameter	Lengte-eenheid in decameters.
Meter	Lengte-eenheid in meters.
Decimeter	Lengte-eenheid in decimeters.
Centimeter	Lengte-eenheid in centimeters.
Millimeter	Lengte-eenheid in millimeters.
Micrometer	Lengte-eenheid in micrometers.
Nanometer	Lengte-eenheid in nanometer.
Picometer	Lengte-eenheid in picometers.
Mile	Lengte-eenheid in mijlen.
Yard	Lengte-eenheid in yards.
Inch	Lengte-eenheid in inches.
Foot	Lengte-eenheid in voet.
LightYear	Lengte-eenheid in lichtjaren.
Point	Lengte-eenheid in punten.

LinkedEntitiesDocumentResult

Object

Entiteit die documentresultaat koppelt.

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

Object

Het LinkedEntity-object dat de gedetecteerde entiteit met de bijbehorende bronnen/koppelingen bevat.

Name	Type	Description
bingId	string	Unieke id van de herkende entiteit in de Bing Entiteiten zoeken-API.
dataSource	string	Gegevensbron die wordt gebruikt voor het extraheren van entiteitskoppelingen, zoals Wiki/Bing, enzovoort.
id	string	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

Object

Het object Vergelijken dat de tekst van de gedetecteerde entiteit bevat met de offset en de lengte.

Name	Type	Description
confidenceScore	number (double)	Als een bekend item wordt herkend, wordt een decimaal getal dat het betrouwbaarheidsniveau tussen 0 en 1 aangeeft, geretourneerd.
length	integer (int32)	Lengte voor de entiteitovereenkomsttekst.
offset	integer (int32)	Beginpositie voor de entiteitovereenkomsttekst.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

MatchLongestEntityPolicyType

Object

Vertegenwoordigt het beleid voor de langste overlapping van overeenkomsten. Geen overlappende entiteiten voor zover dat mogelijk is. 1. Als er overlappende entiteiten zijn, wordt de langste geretourneerd. 2. Als de set tekens die voor 2 of meer entiteiten is voorspeld exact hetzelfde is, selecteert u de entiteit met de hoogste betrouwbaarheidsscore.3. Als de entiteitsscores identiek zijn, retourneert u alle entiteiten die nog steeds aanwezig zijn na het toepassen van de vorige regels. 3. Als er sprake is van gedeeltelijke overlap (zoals in Hello Text Analytics), volg dan de bovenstaande stappen vanaf 1.

Name	Type	Default value	Description
policyKind	string: matchLongest	matchLongest	De objectsoort OverlapPolicy.

MetadataKind

Opsomming

De entiteit Metagegevens, objectsoort.

Waarde	Description
DateMetadata	Metagegevens voor datumgerelateerde waarden.
DateTimeMetadata	Metagegevens voor datum- en tijdgerelateerde waarden.
TimeMetadata	Metagegevens voor tijdgerelateerde waarden.
TemporalSetMetadata	Metagegevens voor een set tijdgerelateerde waarden.
NumberMetadata	Metagegevens voor numerieke waarden.
OrdinalMetadata	Metadata voor rangtelwoorden.
SpeedMetadata	Metadata voor snelheidsgerelateerde waarden.
WeightMetadata	Metagegevens voor gewichtsgerelateerde waarden.
LengthMetadata	Metagegevens voor lengtegerelateerde waarden.
VolumeMetadata	Metagegevens voor volumegerelateerde waarden.
AreaMetadata	Metadata voor gebiedsgerelateerde waarden.
AgeMetadata	Metadata voor leeftijdsgerelateerde waarden.
InformationMetadata	Metadata voor informatiegerelateerde waarden.
TemperatureMetadata	Metagegevens voor temperatuurgerelateerde waarden.
CurrencyMetadata	Metagegevens voor valutagerelateerde waarden.
NumericRangeMetadata	Metagegevens voor numerieke bereikwaarden.
TemporalSpanMetadata	Metagegevens voor waarden voor tijdelijke spanwijdte.

MultiLanguageAnalysisInput

Object

Verzameling van invoerdocumenten die door de dienst moeten worden geanalyseerd.

Name	Type	Description
documents	MultiLanguageInput[]	De te analyseren invoerdocumenten.

MultiLanguageInput

Object

Bevat een invoerdocument dat door de service moet worden geanalyseerd.

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 deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling. (Het volgende geldt alleen voor 2023-04-15-preview en hoger) Gebruik "auto" voor automatische taaldetectie. Als dit niet is ingesteld, gebruikt u standaard "en" voor Engels.
text	string	De invoertekst die moet worden verwerkt.

NoMaskPolicyType

Object

Vertegenwoordigt het beleid voor het niet redacteren van gevonden PII.

Name	Type	Default value	Description
entityTypes	PiiCategoriesExclude[]		(Optioneel) beschrijft de PII-categorieën waarop het redactiebeleid wordt toegepast. Als dit niet is opgegeven, wordt het redactiebeleid toegepast op alle PII-categorieën.
isDefault	boolean	False	(Optioneel) om aan te geven of dit redactiebeleid het standaardbeleid is dat moet worden toegepast wanneer er geen specifiek beleid is gedefinieerd voor een PII-categorie. Slechts één beleid kan als standaard worden gemarkeerd.
policyKind	string: noMask	characterMask	Het objecttype RedactionPolicy van de entiteit.
policyName	string		(Optionele) naam van het redactiebeleid voor identificatiedoeleinden.

NumberKind

Opsomming

Het type geëxtraheerde getalentiteit.

Waarde	Description
Integer	Geheel getal
Decimal	Decimaal getal
Power	Machtsnummer
Fraction	Breuknummer
Percent	Percentagenummer
Unspecified	Niet-opgegeven soort getallen

NumberMetadata

Object

Een metagegevens voor instanties van numerieke entiteiten.

Name	Type	Description
metadataKind	string: NumberMetadata	De entiteit Metagegevens, objectsoort.
numberKind	NumberKind	Een beetje het cijfertype.
value	number (double)	Een numerieke weergave van wat de geëxtraheerde tekst aangeeft.

NumericRangeMetadata

Object

vertegenwoordigt de metagegevens van numerieke intervallen.

Name	Type	Description
maximum	number (double)	De eindwaarde van het interval.
metadataKind	string: NumericRangeMetadata	De entiteit Metagegevens, objectsoort.
minimum	number (double)	De beginwaarde van het interval.
rangeInclusivity	RangeInclusivity	De inclusiviteit van dit assortiment.
rangeKind	RangeKind	Soort ondersteunde numerieke bereiken, zoals getal, snelheid, enz.

OrdinalMetadata

Object

Een metagegevens voor instanties van numerieke entiteiten.

Name	Type	Description
metadataKind	string: OrdinalMetadata	De entiteit Metagegevens, objectsoort.
offset	string	De offset met betrekking tot de verwijzing (bijvoorbeeld offset = -1 geeft de tweede tot laatste aan)
relativeTo	RelativeTo	Het verwijzingspunt dat het rangnummer aangeeft.
value	string	Een eenvoudige rekenkundige expressie die de rangtelwoorden aangeeft.

PiiCategoriesExclude

Opsomming

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

Waarde	Description
ABARoutingNumber	ABA Routing nummer
ARNationalIdentityNumber	AR nationaal identiteitsnummer
AUBankAccountNumber	AT bankrekeningnummer
AUDriversLicenseNumber	AU Rijbewijsnummer
AUMedicalAccountNumber	AU Medisch rekeningnummer
AUPassportNumber	AU Paspoortnummer
AUTaxFileNumber	AU Fiscaal Dossiernummer
AUBusinessNumber	AU-ondernemingsnummer
AUCompanyNumber	AU Ondernemingsnummer
ATIdentityCard	AT-identiteitskaart
ATTaxIdentificationNumber	AT-identificatienummer
ATValueAddedTaxNumber	AT Btw-nummer
AzureDocumentDBAuthKey	Azure Document DB Auth Key
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS Database Connection And SQL String
AzureIoTConnectionString	Azure IoT-verbindingsreeks
AzurePublishSettingPassword	Wachtwoord voor publicatie-instelling in Azure
AzureRedisCacheString	Azure Redis Cache String
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus String
AzureStorageAccountKey	Azure Storage account sleutel
AzureStorageAccountGeneric	Azure Storage Account Generic
BENationalNumber	BE Nationaal Nummer
BENationalNumberV2	BE Nationaal Nummer V2
BEValueAddedTaxNumber	BE Btw-nummer
BRCPFNumber	BR CPF-nummer
BRLegalEntityNumber	BR Nummer van de juridische entiteit
BRNationalIDRG	BR Nationale ID RG
BGUniformCivilNumber	BG Uniform Burgerlijk Nummer
CABankAccountNumber	CA bankrekeningnummer
CADriversLicenseNumber	CA Rijbewijs Nummer
CAHealthServiceNumber	CA Health Service Nummer
CAPassportNumber	CA Paspoortnummer
CAPersonalHealthIdentification	CA persoonlijke gezondheidsidentificatie
CASocialInsuranceNumber	CA Burgerservicenummer
CLIdentityCardNumber	Nummer van de CL-identiteitskaart
CNResidentIdentityCardNumber	Identiteitskaartnummer van CN-ingezetenen
CreditCardNumber	Creditcardnummer
HRIdentityCardNumber	Nummer van de HR-identiteitskaart
HRNationalIDNumber	HR nationaal ID-nummer
HRPersonalIdentificationNumber	Persoonlijk HR-identificatienummer
HRPersonalIdentificationOIBNumberV2	HR Persoonlijke identificatie OIB-nummer V2
CYIdentityCard	CY-identiteitskaart
CYTaxIdentificationNumber	CY fiscaal identificatienummer
CZPersonalIdentityNumber	CZ Persoonlijk Identificatienummer
CZPersonalIdentityV2	CZ Persoonlijke Identiteit V2
DKPersonalIdentificationNumber	DK persoonlijk identificatienummer
DKPersonalIdentificationV2	DK Persoonlijke identificatie V2
DrugEnforcementAgencyNumber	Nummer van de Drug Enforcement Agency
EEPersonalIdentificationCode	EE persoonlijke identificatiecode
EUDebitCardNumber	EU-debetkaartnummer
EUDriversLicenseNumber	EU-rijbewijsnummer
EUGPSCoordinates	EU GPS-coördinaten
EUNationalIdentificationNumber	Nationaal EU-identificatienummer
EUPassportNumber	EU-paspoortnummer
EUSocialSecurityNumber	EU-burgerservicenummer
EUTaxIdentificationNumber	EU-belastingidentificatienummer
FIEuropeanHealthNumber	FI Europees gezondheidsnummer
FINationalID	FI Nationale ID
FINationalIDV2	FI Nationale ID V2
FIPassportNumber	FI Paspoortnummer
FRDriversLicenseNumber	FR Rijbewijsnummer
FRHealthInsuranceNumber	FR Ziekteverzekeringsnummer
FRNationalID	FR Nationale identiteitskaart
FRPassportNumber	FR Paspoortnummer
FRSocialSecurityNumber	FR Sofinummer
FRTaxIdentificationNumber	FR Fiscaal identificatienummer
FRValueAddedTaxNumber	FR Btw-nummer
DEDriversLicenseNumber	DE Rijbewijsnummer
DEPassportNumber	DE Paspoortnummer
DEIdentityCardNumber	DE Identiteitskaart Nummer
DETaxIdentificationNumber	DE Fiscaal Identificatienummer
DEValueAddedNumber	DE Nummer Toegevoegde Waarde
GRNationalIDCard	GR Nationale identiteitskaart
GRNationalIDV2	GR Nationale ID V2
GRTaxIdentificationNumber	GR Fiscaal Identificatienummer
HKIdentityCardNumber	HK Identiteitskaart Nummer
HUValueAddedNumber	HU Toegevoegde waarde
HUPersonalIdentificationNumber	HU persoonlijk identificatienummer
HUTaxIdentificationNumber	HU Fiscaal Identificatienummer
INPermanentAccount	IN Permanente Rekening
INUniqueIdentificationNumber	IN Uniek identificatienummer
IDIdentityCardNumber	ID Identiteitskaart Nummer
InternationalBankingAccountNumber	Internationaal bankrekeningnummer
IEPersonalPublicServiceNumber	IE Persoonlijk Public Service Nummer
IEPersonalPublicServiceNumberV2	IE Persoonlijk Nummer van de Openbare Dienst V2
ILBankAccountNumber	IL Bankrekeningnummer
ILNationalID	IL nationale identiteitskaart
ITDriversLicenseNumber	IT-rijbewijsnummer
ITFiscalCode	IT Fiscaal Wetboek
ITValueAddedTaxNumber	IT-nummer voor de toegevoegde waarde
JPBankAccountNumber	JP Bankrekening Nummer
JPDriversLicenseNumber	JP Rijbewijsnummer
JPPassportNumber	JP Paspoortnummer
JPResidentRegistrationNumber	Registratienummer voor ingezetenen van JP
JPSocialInsuranceNumber	JP Sofinummer
JPMyNumberCorporate	JP Mijn nummer Corporate
JPMyNumberPersonal	JP Mijn nummer persoonlijk
JPResidenceCardNumber	JP Residence Card-nummer
LVPersonalCode	LV Persoonlijke Code
LTPersonalCode	LT Persoonlijke Code
LUNationalIdentificationNumberNatural	LU Nationaal Identificatienummer Natuurlijk
LUNationalIdentificationNumberNonNatural	LU Nationaal Identificatienummer Niet Natuurlijk
MYIdentityCardNumber	MIJN identiteitskaart nummer
MTIdentityCardNumber	MT Identiteitskaart Nummer
MTTaxIDNumber	MT Fiscaal identificatienummer
NLCitizensServiceNumber	NL Burgerservicenummer
NLCitizensServiceNumberV2	NL Burgerservicenummer V2
NLTaxIdentificationNumber	NL Fiscaal Identificatienummer
NLValueAddedTaxNumber	NL Btw-nummer
NZBankAccountNumber	NZ bankrekeningnummer
NZDriversLicenseNumber	NZ Rijbewijs Nummer
NZInlandRevenueNumber	NZ Inland Revenue Nummer
NZMinistryOfHealthNumber	NZ Ministerie van Volksgezondheid Nummer
NZSocialWelfareNumber	NZ Sociaal Nummer
NOIdentityNumber	GEEN identiteitsnummer
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID-nummer
PLIdentityCard	PL-identiteitskaart
PLNationalID	PL Nationale ID
PLNationalIDV2	PL Nationale ID V2
PLPassportNumber	PL Paspoortnummer
PLTaxIdentificationNumber	PL Fiscaal identificatienummer
PLREGONNumber	PL REGON-nummer
PTCitizenCardNumber	PT Burger Kaart Nummer
PTCitizenCardNumberV2	PT Burger Kaart Nummer V2
PTTaxIdentificationNumber	PT Fiscaal identificatienummer
ROPersonalNumericalCode	RO Persoonlijke Cijfercode
RUPassportNumberDomestic	RU Paspoortnummer Binnenlands
RUPassportNumberInternational	RU Paspoortnummer Internationaal
SANationalID	SA Nationale ID
SGNationalRegistrationIdentityCardNumber	SG Nationaal Registratie Identiteitskaart Nummer
SKPersonalNumber	SK Persoonlijk nummer
SITaxIdentificationNumber	SI Fiscaal Identificatienummer
SIUniqueMasterCitizenNumber	SI Uniek Master Citizen-nummer
ZAIdentificationNumber	ZA-identificatienummer
KRResidentRegistrationNumber	Registratienummer voor KR-ingezetenen
ESDNI	ES DNI
ESSocialSecurityNumber	ES Sofinummer
ESTaxIdentificationNumber	ES fiscaal identificatienummer
SQLServerConnectionString	SQL Server-verbindingsreeks
SENationalID	SE nationale identiteitskaart
SENationalIDV2	SE Nationale ID V2
SEPassportNumber	SE Paspoortnummer
SETaxIdentificationNumber	SE Fiscaal Identificatienummer
SWIFTCode	SWIFT-code
CHSocialSecurityNumber	CH Burgerservicenummer
TWNationalID	TW Nationale ID
TWPassportNumber	TW Paspoortnummer
TWResidentCertificate	TW Resident Certificaat
THPopulationIdentificationCode	TH Bevolking Identificatiecode
TRNationalIdentificationNumber	TR nationaal identificatienummer
UKDriversLicenseNumber	Brits rijbewijsnummer
UKElectoralRollNumber	Nummer van de Britse kiezerslijst
UKNationalHealthNumber	Brits nationaal gezondheidsnummer
UKNationalInsuranceNumber	Brits nationaal verzekeringsnummer
UKUniqueTaxpayerNumber	Uniek belastingnummer in het VK
USUKPassportNumber	Amerikaans Brits paspoortnummer
USBankAccountNumber	Amerikaans bankrekeningnummer
USDriversLicenseNumber	Amerikaans rijbewijsnummer
USIndividualTaxpayerIdentification	Identificatie van individuele belastingbetalers in de VS
USSocialSecurityNumber	Amerikaans burgerservicenummer
UAPassportNumberDomestic	UA Paspoortnummer Binnenlands
UAPassportNumberInternational	UA Paspoortnummer Internationaal
Organization	Organization
Email	E-mailadres
URL	URL
Age	Leeftijd
PhoneNumber	Telefoonnummer
IPAddress	IP-adres
Date	Datum
Person	Persoon
Address	Adres
DateOfBirth	Geboortedatum
BankAccountNumber	Bankrekeningnummer
PassportNumber	Paspoortnummer
DriversLicenseNumber	Rijbewijs nummer
SortCode	Code sorteren. 6-cijferig nummer dat in het VK wordt gebruikt om een specifieke bank en filiaal te identificeren waar een bankrekening wordt aangehouden
PIN	Pincode
VehicleIdentificationNumber	VIN
LicensePlate	Nummerplaat
KRPassportNumber	KR Paspoortnummer
KRDriversLicenseNumber	KR Rijbewijsnummer
KRSocialSecurityNumber	KR Burgerservicenummer
GovernmentIssuedId	Door de overheid uitgegeven identiteitsbewijs
Password	Wachtwoord
NationalId	Nationale identificatie
ZipCode	Postcode
CVV	Waarde kaartverificatie
ExpirationDate	Vervaldatum
CASocialIdentificationNumber	CA Sociaal identificatienummer
USMedicareBeneficiaryId	Medicare-begunstigde-ID
Location	Location
City	City
State	State
Airport	Luchthaven
GPE	Geopolitieke entiteit

PiiCategory

Opsomming

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

Waarde	Description
ABARoutingNumber	ABA Routing nummer
ARNationalIdentityNumber	AR nationaal identiteitsnummer
AUBankAccountNumber	AT bankrekeningnummer
AUDriversLicenseNumber	AU Rijbewijsnummer
AUMedicalAccountNumber	AU Medisch rekeningnummer
AUPassportNumber	AU Paspoortnummer
AUTaxFileNumber	AU Fiscaal Dossiernummer
AUBusinessNumber	AU-ondernemingsnummer
AUCompanyNumber	AU Ondernemingsnummer
ATIdentityCard	AT-identiteitskaart
ATTaxIdentificationNumber	AT-identificatienummer
ATValueAddedTaxNumber	AT Btw-nummer
AzureDocumentDBAuthKey	Azure Document DB Auth Key
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS Database Connection And SQL String
AzureIoTConnectionString	Azure IoT-verbindingsreeks
AzurePublishSettingPassword	Wachtwoord voor publicatie-instelling in Azure
AzureRedisCacheString	Azure Redis Cache String
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus String
AzureStorageAccountKey	Azure Storage account sleutel
AzureStorageAccountGeneric	Azure Storage Account Generic
BENationalNumber	BE Nationaal Nummer
BENationalNumberV2	BE Nationaal Nummer V2
BEValueAddedTaxNumber	BE Btw-nummer
BRCPFNumber	BR CPF-nummer
BRLegalEntityNumber	BR Nummer van de juridische entiteit
BRNationalIDRG	BR Nationale ID RG
BGUniformCivilNumber	BG Uniform Burgerlijk Nummer
CABankAccountNumber	CA bankrekeningnummer
CADriversLicenseNumber	CA Rijbewijs Nummer
CAHealthServiceNumber	CA Health Service Nummer
CAPassportNumber	CA Paspoortnummer
CAPersonalHealthIdentification	CA persoonlijke gezondheidsidentificatie
CASocialInsuranceNumber	CA Burgerservicenummer
CLIdentityCardNumber	Nummer van de CL-identiteitskaart
CNResidentIdentityCardNumber	Identiteitskaartnummer van CN-ingezetenen
CreditCardNumber	Creditcardnummer
HRIdentityCardNumber	Nummer van de HR-identiteitskaart
HRNationalIDNumber	HR nationaal ID-nummer
HRPersonalIdentificationNumber	Persoonlijk HR-identificatienummer
HRPersonalIdentificationOIBNumberV2	HR Persoonlijke identificatie OIB-nummer V2
CYIdentityCard	CY-identiteitskaart
CYTaxIdentificationNumber	CY fiscaal identificatienummer
CZPersonalIdentityNumber	CZ Persoonlijk Identificatienummer
CZPersonalIdentityV2	CZ Persoonlijke Identiteit V2
DKPersonalIdentificationNumber	DK persoonlijk identificatienummer
DKPersonalIdentificationV2	DK Persoonlijke identificatie V2
DrugEnforcementAgencyNumber	Nummer van de Drug Enforcement Agency
EEPersonalIdentificationCode	EE persoonlijke identificatiecode
EUDebitCardNumber	EU-debetkaartnummer
EUDriversLicenseNumber	EU-rijbewijsnummer
EUGPSCoordinates	EU GPS-coördinaten
EUNationalIdentificationNumber	Nationaal EU-identificatienummer
EUPassportNumber	EU-paspoortnummer
EUSocialSecurityNumber	EU-burgerservicenummer
EUTaxIdentificationNumber	EU-belastingidentificatienummer
FIEuropeanHealthNumber	FI Europees gezondheidsnummer
FINationalID	FI Nationale ID
FINationalIDV2	FI Nationale ID V2
FIPassportNumber	FI Paspoortnummer
FRDriversLicenseNumber	FR Rijbewijsnummer
FRHealthInsuranceNumber	FR Ziekteverzekeringsnummer
FRNationalID	FR Nationale identiteitskaart
FRPassportNumber	FR Paspoortnummer
FRSocialSecurityNumber	FR Sofinummer
FRTaxIdentificationNumber	FR Fiscaal identificatienummer
FRValueAddedTaxNumber	FR Btw-nummer
DEDriversLicenseNumber	DE Rijbewijsnummer
DEPassportNumber	DE Paspoortnummer
DEIdentityCardNumber	DE Identiteitskaart Nummer
DETaxIdentificationNumber	DE Fiscaal Identificatienummer
DEValueAddedNumber	DE Nummer Toegevoegde Waarde
GRNationalIDCard	GR Nationale identiteitskaart
GRNationalIDV2	GR Nationale ID V2
GRTaxIdentificationNumber	GR Fiscaal Identificatienummer
HKIdentityCardNumber	HK Identiteitskaart Nummer
HUValueAddedNumber	HU Toegevoegde waarde
HUPersonalIdentificationNumber	HU persoonlijk identificatienummer
HUTaxIdentificationNumber	HU Fiscaal Identificatienummer
INPermanentAccount	IN Permanente Rekening
INUniqueIdentificationNumber	IN Uniek identificatienummer
IDIdentityCardNumber	ID Identiteitskaart Nummer
InternationalBankingAccountNumber	Internationaal bankrekeningnummer
IEPersonalPublicServiceNumber	IE Persoonlijk Public Service Nummer
IEPersonalPublicServiceNumberV2	IE Persoonlijk Nummer van de Openbare Dienst V2
ILBankAccountNumber	IL Bankrekeningnummer
ILNationalID	IL nationale identiteitskaart
ITDriversLicenseNumber	IT-rijbewijsnummer
ITFiscalCode	IT Fiscaal Wetboek
ITValueAddedTaxNumber	IT-nummer voor de toegevoegde waarde
JPBankAccountNumber	JP Bankrekening Nummer
JPDriversLicenseNumber	JP Rijbewijsnummer
JPPassportNumber	JP Paspoortnummer
JPResidentRegistrationNumber	Registratienummer voor ingezetenen van JP
JPSocialInsuranceNumber	JP Sofinummer
JPMyNumberCorporate	JP Mijn nummer Corporate
JPMyNumberPersonal	JP Mijn nummer persoonlijk
JPResidenceCardNumber	JP Residence Card-nummer
LVPersonalCode	LV Persoonlijke Code
LTPersonalCode	LT Persoonlijke Code
LUNationalIdentificationNumberNatural	LU Nationaal Identificatienummer Natuurlijk
LUNationalIdentificationNumberNonNatural	LU Nationaal Identificatienummer Niet Natuurlijk
MYIdentityCardNumber	MIJN identiteitskaart nummer
MTIdentityCardNumber	MT Identiteitskaart Nummer
MTTaxIDNumber	MT Fiscaal identificatienummer
NLCitizensServiceNumber	NL Burgerservicenummer
NLCitizensServiceNumberV2	NL Burgerservicenummer V2
NLTaxIdentificationNumber	NL Fiscaal Identificatienummer
NLValueAddedTaxNumber	NL Btw-nummer
NZBankAccountNumber	NZ bankrekeningnummer
NZDriversLicenseNumber	NZ Rijbewijs Nummer
NZInlandRevenueNumber	NZ Inland Revenue Nummer
NZMinistryOfHealthNumber	NZ Ministerie van Volksgezondheid Nummer
NZSocialWelfareNumber	NZ Sociaal Nummer
NOIdentityNumber	GEEN identiteitsnummer
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID-nummer
PLIdentityCard	PL-identiteitskaart
PLNationalID	PL Nationale ID
PLNationalIDV2	PL Nationale ID V2
PLPassportNumber	PL Paspoortnummer
PLTaxIdentificationNumber	PL Fiscaal identificatienummer
PLREGONNumber	PL REGON-nummer
PTCitizenCardNumber	PT Burger Kaart Nummer
PTCitizenCardNumberV2	PT Burger Kaart Nummer V2
PTTaxIdentificationNumber	PT Fiscaal identificatienummer
ROPersonalNumericalCode	RO Persoonlijke Cijfercode
RUPassportNumberDomestic	RU Paspoortnummer Binnenlands
RUPassportNumberInternational	RU Paspoortnummer Internationaal
SANationalID	SA Nationale ID
SGNationalRegistrationIdentityCardNumber	SG Nationaal Registratie Identiteitskaart Nummer
SKPersonalNumber	SK Persoonlijk nummer
SITaxIdentificationNumber	SI Fiscaal Identificatienummer
SIUniqueMasterCitizenNumber	SI Uniek Master Citizen-nummer
ZAIdentificationNumber	ZA-identificatienummer
KRResidentRegistrationNumber	Registratienummer voor KR-ingezetenen
ESDNI	ES DNI
ESSocialSecurityNumber	ES Sofinummer
ESTaxIdentificationNumber	ES fiscaal identificatienummer
SQLServerConnectionString	SQL Server-verbindingsreeks
SENationalID	SE nationale identiteitskaart
SENationalIDV2	SE Nationale ID V2
SEPassportNumber	SE Paspoortnummer
SETaxIdentificationNumber	SE Fiscaal Identificatienummer
SWIFTCode	SWIFT-code
CHSocialSecurityNumber	CH Burgerservicenummer
TWNationalID	TW Nationale ID
TWPassportNumber	TW Paspoortnummer
TWResidentCertificate	TW Resident Certificaat
THPopulationIdentificationCode	TH Bevolking Identificatiecode
TRNationalIdentificationNumber	TR nationaal identificatienummer
UKDriversLicenseNumber	Brits rijbewijsnummer
UKElectoralRollNumber	Nummer van de Britse kiezerslijst
UKNationalHealthNumber	Brits nationaal gezondheidsnummer
UKNationalInsuranceNumber	Brits nationaal verzekeringsnummer
UKUniqueTaxpayerNumber	Uniek belastingnummer in het VK
USUKPassportNumber	Amerikaans Brits paspoortnummer
USBankAccountNumber	Amerikaans bankrekeningnummer
USDriversLicenseNumber	Amerikaans rijbewijsnummer
USIndividualTaxpayerIdentification	Identificatie van individuele belastingbetalers in de VS
USSocialSecurityNumber	Amerikaans burgerservicenummer
UAPassportNumberDomestic	UA Paspoortnummer Binnenlands
UAPassportNumberInternational	UA Paspoortnummer Internationaal
Organization	Organization
Email	E-mailadres
URL	URL
Age	Leeftijd
PhoneNumber	Telefoonnummer
IPAddress	IP-adres
Date	Datum
Person	Persoon
Address	Adres
DateOfBirth	Geboortedatum
BankAccountNumber	Bankrekeningnummer
PassportNumber	Paspoortnummer
DriversLicenseNumber	Rijbewijs nummer
SortCode	Code sorteren. 6-cijferig nummer dat in het VK wordt gebruikt om een specifieke bank en filiaal te identificeren waar een bankrekening wordt aangehouden
PIN	Pincode
VehicleIdentificationNumber	VIN
LicensePlate	Nummerplaat
KRPassportNumber	KR Paspoortnummer
KRDriversLicenseNumber	KR Rijbewijsnummer
KRSocialSecurityNumber	KR Burgerservicenummer
GovernmentIssuedId	Door de overheid uitgegeven identiteitsbewijs
Password	Wachtwoord
NationalId	Nationale identificatie
ZipCode	Postcode
CVV	Waarde kaartverificatie
ExpirationDate	Vervaldatum
CASocialIdentificationNumber	CA Sociaal identificatienummer
USMedicareBeneficiaryId	Medicare-begunstigde-ID
Location	Location
City	City
State	State
Airport	Luchthaven
GPE	Geopolitieke entiteit
All	Alle PII-categorieën.
Default	Standaard PII-categorieën voor de taal.

PiiDomain

Opsomming

Domein voor PII-taak

Waarde	Description
phi	Geeft aan dat entiteiten in het domein Persoonlijke gezondheidsinformatie moeten worden geredigeerd.
none	Geeft aan dat er geen domein is opgegeven.

PiiEntitiesDocumentResult

Object

Bevat de PII-resultaten.

Name	Type	Description
entities	PiiEntityWithTags[]	Herkende entiteiten in het document.
id	string	Unieke, niet-lege document-id.
redactedText	string	Retourneert redacted text.
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.

PiiEntityWithTags

Object

Entiteitsobject met tags.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number (double)	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer (int32)	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
mask	string	Optioneel veld dat alleen wordt geretourneerd bij gebruik van het redactiebeleid type "MaskWithEntityType". Dit veld bevat de exacte maskertekst die is gebruikt om de PII-entiteit in de oorspronkelijke tekst te maskeren
maskLength	integer (int32)	De lengte van de gemaskeerde tekst. Zal aanwezig zijn bij het gebruik van het redactiebeleidstype "MaskWithEntityType".
maskOffset	integer (int32)	Startpositie van gemaskeerde tekst in de geredigeerde tekst bij gebruik van het redactiebeleidstype "MaskWithEntityType".
offset	integer (int32)	Beginpositie voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de offset die wordt geretourneerd.
subcategory	string	(Optioneel) Subtype entiteit.
tags	EntityTag[]	Lijst met entiteitstags. Tags zijn bedoeld om enkele overeenkomsten/affiniteit tussen entiteiten uit te drukken.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.
type	string	Een entiteitstype is de laagste (of fijnste) granulariteit waarbij de entiteit is gedetecteerd. Het type wordt toegewezen aan de specifieke metagegevenskenmerken die zijn gekoppeld aan de gedetecteerde entiteit.

PiiResult

Object

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 scoren.
statistics	RequestStatistics	als showStats=true is opgegeven in de aanvraag, bevat dit veld informatie over de nettolading van de aanvraag.

PiiTaskParameters

Object

Ondersteunde parameters voor een herkenningstaak voor PII-entiteiten.

Name	Type	Default value	Description
confidenceScoreThreshold	ConfidenceScoreThreshold		Configuratie van de betrouwbaarheidsscoredrempel voor herkenning van PII-entiteiten
disableEntityValidation	boolean	False	Entiteitsvalidatie uitschakelen voor PII-entiteitsherkenning
domain	PiiDomain	none	Domein voor PII-taak
entitySynonyms	EntitySynonyms[]		(Optionele) aanvraagparameter waarmee de gebruiker synoniemen kan opgeven voor contextwoorden die de detectie van pii-entiteiten verbeteren.
excludePiiCategories	PiiCategoriesExclude[]		Opsomming van PII-categorieën die moeten worden uitgesloten in het antwoord.
loggingOptOut	boolean	True	Afmelden voor inloggen
modelVersion	string	latest	Model versie
piiCategories	PiiCategory[]		Opsomming van PII-categorieën die in het antwoord moeten worden geretourneerd.
redactionPolicies	BaseRedactionPolicy[]: CharacterMaskPolicyType[] EntityMaskPolicyType[] NoMaskPolicyType[] SyntheticReplacementPolicyType[]		Lijst met redactiebeleid dat op de invoer moet worden gebruikt.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType te gebruiken voor analyse.
valueExclusionPolicy	ValueExclusionPolicy		Beleid voor specifieke woorden en termen die moeten worden uitgesloten van detectie door de PII-detectieservice

PiiTaskResult

Object

Bevat de analysetekst PIIEntityRecognition LRO-taak.

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

RangeInclusivity

Opsomming

De aanbodinclusiviteit van deze woning.

Waarde	Description
NoneInclusive	Geen inclusiviteit
LeftInclusive	Linkerzijde inclusief
RightInclusive	Rechterkant inclusief
LeftRightInclusive	Beide zijden inclusief

RangeKind

Opsomming

Het type entiteit van het getallenbereik.

Waarde	Description
Number	Getalbereik
Speed	Snelheidsbereik
Weight	Gewichtsbereik
Length	Lengtebereik
Volume	Volumebereik
Area	Gebiedsbereik
Age	Leeftijdsbereik
Information	Informatiebereik
Temperature	Temperatuurbereik
Currency	Valutabereik

redactionCharacter

Opsomming

Optionele parameter voor het gebruik van een aangepast teken dat moet worden gebruikt voor redaction in PII-antwoorden. Het standaardteken zal bce * zijn zoals eerder. We staan specifieke ascii-tekens toe voor redaction.

Waarde	Description
!	Uitroepteken
#	Teken voor nummerteken
$	Dollartekenteken
%	Procentteken
&	Ampersand-teken
*	Sterretje
+	Plusteken
-	Minteken
=	Gelijktekenteken
?	Vraagteken
@	Bij tekenteken
^	Caret-teken
_	Onderstrepingsteken
~	Tilde-teken

RelativeTo

Opsomming

Het verwijzingspunt dat het rangnummer aangeeft.

Waarde	Description
Current	Huidige staat of positie
End	Eindtoestand of -positie
Start	Startstatus of positie

RequestStatistics

Object

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

Name	Type	Description
documentsCount	integer (int32)	Het aantal documenten dat in de aanvraag is ingediend.
erroneousDocumentsCount	integer (int32)	Aantal ongeldige documenten. Dit omvat lege, te grote limieten of niet-ondersteunde talendocumenten.
transactionsCount	integer (int64)	Aantal transacties voor de aanvraag.
validDocumentsCount	integer (int32)	Aantal geldige documenten. Dit sluit lege, te grote limieten of niet-ondersteunde talendocumenten uit.

ScriptCode

Opsomming

Identificeert het script van het invoerdocument. Wordt toegewezen aan de ISO 15924 standaard scriptcode.

Waarde	Description
Arab	Scriptcode voor het Arabische schrift.
Armn	Scriptcode voor het Armeense schrift.
Beng	Scriptcode voor het Bengaalse schrift.
Cans	Scriptcode voor het UnifiedCanadianAboriginalSyllabics-script.
Cyrl	Scriptcode voor het Cyrillische schrift.
Deva	Scriptcode voor het Devanagari-script.
Ethi	Scriptcode voor het Ethiopische schrift.
Geor	Scriptcode voor het Georgische schrift.
Grek	Scriptcode voor het Griekse schrift.
Gujr	Scriptcode voor het Gujarati-script.
Guru	Scriptcode voor het Gurmukhi-script.
Hang	Scriptcode voor het Hangul-script.
Hani	Scriptcode voor het HanLiteral-script.
Hans	Scriptcode voor het HanVereenvoudigd-script.
Hant	Scriptcode voor het HanTraditional-script.
Hebr	Scriptcode voor het Hebreeuwse schrift.
Jpan	Scriptcode voor het Japanse schrift.
Khmr	Scriptcode voor het Khmer-schrift.
Knda	Scriptcode voor het Kannada-script.
Laoo	Scriptcode voor het Laotiaanse schrift.
Latn	Scriptcode voor het Latijnse schrift.
Mlym	Scriptcode voor het Malayalam-script.
Mong	Scriptcode voor het Mongoolse schrift.
Mtei	Scriptcode voor het Meitei-script.
Mymr	Scriptcode voor het Myanmar-script.
Olck	Scriptcode voor het Santali-script.
Orya	Scriptcode voor het Odia-script.
Sinh	Scriptcode voor het Singalese schrift.
Shrd	Scriptcode voor het Sharada-script.
Taml	Scriptcode voor het Tamil-schrift.
Telu	Scriptcode voor het Telugu-script.
Thaa	Scriptcode voor het Thaana-script.
Thai	Scriptcode voor het Thaise schrift.
Tibt	Scriptcode voor het Tibetaanse schrift.

ScriptKind

Opsomming

Identificeert het script van het invoerdocument. Komt overeen met de formele naam van de ISO 15924-standaard.

Waarde	Description
Arabic	Scriptnaam voor het Arabische schrift.
Armenian	Scriptnaam voor het Armeense schrift.
Bangla	Scriptnaam voor het Bengaalse schrift.
UnifiedCanadianAboriginalSyllabics	Scriptnaam voor het UnifiedCanadianAboriginalSyllabics-script.
Cyrillic	Scriptnaam voor het Cyrillische schrift.
Devanagari	Scriptnaam voor het Devanagari-script.
Ethiopic	Scriptnaam voor het Ethiopische schrift.
Georgian	Scriptnaam voor het Georgische schrift.
Greek	Scriptnaam voor het Griekse schrift.
Gujarati	Scriptnaam voor het Gujarati-schrift.
Gurmukhi	Scriptnaam voor het Gurmukhi-schrift.
Hangul	Scriptnaam voor het Hangul-script.
HanLiteral	Scriptnaam voor het HanLiteral-script.
HanSimplified	Scriptnaam voor het HanVereenvoudigde script.
HanTraditional	Scriptnaam voor het HanTraditional-script.
Hebrew	Scriptnaam voor het Hebreeuwse schrift.
Japanese	Scriptnaam voor het Japanse schrift.
Khmer	Scriptnaam voor het Khmer-schrift.
Kannada	Scriptnaam voor het Kannada-script.
Lao	Scriptnaam voor het Laotiaanse schrift.
Latin	Scriptnaam voor het Latijnse schrift.
Malayalam	Scriptnaam voor het Malayalam-schrift.
Meitei	Scriptnaam voor het Meitei-script.
Mongolian	Scriptnaam voor het Mongoolse schrift.
Myanmar	Scriptnaam voor het Myanmarese schrift.
Odia	Scriptnaam voor het Odia-script.
Santali	Scriptnaam voor het Santali-script.
Sharada	Scriptnaam voor het Sharada-script.
Sinhala	Scriptnaam voor het Singalese schrift.
Tamil	Scriptnaam voor het Tamil-schrift.
Telugu	Scriptnaam voor het Telugu-script.
Thaana	Scriptnaam voor het Thaana-script.
Thai	Scriptnaam voor het Thaise schrift.
Tibetan	Schriftnaam voor het Tibetaanse schrift.

SentenceAssessment

Object

Vertegenwoordigt een zinsbeoordeling en de beoordelingen of doelobjecten die ermee verband houden.

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

SentenceSentiment

Object

Het zinssentiment van een document.

Name	Type	Description
assessments	SentenceAssessment[]	De matrix van evaluaties voor de zin.
confidenceScores	SentimentConfidenceScores	De vertrouwensscore voor het sentiment ligt tussen 0 en 1 voor de zin voor alle klassen.
length	integer (int32)	De lengte van het doel.
offset	integer (int32)	Het doel wordt verschoven vanaf het begin van de zin.
sentiment	SentenceSentimentValue	Het voorspelde gevoel voor de zin.
targets	SentenceTarget[]	De matrix met zinsdoelen voor de zin.
text	string	De zintekst.

SentenceSentimentValue

Opsomming

Het voorspelde gevoel voor de zin.

Waarde	Description
positive	Positief sentiment
neutral	Neutraal sentiment
negative	Negatief sentiment

SentenceTarget

Object

Vertegenwoordigt een zinsdoel en de beoordelingen of doelobjecten die daarmee verband houden.

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

SentimentAnalysisTaskParameters

Object

Ondersteunde parameters voor een taak voor gevoelsanalyse.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor inloggen
modelVersion	string	latest	Model versie
opinionMining	boolean	False	Of je al dan niet gebruik moet maken van opinion mining in het verzoek.
stringIndexType	StringIndexType	TextElements_v8	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren.

SentimentConfidenceScores

Object

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

Name	Type	Description
negative	number (double)	Betrouwbaarheidsscore voor negatief gevoel
neutral	number (double)	Betrouwbaarheidsscore voor neutraal sentiment
positive	number (double)	Betrouwbaarheidsscore voor positief gevoel

SentimentDocumentResult

Object

Een object dat de vooraf gebouwde resultaten van de sentimentanalyse van elk document vertegenwoordigt.

Name	Type	Description
confidenceScores	SentimentConfidenceScores	De vertrouwensscore voor het sentiment ligt tussen 0 en 1 voor de zin voor alle klassen.
id	string	Unieke, niet-lege document-id.
sentences	SentenceSentiment[]	De zinnen van het document sentiment.
sentiment	DocumentSentimentValue	Voorspeld sentiment 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

Object

Resultaten van de sentimentanalyse voor de invoerdocumenten.

Name	Type	Description
documents	SentimentDocumentResult[]	De resultaten van de gevoelsanalyse voor elk document in de invoer.
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.

SentimentTaskResult

Object

Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.

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

SpeedMetadata

Object

Vertegenwoordigt het metagegevensmodel van de entiteit Snelheid.

Name	Type	Description
metadataKind	string: SpeedMetadata	De entiteit Metagegevens, objectsoort.
unit	SpeedUnit	Maateenheid voor snelheid.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

SpeedUnit

Opsomming

De snelheidseenheid van de meting

Waarde	Description
Unspecified	Niet gespecificeerde snelheidseenheid.
MetersPerSecond	Snelheidseenheid in meters per seconde.
KilometersPerHour	Snelheidseenheid in kilometers per uur.
KilometersPerMinute	Snelheidseenheid in kilometers per minuut.
KilometersPerSecond	Snelheidseenheid in kilometers per seconde.
MilesPerHour	Snelheidseenheid in mijl per uur.
Knots	Snelheidseenheid in knopen.
FeetPerSecond	Snelheidseenheid in voet per seconde.
FeetPerMinute	Snelheidseenheid in voet per minuut.
YardsPerMinute	Snelheidseenheid in yards per minuut.
YardsPerSecond	Snelheidseenheid in yards per seconde.
MetersPerMillisecond	Snelheidseenheid in meters per milliseconde.
CentimetersPerMillisecond	Snelheidseenheid in centimeters per milliseconde.
KilometersPerMillisecond	Snelheidseenheid in kilometers per milliseconde.

StringIndexType

Opsomming

Type tekenreeksindex

Waarde	Description
TextElements_v8	Geretourneerde offset- en lengtewaarden komen overeen met TextElements-clusters (Graphemes- en Grapheme-clusters) die worden bevestigd aan de Unicode 8.0.0-standaard. Gebruik deze optie als uw toepassing is geschreven in .Net Framework of .Net Core en u stringInfo gaat gebruiken.
UnicodeCodePoint	Geretourneerde offset- en lengtewaarden komen overeen met Unicode-codepunten. Gebruik deze optie als je applicatie is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Python.
Utf16CodeUnit	Geretourneerde offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als je applicatie is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Java, JavaScript.

SyntheticReplacementPolicyType

Object

Vertegenwoordigt het beleid van het vervangen van gedetecteerde PII door synthetische waarden.

Name	Type	Default value	Description
entityTypes	PiiCategoriesExclude[]		(Optioneel) beschrijft de PII-categorieën waarop het redactiebeleid wordt toegepast. Als dit niet is opgegeven, wordt het redactiebeleid toegepast op alle PII-categorieën.
isDefault	boolean	False	(Optioneel) om aan te geven of dit redactiebeleid het standaardbeleid is dat moet worden toegepast wanneer er geen specifiek beleid is gedefinieerd voor een PII-categorie. Slechts één beleid kan als standaard worden gemarkeerd.
policyKind	string: syntheticReplacement	characterMask	Het objecttype RedactionPolicy van de entiteit.
policyName	string		(Optionele) naam van het redactiebeleid voor identificatiedoeleinden.
preserveDataFormat	boolean		Optionele vlag om aan te geven of het oorspronkelijke gegevensformaat in de synthetische vervanging moet worden behouden. De standaardwaarde is vals.

TargetConfidenceScoreLabel

Object

Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.

Name	Type	Description
negative	number (double)	Betrouwbaarheidsscore voor negatief gevoel
positive	number (double)	Betrouwbaarheidsscore voor positief gevoel

TargetRelation

Object

Geeft de relatie weer tussen assessments en/of targets.

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

TargetRelationType

Opsomming

Het type dat is gerelateerd aan het doel.

Waarde	Description
assessment	Beoordeling relatie.
target	Doelrelatie.

TemperatureMetadata

Object

Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.

Name	Type	Description
metadataKind	string: TemperatureMetadata	De entiteit Metagegevens, objectsoort.
unit	TemperatureUnit	Maateenheid voor temperatuur.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

TemperatureUnit

Opsomming

De temperatuureenheid van de meting.

Waarde	Description
Unspecified	Niet-opgegeven temperatuureenheid
Fahrenheit	Temperatuureenheid in Fahrenheit
Kelvin	Temperatuureenheid in Kelvin
Rankine	Temperatuureenheid in Rankine
Celsius	Temperatuureenheid in Celsius

TemporalModifier

Opsomming

Een optionele wijziging van een datum/tijd-exemplaar.

Waarde	Description
AfterApprox	Na een geschatte tijd
Before	Voor een bepaalde tijd
BeforeStart	Voor het begin van een periode
Approx	Ongeveer op een bepaald tijdstip
ReferenceUndefined	Verwijzing naar een ongedefinieerde tijd
SinceEnd	Sinds het einde van een periode
AfterMid	Na het midden van een tijdsperiode
Start	Aan het begin van een periode
After	Na een bepaalde tijd
BeforeEnd	Voor het einde van een periode
Until	Tot een bepaald tijdstip
End	Aan het einde van een periode
Less	Minder dan een bepaalde tijd
Since	Sinds een bepaalde tijd
AfterStart	Na het begin van een periode
BeforeApprox	Vóór een geschatte tijd
Mid	In het midden van een tijdsperiode
More	Meer dan een bepaald tijdstip

TemporalSetMetadata

Object

A Metagegevens voor tijdelijke set-entiteitsinstanties.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TemporalSetMetadata	De entiteit Metagegevens, objectsoort.

TemporalSpanMetadata

Object

vertegenwoordigt de metadata van een datum en/of tijdspanne.

Name	Type	Description
metadataKind	string: TemporalSpanMetadata	De entiteit Metagegevens, objectsoort.
spanValues	TemporalSpanValues[]	Lijst van gedetecteerde tijdspannes.

TemporalSpanValues

Object

Tijdelijke spanwijdte object.

Name	Type	Description
begin	string	Beginwaarde voor de overspanning.
duration	string	Een optionele duurwaarde die is opgemaakt op basis van de ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Eindwaarde voor de span.
modifier	TemporalModifier	Modifier voor datum/tijd om het referentiepunt aan te geven, zoals voor, na enz.
timex	string	Een optionele triplet met het begin, het einde en de duur die allemaal als ISO 8601 opgemaakte tekenreeksen zijn opgegeven.

TimeMetadata

Object

A Metagegevens voor instanties van tijdentiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TimeMetadata	De entiteit Metagegevens, objectsoort.

TokenSentimentValue

Opsomming

Het voorspelde gevoel voor de zin.

Waarde	Description
positive	Positief sentiment
mixed	Gemengd sentiment
negative	Negatief sentiment

ValueExclusionPolicy

Object

Beleid voor specifieke woorden en termen die moeten worden uitgesloten van detectie door de PII-detectieservice

Name	Type	Default value	Description
caseSensitive	boolean	False	Optie om de waarden exclusief hoofdlettergevoelig te maken
excludedValues	string[]		Lijst met woorden en termen die moeten worden uitgesloten van detectie door de PII-detectieservice

VolumeMetadata

Object

Vertegenwoordigt het metagegevensmodel van de entiteit Volume.

Name	Type	Description
metadataKind	string: VolumeMetadata	De entiteit Metagegevens, objectsoort.
unit	VolumeUnit	Maateenheid voor volume.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

VolumeUnit

Opsomming

De volume-eenheid van de meting

Waarde	Description
Unspecified	Niet-opgegeven volumeeenheid.
CubicMeter	Volumeeenheid in kubieke meters.
CubicCentimeter	Volumeeenheid in kubieke centimeters.
CubicMillimeter	Volumeeenheid in kubieke millimeters.
Hectoliter	Volumeeenheid in hectoliters.
Decaliter	Volumeeenheid in decaliters.
Liter	Volumeeenheid in liter.
Centiliter	Volumeeenheid in centiliters.
Milliliter	Volumeeenheid in milliliters.
CubicYard	Volumeeenheid in kubieke meter.
CubicInch	Volumeeenheid in kubieke inch.
CubicFoot	Volumeeenheid in kubieke voeten.
CubicMile	Volumeeenheid in kubieke mijlen.
FluidOunce	Volumeeenheid in vloeistof ounces.
Teaspoon	Volumeeenheid in theelepels.
Tablespoon	Volumeeenheid in eetlepels.
Pint	Volumeeenheid in pints.
Quart	Volumeeenheid in kwartielen.
Cup	Volumeeenheid in kopjes.
Gill	Volumeeenheid in kieuwen.
Pinch	Volumeeenheid in knijpen.
FluidDram	Volumeeenheid in vloeistofdrams.
Barrel	Volumeeenheid in vaten.
Minim	Volumeeenheid in minims.
Cord	Volumeeenheid in koorden.
Peck	Volumeeenheid in pecks.
Bushel	Volumeeenheid in bushels.
Hogshead	Volumeeenheid in hogsheads.

WarningCodeValue

Opsomming

Definieert de lijst met waarschuwingscodes.

Waarde	Description
LongWordsInDocument	Lange woorden in documentwaarschuwing
DocumentTruncated	Waarschuwing voor afgekapt document

WeightMetadata

Object

Vertegenwoordigt het metagegevensmodel van de entiteit Gewicht.

Name	Type	Description
metadataKind	string: WeightMetadata	De entiteit Metagegevens, objectsoort.
unit	WeightUnit	Maateenheid voor gewicht.
value	number (double)	De numerieke waarde die de geëxtraheerde tekst aangeeft.

WeightUnit

Opsomming

De gewichtseenheid van de meting.

Waarde	Description
Unspecified	Niet-opgegeven gewichtseenheid
Kilogram	Gewichtseenheid in kilogram
Gram	Gewichtseenheid in gram
Milligram	Gewichtseenheid in mg
Gallon	Volumeeenheid in gallon
MetricTon	Gewichtseenheid in metrische ton
Ton	Gewichtseenheid in ton
Pound	Gewichtseenheid in ponden
Ounce	Gewichtseenheid in ounces
Grain	Gewichtseenheid in korrels
PennyWeight	Gewichtseenheid in pennygewichten
LongTonBritish	Gewichtseenheid in lange ton (Brits)
ShortTonUS	Gewichtseenheid in korte ton (VS)
ShortHundredWeightUS	Gewichtseenheid in korte honderdgewichten (VS)
Stone	Gewichtseenheid in stenen
Dram	Gewichtseenheid in drams