Text Analysis Runtime - Analyze Text

Dienst:

Azure AI Services

API-Version:

2024-11-01

Anfordern einer Textanalyse über eine Sammlung von Dokumenten.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
showStats	query		boolean	(Optional) Wenn dieser Wert auf "true" festgelegt ist, enthält die Antwort Statistiken zur Anforderungs- und Dokumentebene.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name	Beschreibung
AnalyzeTextEntityLinkingInput	Enthält die Eingabe für die Analyse des Textverknüpfungszeichens.
AnalyzeTextEntityRecognitionInput	Die Entitätserkennung analysiert die Texteingabeaufgabenanforderung.
AnalyzeTextKeyPhraseExtractionInput	Enthält die Eingabe des Analysetexts "KeyPhraseExtraction"-Aufgaben.
AnalyzeTextLanguageDetectionInput	Enthält die Eingabe der Aufgabeneingabe für die Dokumentanalyse für die Spracherkennung.
AnalyzeTextPiiEntitiesRecognitionInput	Enthält den Analysetext PIIEntityRecognition-Vorgangseingabe.
AnalyzeTextSentimentAnalysisInput	Enthält die Eingabe des Analysetexts "SentimentAnalysis".

AnalyzeTextEntityLinkingInput

Enthält die Eingabe für die Analyse des Textverknüpfungszeichens.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: EntityLinking	Die Art der auszuführenden Aufgabe.
analysisInput		MultiLanguageAnalysisInput	Enthält die analyseeingabe, die vom Dienst verarbeitet werden soll.
parameters		EntityLinkingTaskParameters	Vorgangsparameter.

AnalyzeTextEntityRecognitionInput

Die Entitätserkennung analysiert die Texteingabeaufgabenanforderung.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: EntityRecognition	Die Art der auszuführenden Aufgabe.
analysisInput		MultiLanguageAnalysisInput	Die zu analysierende Eingabe.
parameters		EntitiesTaskParameters	Vorgangsparameter.

AnalyzeTextKeyPhraseExtractionInput

Enthält die Eingabe des Analysetexts "KeyPhraseExtraction"-Aufgaben.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: KeyPhraseExtraction	Die Art der auszuführenden Aufgabe.
analysisInput		MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
parameters		KeyPhraseTaskParameters	Parameter für die Schlüsselausdruckextraktion.

AnalyzeTextLanguageDetectionInput

Enthält die Eingabe der Aufgabeneingabe für die Dokumentanalyse für die Spracherkennung.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: LanguageDetection	Die Art der auszuführenden Aufgabe.
analysisInput		LanguageDetectionAnalysisInput	Zu analysierende Dokumente.
parameters		LanguageDetectionTaskParameters	Vorgangsparameter.

AnalyzeTextPiiEntitiesRecognitionInput

Enthält den Analysetext PIIEntityRecognition-Vorgangseingabe.

Name	Erforderlich	Typ	Beschreibung
kind	True	string: PiiEntityRecognition	Die Art der auszuführenden Aufgabe.
analysisInput		MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
parameters		PiiTaskParameters	Pii-Vorgangsparameter.

AnalyzeTextSentimentAnalysisInput

Enthält die Eingabe des Analysetexts "SentimentAnalysis".

Name	Erforderlich	Typ	Beschreibung
kind	True	string: SentimentAnalysis	Die Art der auszuführenden Aufgabe.
analysisInput		MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
parameters		SentimentAnalysisTaskParameters	Parameter für die Stimmungsanalyse.

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
AgeMetadata	Stellt das Metadatenmodell der Altersentität dar.
AgeUnit	Die Alterseinheit der Messung
AllowOverlapEntityPolicyType	Stellt die Richtlinie zum Zulassen von Überlappungen dar. Wendet keine Nachbearbeitungslogik für die Entitäten an. Was das Modell voraussagt, ist, was an den Benutzer zurückgegeben wird. Auf diese Weise kann der Benutzer die möglichen Werte jedes einzelnen Modells vollständig anzeigen und seine eigene benutzerdefinierte Logik auf die Entitätsauswahl anwenden.
AnalyzeTextEntityLinkingInput	Enthält die Eingabe für die Analyse des Textverknüpfungszeichens.
AnalyzeTextEntityRecognitionInput	Die Entitätserkennung analysiert die Texteingabeaufgabenanforderung.
AnalyzeTextKeyPhraseExtractionInput	Enthält die Eingabe des Analysetexts "KeyPhraseExtraction"-Aufgaben.
AnalyzeTextLanguageDetectionInput	Enthält die Eingabe der Aufgabeneingabe für die Dokumentanalyse für die Spracherkennung.
AnalyzeTextPiiEntitiesRecognitionInput	Enthält den Analysetext PIIEntityRecognition-Vorgangseingabe.
AnalyzeTextSentimentAnalysisInput	Enthält die Eingabe des Analysetexts "SentimentAnalysis".
AnalyzeTextTaskKind	Die Art der unterstützten Analysetextaufgaben.
AnalyzeTextTaskResultsKind	Die Art des Antwortobjekts, das von der Analysetextaufgabe zurückgegeben wird.
AreaMetadata	Represents the Area entity Metadata model.
AreaUnit	Die Maßeinheit.
CurrencyMetadata	Represents the Currency ) entity Metadata model.
DateMetadata	Metadaten für Datumsentitätsinstanzen.
DateTimeMetadata	Metadaten für Datetime-Entitätsinstanzen.
DateValue	Stellt den Datumswert dar.
DetectedLanguage	Enthält die Details der erkannten Sprache für den Text.
DocumentError	Enthält Details zu Fehlern, die während einer Auftragsausführung aufgetreten sind.
DocumentSentimentValue	Prognostizierte Stimmung für Das Dokument (Negativ, Neutral, Positiv oder Gemischt).
DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
DocumentWarning	Enthält das Warnungsobjekt mit Warnungen für das verarbeitete Dokument.
EntitiesDocumentResultWithMetadata	Entitätsdokumente ergeben sich mit Metadaten.
EntitiesResult	Enthält das Ergebnis der Entitätserkennung.
EntitiesTaskParameters	Unterstützte Parameter für eine Entitätserkennungsaufgabe.
EntitiesTaskResult	Enthält die Entitätsaufgabe
Entity	Definiert das erkannte Entitätsobjekt, das die Entitätskategorie und den erkannten Entitätstext enthält usw.
EntityCategory	Enthält alle Entitätskategorien, die von der Entitätserkennung erkannt wurden.
EntityInferenceOptions	Die Klasse, die die Schlussfolgerungsoptionen enthält, die für die benannte Entitätserkennung zulässig sind.
EntityLinkingResult	Ergebnis der Entitätsverknüpfung.
EntityLinkingTaskParameters	Unterstützte Parameter für eine Entitätsverknüpfungsaufgabe.
EntityLinkingTaskResult	Enthält das Ergebnis der Analyse des Vorgangs "Entitätsverknüpfung".
EntityTag	Entitätstagsobjekt, das den Namen der Tags enthält, die alle zugeordneten Konfidenzbewertungen abgibt. Entitätstags werden verwendet, um einige Ähnlichkeiten/Affinitäten zwischen Entitäten auszudrücken.
EntityWithMetadata	Entity-Objekt mit Tags und Metadaten.
Error	Das zurückgegebene Fehlerantwortobjekt, wenn beim Verarbeiten der Anforderung fehler auftreten.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InformationMetadata	Represents the Information (data) entity Metadata model.
InformationUnit	Die Information (Daten) Maßeinheit.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Enthält das KeyPhraseResult.
KeyPhrasesDocumentResult	Enthält die Ergebnisse der Schlüsselausdruckextraktion für ein Dokument.
KeyPhraseTaskParameters	Unterstützte Parameter für einen Key Phrase Extraction-Vorgang.
KeyPhraseTaskResult	Enthält das Analysetext-Taskergebnis "KeyPhraseExtraction".
LanguageDetectionAnalysisInput	Enthält die Eingabe der Dokumentanalyse für die Spracherkennung.
LanguageDetectionDocumentResult	Enthält die Spracherkennung für ein Dokument.
LanguageDetectionResult	Enthält das Spracherkennungsergebnis für die Anforderung.
LanguageDetectionTaskParameters	Unterstützte Parameter für eine Spracherkennungsaufgabe.
LanguageDetectionTaskResult	Enthält das Aufgabenergebnis für die Spracherkennung für die Anforderung.
LanguageInput	Enthält die Eingabe der Spracherkennung.
LengthMetadata	Represents the Length entity Metadata model.
LengthUnit	Die Längeneinheit der Maßeinheit.
LinkedEntitiesDocumentResult	Ergebnis des Entitätsverknüpfungsdokuments.
LinkedEntity	Das LinkedEntity-Objekt, das die erkannte Entität mit den zugehörigen Quellen/Links enthält.
Match	Das Match -Objekt, das den erkannten Entitätstext mit dem Offset und der Länge enthält.
MatchLongestEntityPolicyType	Stellt die Längste Überlappungsrichtlinie "Übereinstimmung" dar. Es gibt keine überlappenden Entitäten, soweit dies möglich ist. 1. Wenn sich überlappende Entitäten befinden, wird die längste Entität zurückgegeben. 2. Wenn die anzahl der für 2 oder mehr Entitäten vorhergesagten Zeichen identisch sind, wählen Sie die Entität aus, die den höheren Konfidenzwert aufweist.3. Wenn die Entitätsbewertungen identisch sind, geben Sie alle Entitäten zurück, die nach dem Anwenden der vorherigen Regeln noch vorhanden sind. 3. Wenn es teilweise Überlappungen (wie in Hello Text Analytics) gibt, führen Sie die oben genannten Schritte ab 1 aus.
MetadataKind	Der Entitätsmetadatenobjekttyp.
MultiLanguageAnalysisInput	Sammlung von Eingabedokumenten, die vom Dienst analysiert werden sollen.
MultiLanguageInput	Enthält ein Eingabedokument, das vom Dienst analysiert werden soll.
NumberKind	Der Typ der extrahierten Nummernentität.
NumberMetadata	Metadaten für numerische Entitätsinstanzen.
NumericRangeMetadata	stellt die Metadaten numerischer Intervalle dar.
OrdinalMetadata	Metadaten für numerische Entitätsinstanzen.
PiiCategory	(Optional) beschreibt die zurückzugebenden PII-Kategorien
PiiDomain	Domäne für PII-Aufgabe
PiiEntitiesDocumentResult	Enthält die PII-Ergebnisse.
PiiResult	Enthält das PiiResult.
PiiTaskParameters	Unterstützte Parameter für eine PII-Entitätenerkennungsaufgabe.
PiiTaskResult	Enthält den Analysetext PIIEntityRecognition LRO-Vorgang.
RangeInclusivity	Der Bereich einschließlich dieser Eigenschaft.
RangeKind	Die Art der Nummerbereichsentität.
RelativeTo	Der Bezugspunkt, den die Ordnungszahl angibt.
RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.
ScriptCode	Identifiziert das Skript des Eingabedokuments. Ordnet den ISO 15924-Standardskriptcode zu.
ScriptKind	Identifiziert das Skript des Eingabedokuments. Ordnet den formalen Iso 15924-Standardnamen zu.
SentenceAssessment	Stellt eine Satzbewertung und die Bewertungen oder Zielobjekte dar, die damit verbunden sind.
SentenceSentiment	Das Satzgefühl eines Dokuments.
SentenceSentimentValue	Die vorhergesagte Stimmung für den Satz.
SentenceTarget	Stellt ein Satzziel und die Bewertungen oder Zielobjekte dar, die damit verbunden sind.
SentimentAnalysisTaskParameters	Unterstützte Parameter für eine Einstellungsanalyseaufgabe.
SentimentConfidenceScores	Stellt die Konfidenzergebnisse zwischen 0 und 1 in allen Stimmungsklassen dar: positiv, neutral, negativ.
SentimentDocumentResult	Ein Objekt, das die vordefinierten Ergebnisse der Stimmungsanalyse jedes Dokuments darstellt.
SentimentResponse	Ergebnisse der Stimmungsanalyse für die Eingabedokumente.
SentimentTaskResult	Enthält den Analysetext SentimentAnalysis LRO-Vorgangsergebnis.
SpeedMetadata	Stellt das Metadatenmodell der Speed-Entität dar.
SpeedUnit	Die Geschwindigkeitseinheit der Messung
StringIndexType	Zeichenfolgenindextyp
TargetConfidenceScoreLabel	Stellt die Konfidenzbewertungen in allen Stimmungsklassen dar: positiv und negativ.
TargetRelation	Stellt die Beziehung zwischen Bewertungen und/oder Zielen dar.
TargetRelationType	Der Typ, der mit dem Ziel verknüpft ist.
TemperatureMetadata	Represents the Information entity Metadata model.
TemperatureUnit	Die Temperatureinheit der Messung.
TemporalModifier	Ein optionaler Modifizierer einer Datums-/Uhrzeitinstanz.
TemporalSetMetadata	Metadaten für zeitlich festgelegte Entitätsinstanzen.
TemporalSpanMetadata	stellt die Metadaten einer Datums- und/oder Zeitspanne dar.
TemporalSpanValues	Temporal span object.
TimeMetadata	Metadaten für Zeitentitätsinstanzen.
TokenSentimentValue	Die vorhergesagte Stimmung für den Satz.
VolumeMetadata	Stellt das Volume-Entitätsmetadatenmodell dar.
VolumeUnit	Die Maßeinheit
WarningCodeValue	Definiert die Liste der Warnungscodes.
WeightMetadata	Represents the Weight ) entity Metadata model.
WeightUnit	Die Gewichtseinheit der Maßeinheit.

AgeMetadata

Objekt

Stellt das Metadatenmodell der Altersentität dar.

Name	Typ	Beschreibung
metadataKind	string: AgeMetadata	Der Entitätsmetadatenobjekttyp.
unit	AgeUnit	Maßeinheit für das Alter.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

AgeUnit

Enumeration

Die Alterseinheit der Messung

Wert	Beschreibung
Day	Zeitraum eines Tages
Month	Zeitraum eines Monats
Unspecified	Nicht spezifizierter Zeitraum
Week	Zeitraum einer Woche
Year	Zeitraum eines Jahres

AllowOverlapEntityPolicyType

Objekt

Stellt die Richtlinie zum Zulassen von Überlappungen dar. Wendet keine Nachbearbeitungslogik für die Entitäten an. Was das Modell voraussagt, ist, was an den Benutzer zurückgegeben wird. Auf diese Weise kann der Benutzer die möglichen Werte jedes einzelnen Modells vollständig anzeigen und seine eigene benutzerdefinierte Logik auf die Entitätsauswahl anwenden.

Name	Typ	Standardwert	Beschreibung
policyKind	string: allowOverlap	matchLongest	Die Entität OverlapPolicy-Objektart.

AnalyzeTextEntityLinkingInput

Objekt

Enthält die Eingabe für die Analyse des Textverknüpfungszeichens.

Name	Typ	Beschreibung
analysisInput	MultiLanguageAnalysisInput	Enthält die analyseeingabe, die vom Dienst verarbeitet werden soll.
kind	string: EntityLinking	Die Art der auszuführenden Aufgabe.
parameters	EntityLinkingTaskParameters	Vorgangsparameter.

AnalyzeTextEntityRecognitionInput

Objekt

Die Entitätserkennung analysiert die Texteingabeaufgabenanforderung.

Name	Typ	Beschreibung
analysisInput	MultiLanguageAnalysisInput	Die zu analysierende Eingabe.
kind	string: EntityRecognition	Die Art der auszuführenden Aufgabe.
parameters	EntitiesTaskParameters	Vorgangsparameter.

AnalyzeTextKeyPhraseExtractionInput

Objekt

Enthält die Eingabe des Analysetexts "KeyPhraseExtraction"-Aufgaben.

Name	Typ	Beschreibung
analysisInput	MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
kind	string: KeyPhraseExtraction	Die Art der auszuführenden Aufgabe.
parameters	KeyPhraseTaskParameters	Parameter für die Schlüsselausdruckextraktion.

AnalyzeTextLanguageDetectionInput

Objekt

Enthält die Eingabe der Aufgabeneingabe für die Dokumentanalyse für die Spracherkennung.

Name	Typ	Beschreibung
analysisInput	LanguageDetectionAnalysisInput	Zu analysierende Dokumente.
kind	string: LanguageDetection	Die Art der auszuführenden Aufgabe.
parameters	LanguageDetectionTaskParameters	Vorgangsparameter.

AnalyzeTextPiiEntitiesRecognitionInput

Objekt

Enthält den Analysetext PIIEntityRecognition-Vorgangseingabe.

Name	Typ	Beschreibung
analysisInput	MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
kind	string: PiiEntityRecognition	Die Art der auszuführenden Aufgabe.
parameters	PiiTaskParameters	Pii-Vorgangsparameter.

AnalyzeTextSentimentAnalysisInput

Objekt

Enthält die Eingabe des Analysetexts "SentimentAnalysis".

Name	Typ	Beschreibung
analysisInput	MultiLanguageAnalysisInput	Enthält die Eingabedokumente.
kind	string: SentimentAnalysis	Die Art der auszuführenden Aufgabe.
parameters	SentimentAnalysisTaskParameters	Parameter für die Stimmungsanalyse.

AnalyzeTextTaskKind

Enumeration

Die Art der unterstützten Analysetextaufgaben.

Wert	Beschreibung
EntityLinking	Entitätsverknüpfungsaufgabe
EntityRecognition	Entitätserkennungsaufgabe
KeyPhraseExtraction	Schlüsselauszugsaufgabe
LanguageDetection	Aufgaben zur Spracherkennung
PiiEntityRecognition	PiI-Entitätserkennungsaufgabe
SentimentAnalysis	Vorgang "Stimmungsanalyse"

AnalyzeTextTaskResultsKind

Enumeration

Die Art des Antwortobjekts, das von der Analysetextaufgabe zurückgegeben wird.

Wert	Beschreibung
EntityLinkingResults	Ergebnisse der Entitätsverknüpfung
EntityRecognitionResults	Ergebnisse der Entitätserkennung
KeyPhraseExtractionResults	Ergebnisse der Schlüsselauszugsextraktion
LanguageDetectionResults	Ergebnisse der Spracherkennung
PiiEntityRecognitionResults	Ergebnisse der PII-Entitätserkennung
SentimentAnalysisResults	Ergebnisse der Stimmungsanalyse

AreaMetadata

Objekt

Represents the Area entity Metadata model.

Name	Typ	Beschreibung
metadataKind	string: AreaMetadata	Der Entitätsmetadatenobjekttyp.
unit	AreaUnit	Maßeinheit für Fläche.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

AreaUnit

Enumeration

Die Maßeinheit.

Wert	Beschreibung
Acre	Flächeneinheit in Hektar
SquareCentimeter	Flächeneinheit in quadratischen Zentimetern
SquareDecameter	Flächeneinheit in Quadratdekametern
SquareDecimeter	Flächeneinheit in quadratischen Dezimetern
SquareFoot	Flächeneinheit in Quadratfuß
SquareHectometer	Flächeneinheit in quadratischen Hektometern
SquareInch	Flächeneinheit in Quadrat zoll
SquareKilometer	Flächeneinheit in Quadratkilometern
SquareMeter	Flächeneinheit in Quadratmetern
SquareMile	Flächeneinheit in Quadratmeilen
SquareMillimeter	Flächeneinheit in quadratischen Millimetern
SquareYard	Flächeneinheit in Quadratmetern
Unspecified	Nicht angegebene Bereichseinheit

CurrencyMetadata

Objekt

Represents the Currency ) entity Metadata model.

Name	Typ	Beschreibung
iso4217	string	Der alphabetische Code basierend auf einem anderen ISO-Standard, ISO 3166, der die Codes für Ländernamen auflistet. Die ersten beiden Buchstaben des ISO 4217-Codes mit drei Buchstaben sind mit dem Code für den Landesnamen identisch, und gegebenenfalls entspricht der dritte Buchstabe dem ersten Buchstaben des Währungsnamens.
metadataKind	string: CurrencyMetadata	Der Entitätsmetadatenobjekttyp.
unit	string	Währungseinheit.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

DateMetadata

Objekt

Metadaten für Datumsentitätsinstanzen.

Name	Typ	Beschreibung
dateValues	DateValue[]	Liste der Datumswerte.
metadataKind	string: DateMetadata	Der Entitätsmetadatenobjekttyp.

DateTimeMetadata

Objekt

Metadaten für Datetime-Entitätsinstanzen.

Name	Typ	Beschreibung
dateValues	DateValue[]	Liste der Datumswerte.
metadataKind	string: DateTimeMetadata	Der Entitätsmetadatenobjekttyp.

DateValue

Objekt

Stellt den Datumswert dar.

Name	Typ	Beschreibung
modifier	TemporalModifier	Modifizierer für Datetime, um Bezugspunkt wie zuvor, nach usw. anzugeben.
timex	string	Eine erweiterte ISO 8601-Datums-/Uhrzeitdarstellung wie in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Die tatsächliche Zeit, die der extrahierte Text angibt.

DetectedLanguage

Objekt

Enthält die Details der erkannten Sprache für den Text.

Name	Typ	Beschreibung
confidenceScore	number (double)	Eine Konfidenzbewertung zwischen 0 und 1. Die Bewertungen in der Nähe von 1 deuten auf 100% Sicherheit hin, dass die identifizierte Sprache wahr ist.
iso6391Name	string	Eine zwei buchstabenweise Darstellung der erkannten Sprache gemäß dem ISO 639-1-Standard (z. B. en, fr).
name	string	Langer Name einer erkannten Sprache (z. B. Englisch, Französisch).
scriptIso15924Code	ScriptCode	Identifiziert den Skriptcode des Eingabedokuments gemäß dem ISO 15924-Standard.
scriptName	ScriptKind	Gibt den Skriptnamen des Eingabedokuments gemäß dem ISO 15924-Standard an.

DocumentError

Objekt

Enthält Details zu Fehlern, die während einer Auftragsausführung aufgetreten sind.

Name	Typ	Beschreibung
error	Error	Fehler.
id	string	Die ID des Eingabedokuments.

DocumentSentimentValue

Enumeration

Prognostizierte Stimmung für Das Dokument (Negativ, Neutral, Positiv oder Gemischt).

Wert	Beschreibung
mixed	Gemischte Anweisung
negative	Negative Anweisung
neutral	Neutrale Anweisung
positive	Positive Aussage

DocumentStatistics

Objekt

wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.

Name	Typ	Beschreibung
charactersCount	integer (int32)	Die Anzahl der im Dokument erkannten Textelemente.
transactionsCount	integer (int32)	Anzahl der Transaktionen für das Dokument.

DocumentWarning

Objekt

Enthält das Warnungsobjekt mit Warnungen für das verarbeitete Dokument.

Name	Typ	Beschreibung
code	WarningCodeValue	Warnungscode.
message	string	Warnmeldung.
targetRef	string	Ein JSON-Zeigerverweis, der das Zielobjekt angibt.

EntitiesDocumentResultWithMetadata

Objekt

Entitätsdokumente ergeben sich mit Metadaten.

Name	Typ	Beschreibung
entities	EntityWithMetadata[]	Erkannte Entitäten im Dokument.
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

EntitiesResult

Objekt

Enthält das Ergebnis der Entitätserkennung.

Name	Typ	Beschreibung
documents	EntitiesDocumentResultWithMetadata[]	Antwort nach Dokument
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

EntitiesTaskParameters

Objekt

Unterstützte Parameter für eine Entitätserkennungsaufgabe.

Name	Typ	Standardwert	Beschreibung
exclusionList	EntityCategory[]		(Optional) Anforderungsparameter, der alle Entitäten herausfiltert, die die excludeList enthalten. Wenn ein Benutzer eine excludeList angibt, kann er keine Vorhersage abrufen, die mit einer Entität in dieser Liste zurückgegeben wird. Wir wenden "inclusionList" vor "exclusionList" an.
inclusionList	EntityCategory[]		(Optional) Anforderungsparameter, der die Ausgabe auf die angeforderten Entitätstypen beschränkt, die in dieser Liste enthalten sind. Wir wenden "inclusionList" vor "exclusionList" an.
inferenceOptions	EntityInferenceOptions		(Optional) Anforderungsparameter, mit dem der Benutzer Einstellungen für die Ausführung der Ableitung bereitstellen kann.
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Optional) beschreibt den Typ der Überlappungsrichtlinie, die auf die ner-Ausgabe angewendet werden soll.
stringIndexType	StringIndexType	TextElements_v8	(Optional) Parameter zum Bereitstellen des Zeichenfolgenindextyps, der zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Standardmäßig werden TextElements (Graphemes) verwendet.

EntitiesTaskResult

Objekt

Enthält die Entitätsaufgabe

Name	Typ	Beschreibung
kind	string: EntityRecognitionResults	Die Art des Vorgangsergebnisses.
results	EntitiesResult	Ergebnisse für die Entitätserkennung.

Entity

Objekt

Definiert das erkannte Entitätsobjekt, das die Entitätskategorie und den erkannten Entitätstext enthält usw.

Name	Typ	Beschreibung
category	string	Entitätstyp.
confidenceScore	number (double)	Konfidenzbewertung zwischen 0 und 1 der extrahierten Entität.
length	integer (int32)	Länge für den Entitätstext. Die Verwendung verschiedener 'stringIndexType'-Werte kann sich auf die zurückgegebene Länge auswirken.
offset	integer (int32)	Startposition für den Entitätstext. Die Verwendung verschiedener 'stringIndexType'-Werte kann sich auf den zurückgegebenen Offset auswirken.
subcategory	string	(Optional) Entitätsuntertyp.
text	string	Entitätstext wie in der Anforderung angezeigt.

EntityCategory

Enumeration

Enthält alle Entitätskategorien, die von der Entitätserkennung erkannt wurden.

Wert	Beschreibung
Address	Spezifische Erwähnungen auf Straßenebene von Orten: Haus-/Gebäudenummern, Straßen, Straßen, Straßen, Straßen, Autobahnen, Kreuzungen, auf die nach Namen verwiesen wird.
Age	Altersbezogene Werte.
Airport	Flughäfen.
Area	Bereich eines Objekts.
City	Ortsbezogene Werte.
ComputingProduct	Computerprodukte.
Continent	Kontinentbezogene Werte.
CountryRegion	Länder- oder regionsbezogene Werte.
CulturalEvent	Kulturereignisbezogene Werte.
Currency	Währungsbezogene Werte.
Date	Kalenderdaten.
DateRange	Datumsbereich.
DateTime	Kalenderdaten mit Uhrzeit.
DateTimeRange	Bereich von Datum und Uhrzeit.
Dimension	Dimension der Messungen
Duration	Dauer.
Email	E-Mail-Adressen.
Event	Soziale, Sport, Wirtschaft, Politik, Bildung, natürlich, historisch, kriminelle, gewalttätige, rechtliche, militärische Ereignisse mit einer bestimmten Zeit.
GPE	Städte, Länder/Regionen, Staaten.
Geological	Geografische und natürliche Merkmale wie Flüsse, Ozeane und Wüsten.
Height	Höhe eines Objekts.
IP	Netzwerk-IP-Adressen.
Information	Maßeinheit für digitale Informationen.
Length	Länge eines Objekts.
Location	Bestimmter Punkt oder Ort im physischen Raum.
NaturalEvent	Natürliche ereignisbezogene Werte.
Number	Zahlen ohne Einheit
NumberRange	Zahlenbereich
Numeric	Numerische Werte, einschließlich Ziffern und Zahlenwörter.
Ordinal	Ordnungszahlen.
Organization	Unternehmen, Agenturen und andere Gruppen von Personen, die von einer etablierten Organisationsstruktur definiert wurden. Diese Bezeichnungen können Firmen, politische Parteien/Bewegungen, Musikbänder, Sportvereine, Regierungsstellen und öffentliche Organisationen umfassen. Nationalitäten oder Religionen sind keine ORGANISATION.
OrganizationMedical	Medizinische Unternehmen und Gruppen.
OrganizationSports	Sportbezogene Organisationen.
OrganizationStockExchange	Börsengruppen.
Percentage	Prozentbezogene Werte.
Person	Vornamen, Nach- und Vornamen, Namen fiktiver Zeichen und Aliase. Titel, z. B. "Herr". oder "Präsident" werden nicht als Teil der benannten Entität betrachtet.
PersonType	Menschliche Rollen, die von einer Gruppenmitgliedschaft klassifiziert wurden.
PhoneNumber	Telefonnummern (nur US- und EU-Telefonnummern).
Product	Einzel- oder Gruppen von kommerziellen, Verbrauchsgegenständen, Elektronik, Fahrzeugen, Lebensmittelgruppen.
SetTemporal	Satz zeitbezogener Werte.
Skill	Eine Fähigkeit, Fähigkeit oder Kompetenz.
Speed	Geschwindigkeit eines Objekts.
SportsEvent	Sportereignisbezogene Werte.
State	Zustandsbezogene Werte.
Structural	Menschengemachte Strukturen.
Temperature	Temperaturbezogene Werte.
Temporal	Elemente, die sich auf die Zeit beziehen.
Time	Tageszeiten.
TimeRange	Zeitraum.
URL	URLs zu Websites.
Volume	Volume eines Objekts.
Weight	Gewichtung eines Objekts.

EntityInferenceOptions

Objekt

Die Klasse, die die Schlussfolgerungsoptionen enthält, die für die benannte Entitätserkennung zulässig sind.

Name	Typ	Standardwert	Beschreibung
excludeNormalizedValues	boolean	False	Option zum Einschließen/Ausschließen der erkannten Entitätswerte, die normalisiert und in die Metadaten eingeschlossen werden sollen. Die numerischen und zeitlichen Entitätstypen unterstützen die Wertnormalisierung.

EntityLinkingResult

Objekt

Ergebnis der Entitätsverknüpfung.

Name	Typ	Beschreibung
documents	LinkedEntitiesDocumentResult[]	Antwort nach Dokument
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

EntityLinkingTaskParameters

Objekt

Unterstützte Parameter für eine Entitätsverknüpfungsaufgabe.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
stringIndexType	StringIndexType	TextElements_v8	Optionaler Parameter zum Bereitstellen des Zeichenfolgenindextyps, der zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Standardmäßig werden TextElements (Graphemes) verwendet.

EntityLinkingTaskResult

Objekt

Enthält das Ergebnis der Analyse des Vorgangs "Entitätsverknüpfung".

Name	Typ	Beschreibung
kind	string: EntityLinkingResults	Die Art des Vorgangsergebnisses.
results	EntityLinkingResult	Ergebnis der Entitätsverknüpfung.

EntityTag

Objekt

Entitätstagsobjekt, das den Namen der Tags enthält, die alle zugeordneten Konfidenzbewertungen abgibt. Entitätstags werden verwendet, um einige Ähnlichkeiten/Affinitäten zwischen Entitäten auszudrücken.

Name	Typ	Beschreibung
confidenceScore	number (double)	Erkennungsbewertung zwischen 0 und 1 der extrahierten Entität.
name	string	Name des Tags. Entitätstagsnamen werden global eindeutig sein.

EntityWithMetadata

Objekt

Entity-Objekt mit Tags und Metadaten.

Name	Typ	Beschreibung
category	string	Entitätstyp.
confidenceScore	number (double)	Konfidenzbewertung zwischen 0 und 1 der extrahierten Entität.
length	integer (int32)	Länge für den Entitätstext. Die Verwendung verschiedener 'stringIndexType'-Werte kann sich auf die zurückgegebene Länge auswirken.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Das Entitätsmetadatenobjekt.
offset	integer (int32)	Startposition für den Entitätstext. Die Verwendung verschiedener 'stringIndexType'-Werte kann sich auf den zurückgegebenen Offset auswirken.
subcategory	string	(Optional) Entitätsuntertyp.
tags	EntityTag[]	Liste der Entitätstags. Tags sollen einige Ähnlichkeiten/Affinitäten zwischen Entitäten ausdrücken.
text	string	Entitätstext wie in der Anforderung angezeigt.
type	string	Ein Entitätstyp ist die niedrigste (oder feinste) Granularität, bei der die Entität erkannt wurde. Der Typ ist den spezifischen Metadatenattributen zugeordnet, die der erkannten Entität zugeordnet sind.

Error

Objekt

Das zurückgegebene Fehlerantwortobjekt, wenn beim Verarbeiten der Anforderung fehler auftreten.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
Conflict	Konfliktfehler
Forbidden	Fehler beim unzulässigen Zugriff
InternalServerError	Interner Serverfehler
InvalidArgument	Ungültiger Argumentfehler
InvalidRequest	Ungültiger Anforderungsfehler
NotFound	Fehler nicht gefunden
OperationNotFound	Fehler beim Vorgang nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
QuotaExceeded	Fehler "Kontingent überschritten"
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
TooManyRequests	Fehler bei zu vielen Anforderungen
Unauthorized	Fehler beim nicht autorisierten Zugriff
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InformationMetadata

Objekt

Represents the Information (data) entity Metadata model.

Name	Typ	Beschreibung
metadataKind	string: InformationMetadata	Der Entitätsmetadatenobjekttyp.
unit	InformationUnit	Maßeinheit für Informationen.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

InformationUnit

Enumeration

Die Information (Daten) Maßeinheit.

Wert	Beschreibung
Bit	Datengröße in Bits
Byte	Datengröße in Byte
Gigabit	Datengröße in Gigabits
Gigabyte	Datengröße in Gigabyte
Kilobit	Datengröße in Kilobits
Kilobyte	Datengröße in Kilobyte
Megabit	Datengröße in Megabits
Megabyte	Datengröße in Megabyte
Petabit	Datengröße in Petabits
Petabyte	Datengröße in Petabytes
Terabit	Datengröße in Terabits
Terabyte	Datengröße in Terabytes
Unspecified	Nicht angegebene Datengrößeneinheit

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
EmptyRequest	Fehler "Leere Anforderung"
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidCountryHint	Ungültiger Fehler im Landhinweis
InvalidDocument	Ungültiger Dokumentfehler
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
InvalidRequest	Ungültiger Anforderungsfehler
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
ModelVersionIncorrect	Fehler bei der Modellversion
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

KeyPhraseResult

Objekt

Enthält das KeyPhraseResult.

Name	Typ	Beschreibung
documents	KeyPhrasesDocumentResult[]	Antwort nach Dokument
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

KeyPhrasesDocumentResult

Objekt

Enthält die Ergebnisse der Schlüsselausdruckextraktion für ein Dokument.

Name	Typ	Beschreibung
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
keyPhrases	string[]	Eine Liste der repräsentativen Wörter oder Ausdrücke. Die Anzahl der zurückgegebenen Tastenausdrücke ist proportional zur Anzahl der Wörter im Eingabedokument.
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

KeyPhraseTaskParameters

Objekt

Unterstützte Parameter für einen Key Phrase Extraction-Vorgang.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion

KeyPhraseTaskResult

Objekt

Enthält das Analysetext-Taskergebnis "KeyPhraseExtraction".

Name	Typ	Beschreibung
kind	string: KeyPhraseExtractionResults	Die Art des Vorgangsergebnisses.
results	KeyPhraseResult	Die Liste der Ergebnisse der Schlüsselausdruckextraktion

LanguageDetectionAnalysisInput

Objekt

Enthält die Eingabe der Dokumentanalyse für die Spracherkennung.

Name	Typ	Beschreibung
documents	LanguageInput[]	Liste der zu analysierenden Dokumente.

LanguageDetectionDocumentResult

Objekt

Enthält die Spracherkennung für ein Dokument.

Name	Typ	Beschreibung
detectedLanguage	DetectedLanguage	Erkannte Sprache.
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

LanguageDetectionResult

Objekt

Enthält das Spracherkennungsergebnis für die Anforderung.

Name	Typ	Beschreibung
documents	LanguageDetectionDocumentResult[]	Aufzählung der Ergebnisse der Spracherkennung für jedes Eingabedokument.
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

LanguageDetectionTaskParameters

Objekt

Unterstützte Parameter für eine Spracherkennungsaufgabe.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion

LanguageDetectionTaskResult

Objekt

Enthält das Aufgabenergebnis für die Spracherkennung für die Anforderung.

Name	Typ	Beschreibung
kind	string: LanguageDetectionResults	Die Art des Vorgangsergebnisses.
results	LanguageDetectionResult	Enthält die Ergebnisse der Spracherkennung.

LanguageInput

Objekt

Enthält die Eingabe der Spracherkennung.

Name	Typ	Beschreibung
countryHint	string	Der Länderhinweis, der bei der Spracherkennung des Texts hilft.
id	string	Ein eindeutiger, nicht leerer Dokumentbezeichner.
text	string	Der zu verarbeitende Eingabetext.

LengthMetadata

Objekt

Represents the Length entity Metadata model.

Name	Typ	Beschreibung
metadataKind	string: LengthMetadata	Der Entitätsmetadatenobjekttyp.
unit	LengthUnit	Maßeinheit für Länge.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

LengthUnit

Enumeration

Die Längeneinheit der Maßeinheit.

Wert	Beschreibung
Centimeter	Längeneinheit in Zentimetern.
Decameter	Längeneinheit in Dekametern.
Decimeter	Längeneinheit in Dezimetern.
Foot	Längeneinheit in Füßen.
Hectometer	Längeneinheit in Hektometern.
Inch	Längeneinheit in Zoll.
Kilometer	Längeneinheit in Kilometern.
LightYear	Längeneinheit in Lichtjahren.
Meter	Längeneinheit in Metern.
Micrometer	Längeneinheit in Mikrometern.
Mile	Längeneinheit in Meilen.
Millimeter	Längeneinheit in Millimetern.
Nanometer	Längeneinheit in Nanos.
Picometer	Längeneinheit in Picometern.
Point	Längeneinheit in Punkt.
Unspecified	Nicht angegebene Längeneinheit.
Yard	Längeneinheit in Yards.

LinkedEntitiesDocumentResult

Objekt

Ergebnis des Entitätsverknüpfungsdokuments.

Name	Typ	Beschreibung
entities	LinkedEntity[]	Bekannte Entitäten im Dokument erkannt.
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

LinkedEntity

Objekt

Das LinkedEntity-Objekt, das die erkannte Entität mit den zugehörigen Quellen/Links enthält.

Name	Typ	Beschreibung
bingId	string	Eindeutige ID der Bing-Entitätssuche-API für die erkannte Entität.
dataSource	string	Datenquelle, die zum Extrahieren von Entitätsverknüpfungen verwendet wird, z. B. Wiki/Bing usw.
id	string	Eindeutiger Bezeichner der erkannten Entität aus der Datenquelle.
language	string	In der Datenquelle verwendete Sprache.
matches	Match[]	Liste der Instanzen, die diese Entität im Text angezeigt wird.
name	string	Formaler Entitätsverknüpfungsname.
url	string	URL für die Seite der Entität aus der Datenquelle.

Match

Objekt

Das Match -Objekt, das den erkannten Entitätstext mit dem Offset und der Länge enthält.

Name	Typ	Beschreibung
confidenceScore	number (double)	Wenn ein bekanntes Element erkannt wird, wird eine Dezimalzahl zurückgegeben, die die Konfidenzstufe zwischen 0 und 1 angibt.
length	integer (int32)	Länge für den Entitäts-Übereinstimmungstext.
offset	integer (int32)	Startposition für den Entitäts-Übereinstimmungstext.
text	string	Entitätstext wie in der Anforderung angezeigt.

MatchLongestEntityPolicyType

Objekt

Stellt die Längste Überlappungsrichtlinie "Übereinstimmung" dar. Es gibt keine überlappenden Entitäten, soweit dies möglich ist. 1. Wenn sich überlappende Entitäten befinden, wird die längste Entität zurückgegeben. 2. Wenn die anzahl der für 2 oder mehr Entitäten vorhergesagten Zeichen identisch sind, wählen Sie die Entität aus, die den höheren Konfidenzwert aufweist.3. Wenn die Entitätsbewertungen identisch sind, geben Sie alle Entitäten zurück, die nach dem Anwenden der vorherigen Regeln noch vorhanden sind. 3. Wenn es teilweise Überlappungen (wie in Hello Text Analytics) gibt, führen Sie die oben genannten Schritte ab 1 aus.

Name	Typ	Standardwert	Beschreibung
policyKind	string: matchLongest	matchLongest	Die Entität OverlapPolicy-Objektart.

MetadataKind

Enumeration

Der Entitätsmetadatenobjekttyp.

Wert	Beschreibung
AgeMetadata	Metadaten für altersbezogene Werte.
AreaMetadata	Metadaten für bereichsbezogene Werte.
CurrencyMetadata	Metadaten für währungsbezogene Werte.
DateMetadata	Metadaten für datumsbezogene Werte.
DateTimeMetadata	Metadaten für Datums- und Uhrzeitwerte.
InformationMetadata	Metadaten für informationsbezogene Werte.
LengthMetadata	Metadaten für längenbezogene Werte.
NumberMetadata	Metadaten für numerische Werte.
NumericRangeMetadata	Metadaten für numerische Bereichswerte.
OrdinalMetadata	Metadaten für Ordnungszahlen.
SpeedMetadata	Metadaten für geschwindigkeitsbezogene Werte.
TemperatureMetadata	Metadaten für temperaturbezogene Werte.
TemporalSetMetadata	Metadaten für einen Satz zeitbezogener Werte.
TemporalSpanMetadata	Metadaten für zeitliche Spannwerte.
TimeMetadata	Metadaten für zeitbezogene Werte.
VolumeMetadata	Metadaten für volumenbezogene Werte.
WeightMetadata	Metadaten für gewichtsbezogene Werte.

MultiLanguageAnalysisInput

Objekt

Sammlung von Eingabedokumenten, die vom Dienst analysiert werden sollen.

Name	Typ	Beschreibung
documents	MultiLanguageInput[]	Die zu analysierenden Eingabedokumente.

MultiLanguageInput

Objekt

Enthält ein Eingabedokument, das vom Dienst analysiert werden soll.

Name	Typ	Beschreibung
id	string	Ein eindeutiger, nicht leerer Dokumentbezeichner.
language	string	(Optional) Dies ist die 2 Buchstaben ISO 639-1 Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard. (Es gilt nur für 2023-04-15-preview und höher) Verwenden Sie für die automatische Spracherkennung "auto". Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard.
text	string	Der zu verarbeitende Eingabetext.

NumberKind

Enumeration

Der Typ der extrahierten Nummernentität.

Wert	Beschreibung
Decimal	Dezimalzahl
Fraction	Bruchzahl
Integer	Ganze Zahl
Percent	Prozentzahl
Power	Energienummer
Unspecified	Nicht angegebene Zahlenart

NumberMetadata

Objekt

Metadaten für numerische Entitätsinstanzen.

Name	Typ	Beschreibung
metadataKind	string: NumberMetadata	Der Entitätsmetadatenobjekttyp.
numberKind	NumberKind	Art des Zahlentyps.
value	number (double)	Eine numerische Darstellung des extrahierten Texts.

NumericRangeMetadata

Objekt

stellt die Metadaten numerischer Intervalle dar.

Name	Typ	Beschreibung
maximum	number (double)	Der Endwert des Intervalls.
metadataKind	string: NumericRangeMetadata	Der Entitätsmetadatenobjekttyp.
minimum	number (double)	Der Anfangswert des Intervalls.
rangeInclusivity	RangeInclusivity	Die Inklusivität dieses Bereichs.
rangeKind	RangeKind	Art der unterstützten numerischen Bereiche – z. B. Zahl, Geschwindigkeit usw.

OrdinalMetadata

Objekt

Metadaten für numerische Entitätsinstanzen.

Name	Typ	Beschreibung
metadataKind	string: OrdinalMetadata	Der Entitätsmetadatenobjekttyp.
offset	string	Der Offset im Hinblick auf den Bezug (z. B. Offset = -1 gibt den zweiten bis letzten an)
relativeTo	RelativeTo	Der Bezugspunkt, den die Ordnungszahl angibt.
value	string	Ein einfacher arithmetischer Ausdruck, der vom Ordinal bezeichnet wird.

PiiCategory

Enumeration

(Optional) beschreibt die zurückzugebenden PII-Kategorien

Wert	Beschreibung
ABARoutingNumber	ABA-Routingnummer
ARNationalIdentityNumber	AR National Identity Number
ATIdentityCard	AT Identity Card
ATTaxIdentificationNumber	AT Tax Identification Number
ATValueAddedTaxNumber	AT Value Added Tax Number
AUBankAccountNumber	AT Identity Card
AUBusinessNumber	AU Business Number
AUCompanyNumber	AU-Firmennummer
AUDriversLicenseNumber	AU Driver's License Number
AUMedicalAccountNumber	AU Medical Account Number
AUPassportNumber	AU Passport Number
AUTaxFileNumber	AU Tax File Number
Address	Adresse
Age	Alter
All	Alle PII-Kategorien.
AzureDocumentDBAuthKey	Azure Document DB Auth Key
AzureIAASDatabaseConnectionAndSQLString	Azure IAAS-Datenbankverbindung und SQL-Zeichenfolge
AzureIoTConnectionString	Azure IoT-Verbindungszeichenfolge
AzurePublishSettingPassword	Kennwort für die Azure-Veröffentlichungseinstellung
AzureRedisCacheString	Azure Redis-Cachezeichenfolge
AzureSAS	Azure SAS
AzureServiceBusString	Azure Service Bus String
AzureStorageAccountGeneric	Azure Storage-Konto generisch
AzureStorageAccountKey	Azure Storage Account Key
BENationalNumber	BE National Number
BENationalNumberV2	BE National Number V2
BEValueAddedTaxNumber	BE Umsatzsteuernummer
BGUniformCivilNumber	BG Uniform Civil Number
BRCPFNumber	BR-CPF-Nummer
BRLegalEntityNumber	BR Legal Entity Number
BRNationalIDRG	BR National ID RG
CABankAccountNumber	CA Bank Account Number
CADriversLicenseNumber	CA Driver's License Number
CAHealthServiceNumber	CA Health Service Number
CAPassportNumber	CA Passport Number
CAPersonalHealthIdentification	Identifizierung der persönlichen Integrität der Zertifizierungsstelle
CASocialInsuranceNumber	CA Sozialversicherungsnummer
CHSocialSecurityNumber	CH Sozialversicherungsnummer
CLIdentityCardNumber	CL Identity Card Number
CNResidentIdentityCardNumber	CN Resident Identity Card Number
CYIdentityCard	CY-Identitätskarte
CYTaxIdentificationNumber	CY Steueridentifikationsnummer
CZPersonalIdentityNumber	CZ Persönliche Identitätsnummer
CZPersonalIdentityV2	CZ Persönliche Identität V2
CreditCardNumber	Kreditkartennummer
DEDriversLicenseNumber	DE Driver's License Number
DEIdentityCardNumber	DE Identity Card Number
DEPassportNumber	DE Passport Number
DETaxIdentificationNumber	DE Steueridentifikationsnummer
DEValueAddedNumber	DE Value Added Number
DKPersonalIdentificationNumber	DK Persönliche Identifikationsnummer
DKPersonalIdentificationV2	DK Persönliche Identifikation V2
Date	Datum
Default	Standard-PII-Kategorien für die Sprache.
DrugEnforcementAgencyNumber	Nummer der Drogenerzwingungsbehörde
EEPersonalIdentificationCode	EE Personal Identification Code
ESDNI	ES DNI
ESSocialSecurityNumber	ES Sozialversicherungsnummer
ESTaxIdentificationNumber	ES Steueridentifikationsnummer
EUDebitCardNumber	EU-Debitkartennummer
EUDriversLicenseNumber	EU-Führerscheinnummer
EUGPSCoordinates	GPS-Koordinaten der EU
EUNationalIdentificationNumber	Nationale Identifikationsnummer der EU
EUPassportNumber	EU-Reisepassnummer
EUSocialSecurityNumber	Sozialversicherungsnummer der EU
EUTaxIdentificationNumber	EU-Steueridentifikationsnummer
Email	E-Mail
FIEuropeanHealthNumber	FI Europäische Gesundheitsnummer
FINationalID	FI National ID
FINationalIDV2	FI National ID V2
FIPassportNumber	FI Passport Number
FRDriversLicenseNumber	FR-Führerscheinnummer
FRHealthInsuranceNumber	FR Krankenversicherungsnummer
FRNationalID	FR National ID
FRPassportNumber	FR Reisepassnummer
FRSocialSecurityNumber	FR Sozialversicherungsnummer
FRTaxIdentificationNumber	FR Steueridentifikationsnummer
FRValueAddedTaxNumber	FR Umsatzsteuernummer
GRNationalIDCard	GR National ID Card
GRNationalIDV2	GR National ID V2
GRTaxIdentificationNumber	GR Steueridentifikationsnummer
HKIdentityCardNumber	HK Identity Card Number
HRIdentityCardNumber	HR Identity Card Number
HRNationalIDNumber	HR National ID Number
HRPersonalIdentificationNumber	HR Personal Identification Number
HRPersonalIdentificationOIBNumberV2	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	HU Personal Identification Number
HUTaxIdentificationNumber	HU Steueridentifikationsnummer
HUValueAddedNumber	HU Value Added Number
IDIdentityCardNumber	ID Identity Card Number
IEPersonalPublicServiceNumber	IE Personal Public Service Number
IEPersonalPublicServiceNumberV2	IE Personal Public Service Number V2
ILBankAccountNumber	IL-Bankkontonummer
ILNationalID	IL National ID
INPermanentAccount	IN permanentes Konto
INUniqueIdentificationNumber	IN Unique Identification Number
IPAddress	IP-Adresse
ITDriversLicenseNumber	Lizenznummer des IT-Treibers
ITFiscalCode	IT-Geschäftscode
ITValueAddedTaxNumber	IT-Umsatzsteuernummer
InternationalBankingAccountNumber	International Banking Account Number
JPBankAccountNumber	JP Bankkontonummer
JPDriversLicenseNumber	JP Driver's License Number
JPMyNumberCorporate	JP My Number Corporate
JPMyNumberPersonal	JP My Number Personal
JPPassportNumber	JP Passport Number
JPResidenceCardNumber	JP Residence Card Number
JPResidentRegistrationNumber	JP Resident Registration Number
JPSocialInsuranceNumber	JP Sozialversicherungsnummer
KRResidentRegistrationNumber	KR Resident Registration Number
LTPersonalCode	LT Persönlicher Code
LUNationalIdentificationNumberNatural	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	LU National Identification Number Non Natural
LVPersonalCode	LV Personal Code
MTIdentityCardNumber	MT Identity Card Number
MTTaxIDNumber	MT Steuernummer
MYIdentityCardNumber	MY Identity Card Number
NLCitizensServiceNumber	NL Citizens Service Number
NLCitizensServiceNumberV2	NL Citizens Service Number V2
NLTaxIdentificationNumber	NL Steueridentifikationsnummer
NLValueAddedTaxNumber	NL-Umsatzsteuernummer
NOIdentityNumber	NO Identity Number
NZBankAccountNumber	NZ-Bankkontonummer
NZDriversLicenseNumber	NZ Driver's License Number
NZInlandRevenueNumber	NZ Inland Umsatznummer
NZMinistryOfHealthNumber	NZ Ministerium für Gesundheit Nummer
NZSocialWelfareNumber	NZ Sozialhilfenummer
Organization	Organisation
PHUnifiedMultiPurposeIDNumber	PH Unified Multi Purpose ID Number
PLIdentityCard	PL-Identitätskarte
PLNationalID	PL National ID
PLNationalIDV2	PL National ID V2
PLPassportNumber	PL Passport Number
PLREGONNumber	PL REGON Number
PLTaxIdentificationNumber	PL Steueridentifikationsnummer
PTCitizenCardNumber	PT Citizen Card Number
PTCitizenCardNumberV2	PT Citizen Card Number V2
PTTaxIdentificationNumber	PT Steueridentifikationsnummer
Person	Person
PhoneNumber	Telefonnummer
ROPersonalNumericalCode	RO Personal Numerischer Code
RUPassportNumberDomestic	RU Passport Number Domestic
RUPassportNumberInternational	RU Passport Number International
SANationalID	SA National ID
SENationalID	SE National ID
SENationalIDV2	SE National ID V2
SEPassportNumber	SE Passport Number
SETaxIdentificationNumber	SE Steueridentifikationsnummer
SGNationalRegistrationIdentityCardNumber	SG National Registration Identity Card Number
SITaxIdentificationNumber	SI Steueridentifikationsnummer
SIUniqueMasterCitizenNumber	SI Unique Master Citizen Number
SKPersonalNumber	PERSÖNLICHE SK-Nummer
SQLServerConnectionString	SQL Server-Verbindungszeichenfolge
SWIFTCode	SWIFT-Code
THPopulationIdentificationCode	TH Population Identification Code
TRNationalIdentificationNumber	TR National Identification Number
TWNationalID	TW National ID
TWPassportNumber	TW Passport Number
TWResidentCertificate	TW Resident Certificate
UAPassportNumberDomestic	UA Passport Number Domestic
UAPassportNumberInternational	UA Passport Number International
UKDriversLicenseNumber	UK Driver's License Number
UKElectoralRollNumber	Britische Wahlnummer
UKNationalHealthNumber	UK National Health Number
UKNationalInsuranceNumber	UK National Insurance Number
UKUniqueTaxpayerNumber	UK Unique Taxpayer Number
URL	URL
USBankAccountNumber	US-Bankkontonummer
USDriversLicenseNumber	US-Führerscheinnummer
USIndividualTaxpayerIdentification	US Individual Taxpayer Identification
USSocialSecurityNumber	US-Sozialversicherungsnummer
USUKPassportNumber	US UK Passport Number
ZAIdentificationNumber	ZA Identification Number

PiiDomain

Enumeration

Domäne für PII-Aufgabe

Wert	Beschreibung
none	Gibt an, dass keine Domäne angegeben ist.
phi	Gibt an, dass Entitäten in der Domäne "Persönliche Integritätsinformationen" redigiert werden sollen.

PiiEntitiesDocumentResult

Objekt

Enthält die PII-Ergebnisse.

Name	Typ	Beschreibung
entities	Entity[]	Erkannte Entitäten im Dokument.
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
redactedText	string	Gibt redacted text zurück.
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

PiiResult

Objekt

Enthält das PiiResult.

Name	Typ	Beschreibung
documents	PiiEntitiesDocumentResult[]	Antwort nach Dokument
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

PiiTaskParameters

Objekt

Unterstützte Parameter für eine PII-Entitätenerkennungsaufgabe.

Name	Typ	Standardwert	Beschreibung
domain	PiiDomain	none	Domäne für PII-Aufgabe
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
piiCategories	PiiCategory[]		Aufzählung der PII-Kategorien, die in der Antwort zurückgegeben werden sollen.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType, der für die Analyse verwendet werden soll.

PiiTaskResult

Objekt

Enthält den Analysetext PIIEntityRecognition LRO-Vorgang.

Name	Typ	Beschreibung
kind	string: PiiEntityRecognitionResults	Die Art des Vorgangsergebnisses.
results	PiiResult	Die Liste der pii-Ergebnisse

RangeInclusivity

Enumeration

Der Bereich einschließlich dieser Eigenschaft.

Wert	Beschreibung
LeftInclusive	Linke Seite inklusive
LeftRightInclusive	Beide Seiten inklusive
NoneInclusive	Keine Inklusivität
RightInclusive	Rechte Seite inklusive

RangeKind

Enumeration

Die Art der Nummerbereichsentität.

Wert	Beschreibung
Age	Altersbereich
Area	Bereich
Currency	Währungsbereich
Information	Informationsbereich
Length	Längenbereich
Number	Zahlenbereich
Speed	Geschwindigkeitsbereich
Temperature	Temperaturbereich
Volume	Volumenbereich
Weight	Gewichtsbereich

RelativeTo

Enumeration

Der Bezugspunkt, den die Ordnungszahl angibt.

Wert	Beschreibung
Current	Aktueller Zustand oder aktuelle Position
End	Endzustand oder Position
Start	Startzustand oder Position

RequestStatistics

Objekt

wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

Name	Typ	Beschreibung
documentsCount	integer (int32)	Die Anzahl der in der Anforderung übermittelten Dokumente.
erroneousDocumentsCount	integer (int32)	Anzahl ungültiger Dokumente. Dies umfasst leere Dokumente, Übergrößenbeschränkungen oder nicht unterstützte Sprachendokumente.
transactionsCount	integer (int64)	Anzahl der Transaktionen für die Anforderung.
validDocumentsCount	integer (int32)	Anzahl gültiger Dokumente. Dadurch werden leere Dokumente, Übergrößenbeschränkungen oder nicht unterstützte Sprachendokumente ausgeschlossen.

ScriptCode

Enumeration

Identifiziert das Skript des Eingabedokuments. Ordnet den ISO 15924-Standardskriptcode zu.

Wert	Beschreibung
Arab	Skriptcode für das arabische Skript.
Armn	Skriptcode für das armenische Skript.
Beng	Skriptcode für das Bangla-Skript.
Cans	Skriptcode für das UnifiedCanadianAboriginalSyllabics-Skript.
Cyrl	Skriptcode für das kyrillische Skript.
Deva	Skriptcode für das Devanagari-Skript.
Ethi	Skriptcode für das ethiopische Skript.
Geor	Skriptcode für das georgische Skript.
Grek	Skriptcode für das griechische Skript.
Gujr	Skriptcode für das Gujarati-Skript.
Guru	Skriptcode für das Gurmukhi-Skript.
Hang	Skriptcode für das Hangul-Skript.
Hani	Skriptcode für das HanLiteral-Skript.
Hans	Skriptcode für das vereinfachte Han-Skript.
Hant	Skriptcode für das HanTraditional-Skript.
Hebr	Skriptcode für das hebräische Skript.
Jpan	Skriptcode für das japanische Skript.
Khmr	Skriptcode für das Khmer-Skript.
Knda	Skriptcode für das Kannada-Skript.
Laoo	Skriptcode für das Lao-Skript.
Latn	Skriptcode für das lateinische Skript.
Mlym	Skriptcode für das Malayalam-Skript.
Mong	Skriptcode für das mongolische Skript.
Mtei	Skriptcode für das Meitei-Skript.
Mymr	Skriptcode für das Myanmar-Skript.
Olck	Skriptcode für das Santali-Skript.
Orya	Skriptcode für das Odia-Skript.
Shrd	Skriptcode für das Sharada-Skript.
Sinh	Skriptcode für das Sinhala-Skript.
Taml	Skriptcode für das tamilische Skript.
Telu	Skriptcode für das Telugu-Skript.
Thaa	Skriptcode für das Thaana-Skript.
Thai	Skriptcode für das thailändische Skript.
Tibt	Skriptcode für das tibetische Skript.

ScriptKind

Enumeration

Identifiziert das Skript des Eingabedokuments. Ordnet den formalen Iso 15924-Standardnamen zu.

Wert	Beschreibung
Arabic	Skriptname für das arabische Skript.
Armenian	Skriptname für das armenische Skript.
Bangla	Skriptname für das Bangla-Skript.
Cyrillic	Skriptname für das kyrillische Skript.
Devanagari	Skriptname für das Devanagari-Skript.
Ethiopic	Skriptname für das ethiopische Skript.
Georgian	Skriptname für das georgische Skript.
Greek	Skriptname für das griechische Skript.
Gujarati	Skriptname für das Gujarati-Skript.
Gurmukhi	Skriptname für das Gurmukhi-Skript.
HanLiteral	Skriptname für das HanLiteral-Skript.
HanSimplified	Skriptname für das hansimplified script.
HanTraditional	Skriptname für das HanTraditional-Skript.
Hangul	Skriptname für das Hangul-Skript.
Hebrew	Skriptname für das hebräische Skript.
Japanese	Skriptname für das japanische Skript.
Kannada	Skriptname für das Kannada-Skript.
Khmer	Skriptname für das Khmer-Skript.
Lao	Skriptname für das Lao-Skript.
Latin	Skriptname für das lateinische Skript.
Malayalam	Skriptname für das Malayalam-Skript.
Meitei	Skriptname für das Meitei-Skript.
Mongolian	Skriptname für das mongolische Skript.
Myanmar	Skriptname für das Myanmar-Skript.
Odia	Skriptname für das Odia-Skript.
Santali	Skriptname für das Skript Santali.
Sharada	Skriptname für das Sharada-Skript.
Sinhala	Skriptname für das Sinhala-Skript.
Tamil	Skriptname für das tamilische Skript.
Telugu	Skriptname für das Telugu-Skript.
Thaana	Skriptname für das Thaana-Skript.
Thai	Skriptname für das thailändische Skript.
Tibetan	Skriptname für das tibetische Skript.
UnifiedCanadianAboriginalSyllabics	Skriptname für das UnifiedCanadianAboriginalSyllabics-Skript.

SentenceAssessment

Objekt

Stellt eine Satzbewertung und die Bewertungen oder Zielobjekte dar, die damit verbunden sind.

Name	Typ	Beschreibung
confidenceScores	TargetConfidenceScoreLabel	Stellt die Konfidenzbewertungen in allen Stimmungsklassen dar: positiv und negativ.
isNegated	boolean	Der Indikator, der angibt, ob die Bewertung negiert wird.
length	integer (int32)	Die Länge des Ziels.
offset	integer (int32)	Der Zieloffset vom Anfang des Satzes.
sentiment	TokenSentimentValue	Das Gefühl des Satzes.
text	string	Der Zieltext wurde erkannt.

SentenceSentiment

Objekt

Das Satzgefühl eines Dokuments.

Name	Typ	Beschreibung
assessments	SentenceAssessment[]	Das Array der Bewertungen für den Satz.
confidenceScores	SentimentConfidenceScores	Die Stimmungsvertrauensbewertung zwischen 0 und 1 für den Satz für alle Klassen.
length	integer (int32)	Die Länge des Ziels.
offset	integer (int32)	Der Zieloffset vom Anfang des Satzes.
sentiment	SentenceSentimentValue	Die vorhergesagte Stimmung für den Satz.
targets	SentenceTarget[]	Das Array von Satzzielen für den Satz.
text	string	Der Satztext.

SentenceSentimentValue

Enumeration

Die vorhergesagte Stimmung für den Satz.

Wert	Beschreibung
negative	Negative Stimmung
neutral	Neutrale Stimmung
positive	Positive Stimmung

SentenceTarget

Objekt

Stellt ein Satzziel und die Bewertungen oder Zielobjekte dar, die damit verbunden sind.

Name	Typ	Beschreibung
confidenceScores	TargetConfidenceScoreLabel	Stellt die Konfidenzbewertungen in allen Stimmungsklassen dar: positiv und negativ.
length	integer (int32)	Die Länge des Ziels.
offset	integer (int32)	Der Zieloffset vom Anfang des Satzes.
relations	TargetRelation[]	Das Array von Bewertungs- oder Zielobjekten, die mit dem Ziel verknüpft sind.
sentiment	TokenSentimentValue	Das Gefühl des Satzes.
text	string	Der Zieltext wurde erkannt.

SentimentAnalysisTaskParameters

Objekt

Unterstützte Parameter für eine Einstellungsanalyseaufgabe.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
opinionMining	boolean	False	Ob man das Meinungsmining in der Anforderung verwendet oder nicht.
stringIndexType	StringIndexType	TextElements_v8	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird.

SentimentConfidenceScores

Objekt

Stellt die Konfidenzergebnisse zwischen 0 und 1 in allen Stimmungsklassen dar: positiv, neutral, negativ.

Name	Typ	Beschreibung
negative	number (double)	Konfidenzbewertung für negative Stimmung
neutral	number (double)	Konfidenzbewertung für neutrale Stimmung
positive	number (double)	Konfidenzbewertung für positive Stimmung

SentimentDocumentResult

Objekt

Ein Objekt, das die vordefinierten Ergebnisse der Stimmungsanalyse jedes Dokuments darstellt.

Name	Typ	Beschreibung
confidenceScores	SentimentConfidenceScores	Die Stimmungsvertrauensbewertung zwischen 0 und 1 für den Satz für alle Klassen.
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
sentences	SentenceSentiment[]	Die Sätze des Dokuments.
sentiment	DocumentSentimentValue	Prognostizierte Stimmung für Das Dokument (Negativ, Neutral, Positiv oder Gemischt).
statistics	DocumentStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Dokumentnutzlast.
warnings	DocumentWarning[]	Warnungen beim Verarbeiten des Dokuments.

SentimentResponse

Objekt

Ergebnisse der Stimmungsanalyse für die Eingabedokumente.

Name	Typ	Beschreibung
documents	SentimentDocumentResult[]	Die Ergebnisse der Stimmungsanalyse für jedes Dokument in der Eingabe.
errors	DocumentError[]	Fehler nach Dokument-ID.
modelVersion	string	Dieses Feld gibt an, welches Modell für die Bewertung verwendet wird.
statistics	RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.

SentimentTaskResult

Objekt

Enthält den Analysetext SentimentAnalysis LRO-Vorgangsergebnis.

Name	Typ	Beschreibung
kind	string: SentimentAnalysisResults	Die Art des Vorgangsergebnisses.
results	SentimentResponse	Die Ergebnisse der Stimmungsanalyse

SpeedMetadata

Objekt

Stellt das Metadatenmodell der Speed-Entität dar.

Name	Typ	Beschreibung
metadataKind	string: SpeedMetadata	Der Entitätsmetadatenobjekttyp.
unit	SpeedUnit	Maßeinheit für Geschwindigkeit.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

SpeedUnit

Enumeration

Die Geschwindigkeitseinheit der Messung

Wert	Beschreibung
CentimetersPerMillisecond	Geschwindigkeitseinheit in Zentimetern pro Millisekunden.
FeetPerMinute	Geschwindigkeitseinheit in Fuß pro Minute.
FeetPerSecond	Geschwindigkeitseinheit in Fuß pro Sekunde.
KilometersPerHour	Geschwindigkeitseinheit in Kilometern pro Stunde.
KilometersPerMillisecond	Geschwindigkeitseinheit in Kilometern pro Millisekunden.
KilometersPerMinute	Geschwindigkeitseinheit in Kilometern pro Minute.
KilometersPerSecond	Geschwindigkeitseinheit in Kilometern pro Sekunde.
Knots	Geschwindigkeitseinheit in Knoten.
MetersPerMillisecond	Geschwindigkeitseinheit in Metern pro Millisekunden.
MetersPerSecond	Geschwindigkeitseinheit in Metern pro Sekunde.
MilesPerHour	Geschwindigkeitseinheit in Meilen pro Stunde.
Unspecified	Nicht angegebene Geschwindigkeitseinheit.
YardsPerMinute	Geschwindigkeitseinheit in Yards pro Minute.
YardsPerSecond	Geschwindigkeitseinheit in Yards pro Sekunde.

StringIndexType

Enumeration

Zeichenfolgenindextyp

Wert	Beschreibung
TextElements_v8	Zurückgegebene Offset- und Längenwerte entsprechen textElements (Graphemes und Grapheme-Clustern), die dem Unicode 8.0.0-Standard bestätigen. Verwenden Sie diese Option, wenn Ihre Anwendung in .Net Framework oder .Net Core geschrieben ist und Sie StringInfo verwenden.
UnicodeCodePoint	Zurückgegebene Offset- und Längenwerte entsprechen Unicode-Codepunkten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. Python.
Utf16CodeUnit	Zurückgegebene Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. JavaScript.

TargetConfidenceScoreLabel

Objekt

Stellt die Konfidenzbewertungen in allen Stimmungsklassen dar: positiv und negativ.

Name	Typ	Beschreibung
negative	number (double)	Konfidenzbewertung für negative Stimmung
positive	number (double)	Konfidenzbewertung für positive Stimmung

TargetRelation

Objekt

Stellt die Beziehung zwischen Bewertungen und/oder Zielen dar.

Name	Typ	Beschreibung
ref	string	Der JSON-Zeiger, der das verknüpfte Objekt angibt.
relationType	TargetRelationType	Der Typ, der mit dem Ziel verknüpft ist.

TargetRelationType

Enumeration

Der Typ, der mit dem Ziel verknüpft ist.

Wert	Beschreibung
assessment	Bewertungsbeziehung.
target	Zielbeziehung.

TemperatureMetadata

Objekt

Represents the Information entity Metadata model.

Name	Typ	Beschreibung
metadataKind	string: TemperatureMetadata	Der Entitätsmetadatenobjekttyp.
unit	TemperatureUnit	Maßeinheit für Temperatur.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

TemperatureUnit

Enumeration

Die Temperatureinheit der Messung.

Wert	Beschreibung
Celsius	Temperatureinheit in Celsius
Fahrenheit	Temperatureinheit in Fahrenheit
Kelvin	Temperatureinheit in Kelvin
Rankine	Temperatureinheit in Rankine
Unspecified	Nicht angegebene Temperatureinheit

TemporalModifier

Enumeration

Ein optionaler Modifizierer einer Datums-/Uhrzeitinstanz.

Wert	Beschreibung
After	Nach einer bestimmten Zeit
AfterApprox	Nach ungefährer Zeit
AfterMid	Nach der Mitte eines Zeitraums
AfterStart	Nach Beginn eines Zeitraums
Approx	Ungefähr zu einem bestimmten Zeitpunkt
Before	Vor einer bestimmten Zeit
BeforeApprox	Vor einer ungefähren Zeit
BeforeEnd	Vor Ablauf eines Zeitraums
BeforeStart	Vor Beginn eines Zeitraums
End	Am Ende eines Zeitraums
Less	Weniger als eine bestimmte Zeit
Mid	In der Mitte eines Zeitraums
More	Mehr als eine bestimmte Zeit
ReferenceUndefined	Verweis auf eine nicht definierte Zeit
Since	Seit einer bestimmten Zeit
SinceEnd	Seit Ende eines Zeitraums
Start	Zu Beginn eines Zeitraums
Until	Bis zu einer bestimmten Zeit

TemporalSetMetadata

Objekt

Metadaten für zeitlich festgelegte Entitätsinstanzen.

Name	Typ	Beschreibung
dateValues	DateValue[]	Liste der Datumswerte.
metadataKind	string: TemporalSetMetadata	Der Entitätsmetadatenobjekttyp.

TemporalSpanMetadata

Objekt

stellt die Metadaten einer Datums- und/oder Zeitspanne dar.

Name	Typ	Beschreibung
metadataKind	string: TemporalSpanMetadata	Der Entitätsmetadatenobjekttyp.
spanValues	TemporalSpanValues[]	Liste der erkannten zeitlichen Spannen.

TemporalSpanValues

Objekt

Temporal span object.

Name	Typ	Beschreibung
begin	string	Startwert für die Spanne.
duration	string	Ein optionaler Dauerwert, der basierend auf der ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) formatiert ist
end	string	Endwert für die Spanne.
modifier	TemporalModifier	Modifizierer für Datetime, um Bezugspunkt wie zuvor, nach usw. anzugeben.
timex	string	Ein optionales Triplet, das den Anfang, das Ende und die Dauer enthält, die alle als ISO 8601 formatierten Zeichenfolgen angegeben sind.

TimeMetadata

Objekt

Metadaten für Zeitentitätsinstanzen.

Name	Typ	Beschreibung
dateValues	DateValue[]	Liste der Datumswerte.
metadataKind	string: TimeMetadata	Der Entitätsmetadatenobjekttyp.

TokenSentimentValue

Enumeration

Die vorhergesagte Stimmung für den Satz.

Wert	Beschreibung
mixed	Gemischte Stimmung
negative	Negative Stimmung
positive	Positive Stimmung

VolumeMetadata

Objekt

Stellt das Volume-Entitätsmetadatenmodell dar.

Name	Typ	Beschreibung
metadataKind	string: VolumeMetadata	Der Entitätsmetadatenobjekttyp.
unit	VolumeUnit	Maßeinheit für Volumen.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

VolumeUnit

Enumeration

Die Maßeinheit

Wert	Beschreibung
Barrel	Volumeneinheit in Barrels.
Bushel	Volumeneinheit in Büffeln.
Centiliter	Volumeneinheit in Centilitern.
Cord	Lautstärkeeinheit in Kabeln.
CubicCentimeter	Volumeneinheit in kubischen Zentimetern.
CubicFoot	Volumeneinheit in Kubikfuß.
CubicInch	Volumeneinheit in Kubik zoll.
CubicMeter	Volumeneinheit in Kubikmetern.
CubicMile	Volumeneinheit in Kubikmeilen.
CubicMillimeter	Volumeneinheit in kubischen Millimetern.
CubicYard	Volumeneinheit in Kubikmetern.
Cup	Volumeneinheit in Tassen.
Decaliter	Volumeneinheit in Dezister.
FluidDram	Volumeneinheit in Flüssigkeits-Dramen.
FluidOunce	Volumeneinheit in Flüssigunzen.
Gill	Volumeneinheit in Kiemen.
Hectoliter	Volumeneinheit in Hektolitern.
Hogshead	Volumeneinheit in Hogsheads.
Liter	Volumeneinheit in Litern.
Milliliter	Volumeneinheit in Millilitern.
Minim	Lautstärkeeinheit in Minims.
Peck	Volumeneinheit in Pecks.
Pinch	Lautstärkeeinheit in Zusammendrücken.
Pint	Lautstärkeeinheit in Pints.
Quart	Volumeneinheit in Quarten.
Tablespoon	Volumeneinheit in Tabellenlöffeln.
Teaspoon	Volumeneinheit in Teelöffeln.
Unspecified	Nicht angegebene Volumeneinheit.

WarningCodeValue

Enumeration

Definiert die Liste der Warnungscodes.

Wert	Beschreibung
DocumentTruncated	Warnung "Dokument abgeschnitten"
LongWordsInDocument	Lange Wörter in Dokumentwarnung

WeightMetadata

Objekt

Represents the Weight ) entity Metadata model.

Name	Typ	Beschreibung
metadataKind	string: WeightMetadata	Der Entitätsmetadatenobjekttyp.
unit	WeightUnit	Maßeinheit für Gewicht.
value	number (double)	Der numerische Wert, den der extrahierte Text angibt.

WeightUnit

Enumeration

Die Gewichtseinheit der Maßeinheit.

Wert	Beschreibung
Dram	Gewichtseinheit in Dramen
Gallon	Volumeneinheit in Gallonen
Grain	Gewichtseinheit in Körnern
Gram	Gewichtseinheit in Gramm
Kilogram	Gewichtseinheit in Kilogramm
LongTonBritish	Gewichtseinheit in langen Tonnen (Britisch)
MetricTon	Gewichtseinheit in metrischen Tonnen
Milligram	Gewichtseinheit in Favoriten
Ounce	Gewichtseinheit in Unzen
PennyWeight	Gewichtseinheit in Centgewichten
Pound	Gewichtseinheit in Pfund
ShortHundredWeightUS	Gewichtseinheit in kurzen Hundertgewichten (USA)
ShortTonUS	Gewichtseinheit in Kurztonnen (USA)
Stone	Gewichtseinheit in Steinen
Ton	Gewichtseinheit in Tonnen
Unspecified	Nicht angegebene Gewichtseinheit