Text Analysis Runtime - Analyze Text

Service:

Azure AI Services

API-versie:

2024-11-01

Tekstanalyse aanvragen voor een verzameling documenten.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.
showStats	query		boolean	(Optioneel) als 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 invoer voor het koppelen van entiteit analyseren.
AnalyzeTextEntityRecognitionInput	De entiteitsherkenning analyseert de aanvraag voor tekstinvoertaken.
AnalyzeTextKeyPhraseExtractionInput	Bevat de taakinvoer KeyPhraseExtraction voor analyseren.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van documentanalysetaken voor taaldetectie.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de invoer van de analysetekst piIEntityRecognition-taak.
AnalyzeTextSentimentAnalysisInput	Bevat de invoer van de taak SentimentAnalysis voor analyseren.

AnalyzeTextEntityLinkingInput

Bevat de invoer voor het koppelen van entiteit analyseren.

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

AnalyzeTextEntityRecognitionInput

De entiteitsherkenning analyseert de aanvraag voor tekstinvoertaken.

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

AnalyzeTextKeyPhraseExtractionInput

Bevat de taakinvoer KeyPhraseExtraction voor analyseren.

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

AnalyzeTextLanguageDetectionInput

Bevat de invoer van documentanalysetaken voor taaldetectie.

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

AnalyzeTextPiiEntitiesRecognitionInput

Bevat de invoer van de analysetekst piIEntityRecognition-taak.

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

AnalyzeTextSentimentAnalysisInput

Bevat de invoer van de taak SentimentAnalysis voor analyseren.

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

Antwoorden

Name	Type	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	De aanvraag is 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

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Voorbeeldaanvraag

HTTP

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

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

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=2024-11-01

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

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=2024-11-01

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

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=2024-11-01

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

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=2024-11-01

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

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=2024-11-01

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

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=2024-11-01

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

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=2024-11-01

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

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

SuccessfulPiiEntityRecognitionRequest

Voorbeeldaanvraag

HTTP

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

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

Voorbeeldrespons

Statuscode:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Voorbeeldaanvraag

HTTP

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

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

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 leeftijdsentiteit.
AgeUnit	De maateenheid Leeftijd
AllowOverlapEntityPolicyType	Vertegenwoordigt het beleid voor toestaan van overlapping. Er wordt geen logica voor naverwerking toegepast voor de entiteiten. Wat het model ook voorspelt, is wat er aan de gebruiker wordt geretourneerd. Hierdoor kan de gebruiker een volledige weergave krijgen van de mogelijke waarden van elk model en hun eigen aangepaste logica toepassen op entiteitsselectie
AnalyzeTextEntityLinkingInput	Bevat de invoer voor het koppelen van entiteit analyseren.
AnalyzeTextEntityRecognitionInput	De entiteitsherkenning analyseert de aanvraag voor tekstinvoertaken.
AnalyzeTextKeyPhraseExtractionInput	Bevat de taakinvoer KeyPhraseExtraction voor analyseren.
AnalyzeTextLanguageDetectionInput	Bevat de invoer van documentanalysetaken voor taaldetectie.
AnalyzeTextPiiEntitiesRecognitionInput	Bevat de invoer van de analysetekst piIEntityRecognition-taak.
AnalyzeTextSentimentAnalysisInput	Bevat de invoer van de taak SentimentAnalysis voor analyseren.
AnalyzeTextTaskKind	Het type ondersteunde analyseteksttaken.
AnalyzeTextTaskResultsKind	Het type antwoordobject dat wordt geretourneerd door de taak analyze-text.
AreaMetadata	Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.
AreaUnit	De maateenheid.
CurrencyMetadata	Vertegenwoordigt het valuta)-entiteitsmetagegevensmodel.
DateMetadata	Een metagegevens voor datumentiteitexemplaren.
DateTimeMetadata	Een metagegevens voor exemplaren van datum/tijd-entiteiten.
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
Entity	Hiermee definieert u het gedetecteerde entiteitsobject met de entiteitscategorie en de gedetecteerde entiteitstekst, enzovoort.
EntityCategory	Bevat alle entiteitscategorieën die zijn gedetecteerd door entiteitsherkenning.
EntityInferenceOptions	De klasse waarin de deductieopties zijn opgenomen die zijn toegestaan voor herkenning van benoemde entiteiten.
EntityLinkingResult	Resultaat entiteitskoppeling.
EntityLinkingTaskParameters	Ondersteunde parameters voor een entiteitskoppelingstaak.
EntityLinkingTaskResult	Bevat het resultaat van de entiteitskoppelingstaak voor analyseren.
EntityTag	Entiteitstagobject dat de naam van de tags bevat, bevat een bijbehorende betrouwbaarheidsscore. Entiteitstags worden gebruikt om overeenkomsten/affiniteit tussen entiteiten uit te drukken.
EntityWithMetadata	Entiteitsobject met tags en metagegevens.
Error	Het antwoordobject voor fouten dat 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 informatie(gegevens) entiteit.
InformationUnit	De meeteenheid (gegevens).
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Bevat de KeyPhraseResult.
KeyPhrasesDocumentResult	Bevat de resultaten van sleuteltermextractie voor een document.
KeyPhraseTaskParameters	Ondersteunde parameters voor een sleuteltermextractietaak.
KeyPhraseTaskResult	Bevat het taakresultaat KeyPhraseExtraction voor analyseren.
LanguageDetectionAnalysisInput	Bevat de documentanalyse-invoer voor taaldetectie.
LanguageDetectionDocumentResult	Bevat de taaldetectie voor een document.
LanguageDetectionResult	Bevat het resultaat van taaldetectie 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 model voor de lengte-entiteitmetagegevens.
LengthUnit	De lengte-eenheid van de meting.
LinkedEntitiesDocumentResult	Resultaat van entiteitskoppelingsdocument.
LinkedEntity	Het LinkedEntity-object met de gedetecteerde entiteit met de bijbehorende bronnen/koppelingen.
Match	Het object Match met de gedetecteerde entiteitstekst met de offset en de lengte.
MatchLongestEntityPolicyType	Vertegenwoordigt het beleid voor het langst overlappen van overeenkomst. Er zijn geen overlappende entiteiten voor zover mogelijk. 1. Als er overlappende entiteiten zijn, wordt de langste entiteit geretourneerd. 2. Als de set tekens die zijn voorspeld voor 2 of meer entiteiten precies hetzelfde zijn, selecteert u de entiteit met de hogere betrouwbaarheidsscore.3. Als de entiteitsscores identiek zijn, retourneert u alle entiteiten die nog aanwezig zijn na het toepassen van de vorige regels. 3. Als er sprake is van gedeeltelijke overlapping (zoals in Hello Text Analytics), volgt u de bovenstaande stappen vanaf 1.
MetadataKind	Het objecttype Metagegevens van de entiteit.
MultiLanguageAnalysisInput	Verzameling invoerdocumenten die door de service moeten worden geanalyseerd.
MultiLanguageInput	Bevat een invoerdocument dat moet worden geanalyseerd door de service.
NumberKind	Het type geëxtraheerde getalentiteit.
NumberMetadata	Een metagegevens voor exemplaren van numerieke entiteiten.
NumericRangeMetadata	vertegenwoordigt de metagegevens van numerieke intervallen.
OrdinalMetadata	Een metagegevens voor exemplaren van numerieke entiteiten.
PiiCategory	(Optioneel) beschrijft de PII-categorieën die moeten worden geretourneerd
PiiDomain	Domein voor PII-taak
PiiEntitiesDocumentResult	Bevat de PII-resultaten.
PiiResult	Bevat de PiiResult.
PiiTaskParameters	Ondersteunde parameters voor een piI-entiteitsherkenningstaak.
PiiTaskResult	Bevat de LRO-taak PIIEntityRecognition LRO voor analyseren.
RangeInclusivity	De bereikinclusiviteit van deze eigenschap.
RangeKind	Het type getalbereikentiteit.
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-standaardscriptcode.
ScriptKind	Identificeert het script van het invoerdocument. Komt overeen met de formele iso 15924-standaardnaam.
SentenceAssessment	Vertegenwoordigt een zinsevaluatie en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentenceSentiment	Het zinsgevoel van een document.
SentenceSentimentValue	Het voorspelde gevoel voor de zin.
SentenceTarget	Vertegenwoordigt een zinsdoel en de evaluaties of doelobjecten die eraan zijn gerelateerd.
SentimentAnalysisTaskParameters	Ondersteunde parameters voor een sentimentanalysetaak.
SentimentConfidenceScores	Vertegenwoordigt de betrouwbaarheidsscores tussen 0 en 1 voor alle sentimentklassen: positief, neutraal, negatief.
SentimentDocumentResult	Een object dat de vooraf gemaakte sentimentanalyseresultaten van elk document weergeeft.
SentimentResponse	Resultaten van sentimentanalyse voor de invoerdocumenten.
SentimentTaskResult	Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.
SpeedMetadata	Vertegenwoordigt het metagegevensmodel van de snelheidsentiteit.
SpeedUnit	De snelheidseenheid van de meting
StringIndexType	Type tekenreeksindex
TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
TargetRelation	Vertegenwoordigt de relatie tussen evaluaties en/of doelen.
TargetRelationType	Het type dat is gerelateerd aan het doel.
TemperatureMetadata	Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.
TemperatureUnit	De temperatuureenheid van de meting.
TemporalModifier	Een optionele wijziging van een datum/tijd-exemplaar.
TemporalSetMetadata	Een metagegevens voor exemplaren van tijdelijke set-entiteiten.
TemporalSpanMetadata	vertegenwoordigt de metagegevens van een datum en/of tijdsperiode.
TemporalSpanValues	Tijdelijk spanobject.
TimeMetadata	Een metagegevens voor tijdentiteitexemplaren.
TokenSentimentValue	Het voorspelde gevoel voor de zin.
VolumeMetadata	Vertegenwoordigt het metagegevensmodel van de volumeentiteit.
VolumeUnit	De volume-eenheid van de meting
WarningCodeValue	Hiermee definieert u de lijst met waarschuwingscodes.
WeightMetadata	Vertegenwoordigt het model voor de gewichtsentiteitsmetagegevens.
WeightUnit	De gewichtseenheid van de meting.

AgeMetadata

Vertegenwoordigt het metagegevensmodel leeftijdsentiteit.

Name	Type	Description
metadataKind	string: AgeMetadata	Het objecttype Metagegevens van de entiteit.
unit	AgeUnit	Maateenheid voor leeftijd.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AgeUnit

De maateenheid Leeftijd

Name	Type	Description
Day	string	Tijdsperiode van een dag
Month	string	Periode van een maand
Unspecified	string	Niet-opgegeven tijdsperiode
Week	string	Periode van een week
Year	string	Periode van een jaar

AllowOverlapEntityPolicyType

Vertegenwoordigt het beleid voor toestaan van overlapping. Er wordt geen logica voor naverwerking toegepast voor de entiteiten. Wat het model ook voorspelt, is wat er aan de gebruiker wordt geretourneerd. Hierdoor kan de gebruiker een volledige weergave krijgen van de mogelijke waarden van elk model en hun eigen aangepaste logica toepassen op entiteitsselectie

Name	Type	Default value	Description
policyKind	string: allowOverlap	matchLongest	Het objecttype Entity OverlapPolicy.

AnalyzeTextEntityLinkingInput

Bevat de invoer voor het koppelen van entiteit analyseren.

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

AnalyzeTextEntityRecognitionInput

De entiteitsherkenning analyseert de aanvraag voor tekstinvoertaken.

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

AnalyzeTextKeyPhraseExtractionInput

Bevat de taakinvoer KeyPhraseExtraction voor analyseren.

Name	Type	Description
analysisInput	MultiLanguageAnalysisInput	Bevat de invoerdocumenten.
kind	string: KeyPhraseExtraction	Het soort taak dat moet worden uitgevoerd.
parameters	KeyPhraseTaskParameters	Taakparameters voor sleuteltermextractie.

AnalyzeTextLanguageDetectionInput

Bevat de invoer van documentanalysetaken voor taaldetectie.

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

AnalyzeTextPiiEntitiesRecognitionInput

Bevat de invoer van de analysetekst piIEntityRecognition-taak.

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

AnalyzeTextSentimentAnalysisInput

Bevat de invoer van de taak SentimentAnalysis voor analyseren.

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

AnalyzeTextTaskKind

Het type ondersteunde analyseteksttaken.

Name	Type	Description
EntityLinking	string	Entiteitskoppelingstaak
EntityRecognition	string	Entiteitsherkenningstaak
KeyPhraseExtraction	string	Sleuteltermextractietaak
LanguageDetection	string	Taaldetectietaak
PiiEntityRecognition	string	PiI-entiteitsherkenningstaak
SentimentAnalysis	string	Sentimentanalysetaak

AnalyzeTextTaskResultsKind

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

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

AreaMetadata

Vertegenwoordigt het metagegevensmodel van de gebiedsentiteit.

Name	Type	Description
metadataKind	string: AreaMetadata	Het objecttype Metagegevens van de entiteit.
unit	AreaUnit	Maateenheid voor oppervlakte.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

AreaUnit

De maateenheid.

Name	Type	Description
Acre	string	Oppervlakte-eenheid in hectare
SquareCentimeter	string	Oppervlakte-eenheid in vierkante centimeters
SquareDecameter	string	Oppervlakte-eenheid in vierkante decameters
SquareDecimeter	string	Vlakeenheid in vierkante decimeters
SquareFoot	string	Oppervlakte-eenheid in vierkante voet
SquareHectometer	string	Oppervlakte-eenheid in vierkante hectometers
SquareInch	string	Gebiedseenheid in vierkante inch
SquareKilometer	string	Oppervlakte-eenheid in vierkante kilometers
SquareMeter	string	Oppervlakte-eenheid in vierkante meters
SquareMile	string	Oppervlakte-eenheid in vierkante mijl
SquareMillimeter	string	Oppervlakte-eenheid in vierkante millimeters
SquareYard	string	Oppervlakte-eenheid op vierkante meter
Unspecified	string	Niet-opgegeven vlakeenheid

CurrencyMetadata

Vertegenwoordigt het valuta)-entiteitsmetagegevensmodel.

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	Het objecttype Metagegevens van de entiteit.
unit	string	Valuta-eenheid.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

DateMetadata

Een metagegevens voor datumentiteitexemplaren.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateMetadata	Het objecttype Metagegevens van de entiteit.

DateTimeMetadata

Een metagegevens voor exemplaren van datum/tijd-entiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: DateTimeMetadata	Het objecttype Metagegevens van de entiteit.

DateValue

Vertegenwoordigt de datumwaarde.

Name	Type	Description
modifier	TemporalModifier	Wijzigingsfunctie voor datum/tijd om een verwijzingspunt aan te geven, zoals voorheen, na, enzovoort.
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

Bevat de details van de gedetecteerde taal voor de tekst.

Name	Type	Description
confidenceScore	number	Een betrouwbaarheidsscore tussen 0 en 1. Scores dicht bij 1 geven 100% zekerheid aan dat de geïdentificeerde taal waar is.
iso6391Name	string	Een tweeletterige weergave van de gedetecteerde taal volgens de ISO 639-1-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-standaard.
scriptName	ScriptKind	Identificeert de scriptnaam van het invoerdocument volgens de ISO 15924-standaard.

DocumentError

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

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

DocumentSentimentValue

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

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

DocumentStatistics

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

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

DocumentWarning

Bevat het 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

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

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

Ondersteunde parameters voor een entiteitsherkenningstaak.

Name	Type	Default value	Description
exclusionList	EntityCategory[]		(Optioneel) aanvraagparameter die alle entiteiten filtert die de excludeList bevatten. Wanneer een gebruiker een excludeList opgeeft, kan er geen voorspelling worden geretourneerd met een entiteit in die lijst. We passen inclusionList toe vóór exclusionList
inclusionList	EntityCategory[]		(Optioneel) aanvraagparameter die de uitvoer beperkt tot de aangevraagde entiteitstypen die in deze lijst zijn opgenomen. We passen inclusionList toe vóór exclusionList
inferenceOptions	EntityInferenceOptions		(Optioneel) aanvraagparameter waarmee de gebruiker instellingen kan opgeven voor het uitvoeren van de deductie.
loggingOptOut	boolean	False	Afmelden voor afmelden voor afmelden
modelVersion	string	latest	modelversie
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Optioneel) beschrijft het type overlapbeleid dat moet worden toegepast op de ner-uitvoer.
stringIndexType	StringIndexType	TextElements_v8	(Optioneel) parameter om het indextype tekenreeks op te geven dat wordt gebruikt om tekenreeksverschilen te interpreteren. Standaard ingesteld op TextElements (Graphemes).

EntitiesTaskResult

Bevat de entiteitstaak

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

Entity

Hiermee definieert u het gedetecteerde entiteitsobject met de entiteitscategorie en de gedetecteerde entiteitstekst, enzovoort.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer	Lengte voor de entiteitstekst. Het gebruik van verschillende waarden 'stringIndexType' kan van invloed zijn op de geretourneerde lengte.
offset	integer	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.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.

EntityCategory

Bevat alle entiteitscategorieën die zijn gedetecteerd door entiteitsherkenning.

Name	Type	Description
Address	string	Specifieke vermeldingen op straatniveau van locaties: huis-/gebouwnummers, straten, wegen, snelwegen, kruispunten waarnaar wordt verwezen door naam.
Age	string	Leeftijdsgerelateerde waarden.
Airport	string	Luchthavens.
Area	string	Gebied van een object.
City	string	Plaatsgerelateerde waarden.
ComputingProduct	string	Computingproducten.
Continent	string	Continentgerelateerde waarden.
CountryRegion	string	Land- of regio-gerelateerde waarden.
CulturalEvent	string	Waarden met betrekking tot culturele gebeurtenissen.
Currency	string	Valuta-gerelateerde waarden.
Date	string	Kalenderdatums.
DateRange	string	Datumbereik.
DateTime	string	Kalenderdatums met tijd.
DateTimeRange	string	Bereik van datum en tijd.
Dimension	string	Maatlijn van metingen
Duration	string	Duur van de tijd.
Email	string	E-mailadressen.
Event	string	Sociaal, sport, zaken, politiek, educatief, natuurlijk, historisch, crimineel, gewelddadig, juridisch, militair evenement met een bepaalde periode.
GPE	string	Steden, landen/regio's, staten.
Geological	string	Geografische en natuurlijke kenmerken zoals rivieren, oceanen en woestijnen.
Height	string	Hoogte van een object.
IP	string	NETWERK-IP-adressen.
Information	string	Maateenheid voor digitale informatie.
Length	string	De lengte van een object.
Location	string	Bepaald punt of plaats in fysieke ruimte.
NaturalEvent	string	Waarden met betrekking tot natuurlijke gebeurtenissen.
Number	string	Getallen zonder eenheid
NumberRange	string	Bereik van getallen
Numeric	string	Numerieke waarden, inclusief cijfers en numerieke woorden.
Ordinal	string	Rangtelwoorden.
Organization	string	Bedrijven, agentschappen en andere groepen mensen die zijn gedefinieerd door een bepaalde gevestigde organisatiestructuur. Deze labels kunnen onder andere bedrijven, politieke partijen/bewegingen, muzikale bands, sportclubs, overheidsinstanties en publieke organisaties omvatten. Nationaliteiten of religies zijn geen ORGANISATIE.
OrganizationMedical	string	Medische bedrijven en groepen.
OrganizationSports	string	Sportgerelateerde organisaties.
OrganizationStockExchange	string	Beursgroepen.
Percentage	string	Percentagegerelateerde waarden.
Person	string	Voor-, achter- en middelste namen, namen van fictieve tekens en aliassen. Titels, zoals Mr. of 'President', worden niet beschouwd als onderdeel van de benoemde entiteit.
PersonType	string	Menselijke rollen die zijn geclassificeerd door een groepslidmaatschap.
PhoneNumber	string	Telefoonnummers (alleen amerikaanse en EU-telefoonnummers).
Product	string	Enkele of groep commerciële, verbruiksobjecten, elektronica, voertuigen, voedselgroepen.
SetTemporal	string	Set tijdgerelateerde waarden.
Skill	string	Een mogelijkheid, vaardigheid of expertise.
Speed	string	Snelheid van een object.
SportsEvent	string	Waarden met betrekking tot sportgebeurtenissen.
State	string	Statusgerelateerde waarden.
Structural	string	Door de mens gemaakte structuren.
Temperature	string	Temperatuurgerelateerde waarden.
Temporal	string	Items met betrekking tot tijd.
Time	string	Tijdstippen van de dag.
TimeRange	string	Bereik van tijden.
URL	string	URL's naar websites.
Volume	string	Volume van een object.
Weight	string	Gewicht van een object.

EntityInferenceOptions

De klasse waarin de deductieopties zijn opgenomen die zijn toegestaan voor herkenning van benoemde entiteiten.

Name	Type	Default value	Description
excludeNormalizedValues	boolean	False	Optie voor het opnemen/uitsluiten van de gedetecteerde entiteitswaarden die moeten worden genormaliseerd en opgenomen in de metagegevens. De numerieke en tijdelijke entiteitstypen ondersteunen normalisatie van waarden.

EntityLinkingResult

Resultaat entiteitskoppeling.

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

EntityLinkingTaskParameters

Ondersteunde parameters voor een entiteitskoppelingstaak.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor afmelden voor afmelden
modelVersion	string	latest	modelversie
stringIndexType	StringIndexType	TextElements_v8	Optionele parameter om het indextype tekenreeks op te geven dat wordt gebruikt om tekenreeksverschilen te interpreteren. Standaard ingesteld op TextElements (Graphemes).

EntityLinkingTaskResult

Bevat het resultaat van de entiteitskoppelingstaak voor analyseren.

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

EntityTag

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

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

EntityWithMetadata

Entiteitsobject met tags en metagegevens.

Name	Type	Description
category	string	Entiteitstype.
confidenceScore	number	Betrouwbaarheidsscore tussen 0 en 1 van de geëxtraheerde entiteit.
length	integer	Lengte voor de entiteitstekst. Het gebruik van verschillende 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 object voor entiteitmetagegevens.
offset	integer	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 overeenkomsten/affiniteit tussen entiteiten uit te drukken.
text	string	Entiteitstekst zoals wordt weergegeven in de aanvraag.
type	string	Een entiteitstype is de laagste (of beste) granulariteit waarmee de entiteit is gedetecteerd. Het type wordt toegewezen aan de specifieke metagegevenskenmerken die zijn gekoppeld aan de gedetecteerde entiteit.

Error

Het antwoordobject voor fouten dat 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

Leesbare foutcode.

Name	Type	Description
AzureCognitiveSearchIndexLimitReached	string	Azure Cognitive Search-indexlimiet bereikt fout
AzureCognitiveSearchIndexNotFound	string	Fout bij azure Cognitive Search-index is niet gevonden
AzureCognitiveSearchNotFound	string	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	string	Beperkingsfout in Azure Cognitive Search
Conflict	string	Conflictfout
Forbidden	string	Fout bij verboden toegang
InternalServerError	string	Interne serverfout
InvalidArgument	string	Ongeldig argumentfout
InvalidRequest	string	Ongeldige aanvraagfout
NotFound	string	Fout niet gevonden
OperationNotFound	string	Fout bij bewerking niet gevonden
ProjectNotFound	string	De fout Project is niet gevonden
QuotaExceeded	string	Fout over overschreden quotum
ServiceUnavailable	string	Fout over niet-beschikbaar service
Timeout	string	Time-outfout
TooManyRequests	string	Fout bij te veel aanvragen
Unauthorized	string	Fout bij onbevoegde toegang
Warning	string	Waarschuwingsfout

ErrorResponse

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InformationMetadata

Vertegenwoordigt het metagegevensmodel van de informatie(gegevens) entiteit.

Name	Type	Description
metadataKind	string: InformationMetadata	Het objecttype Metagegevens van de entiteit.
unit	InformationUnit	Maateenheid voor informatie.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

InformationUnit

De meeteenheid (gegevens).

Name	Type	Description
Bit	string	Gegevensgrootte-eenheid in bits
Byte	string	Gegevensgrootte-eenheid in bytes
Gigabit	string	Gegevensgrootte-eenheid in gigabits
Gigabyte	string	Gegevensgrootte-eenheid in gigabytes
Kilobit	string	Gegevensgrootte-eenheid in kilobits
Kilobyte	string	Gegevensgrootte-eenheid in kilobytes
Megabit	string	Gegevensgrootte-eenheid in megabits
Megabyte	string	Gegevensgrootte-eenheid in megabytes
Petabit	string	Gegevensgrootte-eenheid in petabits
Petabyte	string	Gegevensgrootte-eenheid in petabytes
Terabit	string	Gegevensgrootte-eenheid in terabits
Terabyte	string	Gegevensgrootte-eenheid in terabytes
Unspecified	string	Niet-opgegeven gegevensgrootte-eenheid

InnerErrorCode

Leesbare foutcode.

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

InnerErrorModel

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

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

KeyPhraseResult

Bevat de KeyPhraseResult.

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

KeyPhrasesDocumentResult

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

Ondersteunde parameters voor een sleuteltermextractietaak.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor afmelden voor afmelden
modelVersion	string	latest	modelversie

KeyPhraseTaskResult

Bevat het taakresultaat KeyPhraseExtraction voor analyseren.

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

LanguageDetectionAnalysisInput

Bevat de documentanalyse-invoer voor taaldetectie.

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

LanguageDetectionDocumentResult

Bevat de taaldetectie voor een document.

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

Bevat het resultaat van taaldetectie voor de aanvraag.

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

LanguageDetectionTaskParameters

Ondersteunde parameters voor een taaldetectietaak.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor afmelden voor afmelden
modelVersion	string	latest	modelversie

LanguageDetectionTaskResult

Bevat het resultaat van de taaldetectietaak voor de aanvraag.

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

LanguageInput

Bevat de invoer voor taaldetectie.

Name	Type	Description
countryHint	string	De landhint 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

Vertegenwoordigt het model voor de lengte-entiteitmetagegevens.

Name	Type	Description
metadataKind	string: LengthMetadata	Het objecttype Metagegevens van de entiteit.
unit	LengthUnit	Maateenheid voor lengte.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

LengthUnit

De lengte-eenheid van de meting.

Name	Type	Description
Centimeter	string	Lengteeenheid in centimeters.
Decameter	string	Lengteeenheid in decameters.
Decimeter	string	Lengteeenheid in decimeters.
Foot	string	Lengteeenheid in voeten.
Hectometer	string	Lengteeenheid in hectometers.
Inch	string	Lengteeenheid in inches.
Kilometer	string	Lengteeenheid in kilometers.
LightYear	string	Lengteeenheid in lichtjaren.
Meter	string	Lengteeenheid in meters.
Micrometer	string	Lengteeenheid in micrometers.
Mile	string	Lengte eenheid in mijlen.
Millimeter	string	Lengteeenheid in millimeters.
Nanometer	string	Lengteeenheid in nanometers.
Picometer	string	Lengteeenheid in picometers.
Point	string	Lengteeenheid in punten.
Unspecified	string	Niet-opgegeven lengteeenheid.
Yard	string	Lengte-eenheid in meter.

LinkedEntitiesDocumentResult

Resultaat van entiteitskoppelingsdocument.

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

LinkedEntity

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

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

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

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

MatchLongestEntityPolicyType

Vertegenwoordigt het beleid voor het langst overlappen van overeenkomst. Er zijn geen overlappende entiteiten voor zover mogelijk. 1. Als er overlappende entiteiten zijn, wordt de langste entiteit geretourneerd. 2. Als de set tekens die zijn voorspeld voor 2 of meer entiteiten precies hetzelfde zijn, selecteert u de entiteit met de hogere betrouwbaarheidsscore.3. Als de entiteitsscores identiek zijn, retourneert u alle entiteiten die nog aanwezig zijn na het toepassen van de vorige regels. 3. Als er sprake is van gedeeltelijke overlapping (zoals in Hello Text Analytics), volgt u de bovenstaande stappen vanaf 1.

Name	Type	Default value	Description
policyKind	string: matchLongest	matchLongest	Het objecttype Entity OverlapPolicy.

MetadataKind

Het objecttype Metagegevens van de entiteit.

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

MultiLanguageAnalysisInput

Verzameling invoerdocumenten die door de service moeten worden geanalyseerd.

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

MultiLanguageInput

Bevat een invoerdocument dat moet worden geanalyseerd door de service.

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

NumberKind

Het type geëxtraheerde getalentiteit.

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

NumberMetadata

Een metagegevens voor exemplaren van numerieke entiteiten.

Name	Type	Description
metadataKind	string: NumberMetadata	Het objecttype Metagegevens van de entiteit.
numberKind	NumberKind	Soort van het getaltype.
value	number	Een numerieke weergave van wat de geëxtraheerde tekst aangeeft.

NumericRangeMetadata

vertegenwoordigt de metagegevens van numerieke intervallen.

Name	Type	Description
maximum	number	De eindwaarde van het interval.
metadataKind	string: NumericRangeMetadata	Het objecttype Metagegevens van de entiteit.
minimum	number	De beginwaarde van het interval.
rangeInclusivity	RangeInclusivity	De inclusiefheid van dit bereik.
rangeKind	RangeKind	Soort numerieke bereiken die worden ondersteund, zoals Getal, Snelheid, enzovoort.

OrdinalMetadata

Een metagegevens voor exemplaren van numerieke entiteiten.

Name	Type	Description
metadataKind	string: OrdinalMetadata	Het objecttype Metagegevens van de entiteit.
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.

PiiCategory

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

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

PiiDomain

Domein voor PII-taak

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

PiiEntitiesDocumentResult

Bevat de PII-resultaten.

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

PiiResult

Bevat de PiiResult.

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

PiiTaskParameters

Ondersteunde parameters voor een piI-entiteitsherkenningstaak.

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

PiiTaskResult

Bevat de LRO-taak PIIEntityRecognition LRO voor analyseren.

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

RangeInclusivity

De bereikinclusiviteit van deze eigenschap.

Name	Type	Description
LeftInclusive	string	Inclusief links
LeftRightInclusive	string	Beide zijden inclusief
NoneInclusive	string	Geen inclusiviteit
RightInclusive	string	Inclusief rechts

RangeKind

Het type getalbereikentiteit.

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

RelativeTo

Het verwijzingspunt dat het rangnummer aangeeft.

Name	Type	Description
Current	string	Huidige status of positie
End	string	Eindstatus of -positie
Start	string	Beginstatus of -positie

RequestStatistics

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

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

ScriptCode

Identificeert het script van het invoerdocument. Wordt toegewezen aan de ISO 15924-standaardscriptcode.

Name	Type	Description
Arab	string	Scriptcode voor het Arabische script.
Armn	string	Scriptcode voor het Armeense script.
Beng	string	Scriptcode voor het Bangla-script.
Cans	string	Scriptcode voor het script UnifiedCanadianAboriginalSyllabics.
Cyrl	string	Scriptcode voor het Cyrillische script.
Deva	string	Scriptcode voor het Devanagari-script.
Ethi	string	Scriptcode voor het Ethiopic-script.
Geor	string	Scriptcode voor het Georgische script.
Grek	string	Scriptcode voor het Griekse script.
Gujr	string	Scriptcode voor het Gujarati-script.
Guru	string	Scriptcode voor het Gurmukhi-script.
Hang	string	Scriptcode voor het Hangul-script.
Hani	string	Scriptcode voor het HanLiteral-script.
Hans	string	Scriptcode voor het HanSimplified-script.
Hant	string	Scriptcode voor het HanTraditional-script.
Hebr	string	Scriptcode voor het Hebreeuwse script.
Jpan	string	Scriptcode voor het Japanse script.
Khmr	string	Scriptcode voor het Khmer-script.
Knda	string	Scriptcode voor het Kannada-script.
Laoo	string	Scriptcode voor het Lao-script.
Latn	string	Scriptcode voor het Latijnse script.
Mlym	string	Scriptcode voor het Malayalam-script.
Mong	string	Scriptcode voor het Mongoolse script.
Mtei	string	Scriptcode voor het Meitei-script.
Mymr	string	Scriptcode voor het script Myanmar.
Olck	string	Scriptcode voor het Santali-script.
Orya	string	Scriptcode voor het Odia-script.
Shrd	string	Scriptcode voor het Sharada-script.
Sinh	string	Scriptcode voor het Sinhala-script.
Taml	string	Scriptcode voor het Script Voor Het Script.
Telu	string	Scriptcode voor het Telugu-script.
Thaa	string	Scriptcode voor het Thaana-script.
Thai	string	Scriptcode voor het Thaise script.
Tibt	string	Scriptcode voor het Tibetaans schrift.

ScriptKind

Identificeert het script van het invoerdocument. Komt overeen met de formele iso 15924-standaardnaam.

Name	Type	Description
Arabic	string	Scriptnaam voor het Arabische script.
Armenian	string	Scriptnaam voor het Armeense script.
Bangla	string	Scriptnaam voor het Bangla-script.
Cyrillic	string	Scriptnaam voor het Cyrillische script.
Devanagari	string	Scriptnaam voor het Devanagari-script.
Ethiopic	string	Scriptnaam voor het Ethiopic-script.
Georgian	string	Scriptnaam voor het Georgische script.
Greek	string	Scriptnaam voor het Griekse script.
Gujarati	string	Scriptnaam voor het Gujarati-script.
Gurmukhi	string	Scriptnaam voor het Gurmukhi-script.
HanLiteral	string	Scriptnaam voor het HanLiteral-script.
HanSimplified	string	Scriptnaam voor het HanSimplified-script.
HanTraditional	string	Scriptnaam voor het HanTraditional-script.
Hangul	string	Scriptnaam voor het Hangul-script.
Hebrew	string	Scriptnaam voor het Hebreeuwse script.
Japanese	string	Scriptnaam voor het Japanse script.
Kannada	string	Scriptnaam voor het Kannada-script.
Khmer	string	Scriptnaam voor het Khmer-script.
Lao	string	Scriptnaam voor het Lao-script.
Latin	string	Scriptnaam voor het Latijnse script.
Malayalam	string	Scriptnaam voor het Malayalam-script.
Meitei	string	Scriptnaam voor het Meitei-script.
Mongolian	string	Scriptnaam voor het Mongoolse script.
Myanmar	string	Scriptnaam voor het script Myanmar.
Odia	string	Scriptnaam voor het Odia-script.
Santali	string	Scriptnaam voor het Santali-script.
Sharada	string	Scriptnaam voor het Sharada-script.
Sinhala	string	Scriptnaam voor het Sinhala-script.
Tamil	string	Scriptnaam voor het Script Voor Het Script.
Telugu	string	Scriptnaam voor het Telugu-script.
Thaana	string	Scriptnaam voor het Thaana-script.
Thai	string	Scriptnaam voor het Thaise script.
Tibetan	string	Scriptnaam voor het Tibetaans script.
UnifiedCanadianAboriginalSyllabics	string	Scriptnaam voor het script UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

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

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

SentenceSentiment

Het zinsgevoel van een document.

Name	Type	Description
assessments	SentenceAssessment[]	De matrix van evaluaties voor de zin.
confidenceScores	SentimentConfidenceScores	De betrouwbaarheidsscore van het gevoel tussen 0 en 1 voor de zin voor alle klassen.
length	integer	De lengte van het doel.
offset	integer	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

Het voorspelde gevoel voor de zin.

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

SentenceTarget

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

Name	Type	Description
confidenceScores	TargetConfidenceScoreLabel	Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.
length	integer	De lengte van het doel.
offset	integer	Het 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 gevoel van de zin.
text	string	De doeltekst gedetecteerd.

SentimentAnalysisTaskParameters

Ondersteunde parameters voor een sentimentanalysetaak.

Name	Type	Default value	Description
loggingOptOut	boolean	False	Afmelden voor afmelden voor afmelden
modelVersion	string	latest	modelversie
opinionMining	boolean	False	Of u meninganalyse in de aanvraag wilt gebruiken of niet.
stringIndexType	StringIndexType	TextElements_v8	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren.

SentimentConfidenceScores

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

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

SentimentDocumentResult

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

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

Resultaten van sentimentanalyse voor de invoerdocumenten.

Name	Type	Description
documents	SentimentDocumentResult[]	De resultaten van sentimentanalyse 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

Bevat het resultaat van de analysetekst SentimentAnalysis LRO-taak.

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

SpeedMetadata

Vertegenwoordigt het metagegevensmodel van de snelheidsentiteit.

Name	Type	Description
metadataKind	string: SpeedMetadata	Het objecttype Metagegevens van de entiteit.
unit	SpeedUnit	Maateenheid voor snelheid.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

SpeedUnit

De snelheidseenheid van de meting

Name	Type	Description
CentimetersPerMillisecond	string	Snelheidseenheid in centimeters per milliseconde.
FeetPerMinute	string	Snelheidseenheid in voet per minuut.
FeetPerSecond	string	Snelheidseenheid in voet per seconde.
KilometersPerHour	string	Snelheidseenheid in kilometers per uur.
KilometersPerMillisecond	string	Snelheidseenheid in kilometers per milliseconde.
KilometersPerMinute	string	Snelheidseenheid in kilometers per minuut.
KilometersPerSecond	string	Snelheidseenheid in kilometers per seconde.
Knots	string	Snelheidseenheid in knopen.
MetersPerMillisecond	string	Snelheidseenheid in meters per milliseconde.
MetersPerSecond	string	Snelheidseenheid in meters per seconde.
MilesPerHour	string	Snelheidseenheid in mijlen per uur.
Unspecified	string	Niet-opgegeven snelheidseenheid.
YardsPerMinute	string	Snelheidseenheid in meter per minuut.
YardsPerSecond	string	Snelheidseenheid in meter per seconde.

StringIndexType

Type tekenreeksindex

Name	Type	Description
TextElements_v8	string	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	string	Geretourneerde offset- en lengtewaarden komen overeen met Unicode-codepunten. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Python.
Utf16CodeUnit	string	Geretourneerde offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld JavaScript.

TargetConfidenceScoreLabel

Vertegenwoordigt de betrouwbaarheidsscores voor alle sentimentklassen: positief en negatief.

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

TargetRelation

Vertegenwoordigt de relatie tussen evaluaties en/of doelen.

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

TargetRelationType

Het type dat is gerelateerd aan het doel.

Name	Type	Description
assessment	string	Beoordelingsrelatie.
target	string	Doelrelatie.

TemperatureMetadata

Vertegenwoordigt het metagegevensmodel van de informatie-entiteit.

Name	Type	Description
metadataKind	string: TemperatureMetadata	Het objecttype Metagegevens van de entiteit.
unit	TemperatureUnit	Maateenheid voor temperatuur.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

TemperatureUnit

De temperatuureenheid van de meting.

Name	Type	Description
Celsius	string	Temperatuureenheid in Celsius
Fahrenheit	string	Temperatuureenheid in Fahrenheit
Kelvin	string	Temperatuureenheid in Kelvin
Rankine	string	Temperatuureenheid in Rankine
Unspecified	string	Niet-opgegeven temperatuureenheid

TemporalModifier

Een optionele wijziging van een datum/tijd-exemplaar.

Name	Type	Description
After	string	Na een specifieke tijd
AfterApprox	string	Na een geschatte tijd
AfterMid	string	Na het midden van een periode
AfterStart	string	Na het begin van een periode
Approx	string	Ongeveer op een bepaald tijdstip
Before	string	Voor een specifieke tijd
BeforeApprox	string	Voor een geschatte tijd
BeforeEnd	string	Vóór het einde van een periode
BeforeStart	string	Vóór het begin van een periode
End	string	Aan het einde van een periode
Less	string	Minder dan een specifieke tijd
Mid	string	Midden in een periode
More	string	Meer dan een specifieke tijd
ReferenceUndefined	string	Verwijzing naar een niet-gedefinieerde tijd
Since	string	Sinds een specifieke tijd
SinceEnd	string	Sinds het einde van een periode
Start	string	Aan het begin van een periode
Until	string	Tot een specifieke tijd

TemporalSetMetadata

Een metagegevens voor exemplaren van tijdelijke set-entiteiten.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TemporalSetMetadata	Het objecttype Metagegevens van de entiteit.

TemporalSpanMetadata

vertegenwoordigt de metagegevens van een datum en/of tijdsperiode.

Name	Type	Description
metadataKind	string: TemporalSpanMetadata	Het objecttype Metagegevens van de entiteit.
spanValues	TemporalSpanValues[]	Lijst met gedetecteerde tijdelijke periodes.

TemporalSpanValues

Tijdelijk spanobject.

Name	Type	Description
begin	string	Beginwaarde voor de periode.
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 periode.
modifier	TemporalModifier	Wijzigingsfunctie voor datum/tijd om een verwijzingspunt aan te geven, zoals voorheen, na, enzovoort.
timex	string	Een optionele triplet met het begin, het einde en de duur die allemaal als ISO 8601 opgemaakte tekenreeksen zijn opgegeven.

TimeMetadata

Een metagegevens voor tijdentiteitexemplaren.

Name	Type	Description
dateValues	DateValue[]	Lijst met datumwaarden.
metadataKind	string: TimeMetadata	Het objecttype Metagegevens van de entiteit.

TokenSentimentValue

Het voorspelde gevoel voor de zin.

Name	Type	Description
mixed	string	Gemengde sentimenten
negative	string	Negatief gevoel
positive	string	Positief gevoel

VolumeMetadata

Vertegenwoordigt het metagegevensmodel van de volumeentiteit.

Name	Type	Description
metadataKind	string: VolumeMetadata	Het objecttype Metagegevens van de entiteit.
unit	VolumeUnit	Maateenheid voor volume.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

VolumeUnit

De volume-eenheid van de meting

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

WarningCodeValue

Hiermee definieert u de lijst met waarschuwingscodes.

Name	Type	Description
DocumentTruncated	string	Waarschuwing over afgekapt document
LongWordsInDocument	string	Lange woorden in documentwaarschuwing

WeightMetadata

Vertegenwoordigt het model voor de gewichtsentiteitsmetagegevens.

Name	Type	Description
metadataKind	string: WeightMetadata	Het objecttype Metagegevens van de entiteit.
unit	WeightUnit	Maateenheid voor gewicht.
value	number	De numerieke waarde die de geëxtraheerde tekst aangeeft.

WeightUnit

De gewichtseenheid van de meting.

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