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

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	Der numerische Wert, den der extrahierte Text angibt.

AgeUnit

Die Alterseinheit der Messung

Name	Typ	Beschreibung
Day	string	Zeitraum eines Tages
Month	string	Zeitraum eines Monats
Unspecified	string	Nicht spezifizierter Zeitraum
Week	string	Zeitraum einer Woche
Year	string	Zeitraum eines Jahres

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.

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

AnalyzeTextEntityLinkingInput

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

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

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

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

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

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

Die Art der unterstützten Analysetextaufgaben.

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

AnalyzeTextTaskResultsKind

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

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

AreaMetadata

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	Der numerische Wert, den der extrahierte Text angibt.

AreaUnit

Die Maßeinheit.

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

CurrencyMetadata

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	Der numerische Wert, den der extrahierte Text angibt.

DateMetadata

Metadaten für Datumsentitätsinstanzen.

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

DateTimeMetadata

Metadaten für Datetime-Entitätsinstanzen.

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

DateValue

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

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

Name	Typ	Beschreibung
confidenceScore	number	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

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

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

Name	Typ	Beschreibung
mixed	string	Gemischte Anweisung
negative	string	Negative Anweisung
neutral	string	Neutrale Anweisung
positive	string	Positive Aussage

DocumentStatistics

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

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

DocumentWarning

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

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

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

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

Enthält die Entitätsaufgabe

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

Entity

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	Konfidenzbewertung zwischen 0 und 1 der extrahierten Entität.
length	integer	Länge für den Entitätstext. Die Verwendung verschiedener 'stringIndexType'-Werte kann sich auf die zurückgegebene Länge auswirken.
offset	integer	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

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

Name	Typ	Beschreibung
Address	string	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	string	Altersbezogene Werte.
Airport	string	Flughäfen.
Area	string	Bereich eines Objekts.
City	string	Ortsbezogene Werte.
ComputingProduct	string	Computerprodukte.
Continent	string	Kontinentbezogene Werte.
CountryRegion	string	Länder- oder regionsbezogene Werte.
CulturalEvent	string	Kulturereignisbezogene Werte.
Currency	string	Währungsbezogene Werte.
Date	string	Kalenderdaten.
DateRange	string	Datumsbereich.
DateTime	string	Kalenderdaten mit Uhrzeit.
DateTimeRange	string	Bereich von Datum und Uhrzeit.
Dimension	string	Dimension der Messungen
Duration	string	Dauer.
Email	string	E-Mail-Adressen.
Event	string	Soziale, Sport, Wirtschaft, Politik, Bildung, natürlich, historisch, kriminelle, gewalttätige, rechtliche, militärische Ereignisse mit einer bestimmten Zeit.
GPE	string	Städte, Länder/Regionen, Staaten.
Geological	string	Geografische und natürliche Merkmale wie Flüsse, Ozeane und Wüsten.
Height	string	Höhe eines Objekts.
IP	string	Netzwerk-IP-Adressen.
Information	string	Maßeinheit für digitale Informationen.
Length	string	Länge eines Objekts.
Location	string	Bestimmter Punkt oder Ort im physischen Raum.
NaturalEvent	string	Natürliche ereignisbezogene Werte.
Number	string	Zahlen ohne Einheit
NumberRange	string	Zahlenbereich
Numeric	string	Numerische Werte, einschließlich Ziffern und Zahlenwörter.
Ordinal	string	Ordnungszahlen.
Organization	string	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	string	Medizinische Unternehmen und Gruppen.
OrganizationSports	string	Sportbezogene Organisationen.
OrganizationStockExchange	string	Börsengruppen.
Percentage	string	Prozentbezogene Werte.
Person	string	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	string	Menschliche Rollen, die von einer Gruppenmitgliedschaft klassifiziert wurden.
PhoneNumber	string	Telefonnummern (nur US- und EU-Telefonnummern).
Product	string	Einzel- oder Gruppen von kommerziellen, Verbrauchsgegenständen, Elektronik, Fahrzeugen, Lebensmittelgruppen.
SetTemporal	string	Satz zeitbezogener Werte.
Skill	string	Eine Fähigkeit, Fähigkeit oder Kompetenz.
Speed	string	Geschwindigkeit eines Objekts.
SportsEvent	string	Sportereignisbezogene Werte.
State	string	Zustandsbezogene Werte.
Structural	string	Menschengemachte Strukturen.
Temperature	string	Temperaturbezogene Werte.
Temporal	string	Elemente, die sich auf die Zeit beziehen.
Time	string	Tageszeiten.
TimeRange	string	Zeitraum.
URL	string	URLs zu Websites.
Volume	string	Volume eines Objekts.
Weight	string	Gewichtung eines Objekts.

EntityInferenceOptions

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

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

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

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

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	Erkennungsbewertung zwischen 0 und 1 der extrahierten Entität.
name	string	Name des Tags. Entitätstagsnamen werden global eindeutig sein.

EntityWithMetadata

Entity-Objekt mit Tags und Metadaten.

Name	Typ	Beschreibung
category	string	Entitätstyp.
confidenceScore	number	Konfidenzbewertung zwischen 0 und 1 der extrahierten Entität.
length	integer	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	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

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

Lesbarer Fehlercode.

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

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InformationMetadata

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	Der numerische Wert, den der extrahierte Text angibt.

InformationUnit

Die Information (Daten) Maßeinheit.

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

InnerErrorCode

Lesbarer Fehlercode.

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

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.

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

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

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

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

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

KeyPhraseTaskResult

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

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

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

LanguageDetectionDocumentResult

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

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

Unterstützte Parameter für eine Spracherkennungsaufgabe.

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

LanguageDetectionTaskResult

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

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

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	Der numerische Wert, den der extrahierte Text angibt.

LengthUnit

Die Längeneinheit der Maßeinheit.

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

LinkedEntitiesDocumentResult

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

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

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

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

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.

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

MetadataKind

Der Entitätsmetadatenobjekttyp.

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

MultiLanguageAnalysisInput

Sammlung von Eingabedokumenten, die vom Dienst analysiert werden sollen.

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

MultiLanguageInput

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

Der Typ der extrahierten Nummernentität.

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

NumberMetadata

Metadaten für numerische Entitätsinstanzen.

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

NumericRangeMetadata

stellt die Metadaten numerischer Intervalle dar.

Name	Typ	Beschreibung
maximum	number	Der Endwert des Intervalls.
metadataKind	string: NumericRangeMetadata	Der Entitätsmetadatenobjekttyp.
minimum	number	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

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

(Optional) beschreibt die zurückzugebenden PII-Kategorien

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

PiiDomain

Domäne für PII-Aufgabe

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

PiiEntitiesDocumentResult

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

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

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

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

Der Bereich einschließlich dieser Eigenschaft.

Name	Typ	Beschreibung
LeftInclusive	string	Linke Seite inklusive
LeftRightInclusive	string	Beide Seiten inklusive
NoneInclusive	string	Keine Inklusivität
RightInclusive	string	Rechte Seite inklusive

RangeKind

Die Art der Nummerbereichsentität.

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

RelativeTo

Der Bezugspunkt, den die Ordnungszahl angibt.

Name	Typ	Beschreibung
Current	string	Aktueller Zustand oder aktuelle Position
End	string	Endzustand oder Position
Start	string	Startzustand oder Position

RequestStatistics

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

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

ScriptCode

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

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

ScriptKind

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

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

SentenceAssessment

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	Die Länge des Ziels.
offset	integer	Der Zieloffset vom Anfang des Satzes.
sentiment	TokenSentimentValue	Das Gefühl des Satzes.
text	string	Der Zieltext wurde erkannt.

SentenceSentiment

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	Die Länge des Ziels.
offset	integer	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

Die vorhergesagte Stimmung für den Satz.

Name	Typ	Beschreibung
negative	string	Negative Stimmung
neutral	string	Neutrale Stimmung
positive	string	Positive Stimmung

SentenceTarget

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	Die Länge des Ziels.
offset	integer	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

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

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

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

SentimentDocumentResult

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

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

Enthält den Analysetext SentimentAnalysis LRO-Vorgangsergebnis.

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

SpeedMetadata

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	Der numerische Wert, den der extrahierte Text angibt.

SpeedUnit

Die Geschwindigkeitseinheit der Messung

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

StringIndexType

Zeichenfolgenindextyp

Name	Typ	Beschreibung
TextElements_v8	string	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	string	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	string	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

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

Name	Typ	Beschreibung
negative	number	Konfidenzbewertung für negative Stimmung
positive	number	Konfidenzbewertung für positive Stimmung

TargetRelation

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

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

Name	Typ	Beschreibung
assessment	string	Bewertungsbeziehung.
target	string	Zielbeziehung.

TemperatureMetadata

Represents the Information entity Metadata model.

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

TemperatureUnit

Die Temperatureinheit der Messung.

Name	Typ	Beschreibung
Celsius	string	Temperatureinheit in Celsius
Fahrenheit	string	Temperatureinheit in Fahrenheit
Kelvin	string	Temperatureinheit in Kelvin
Rankine	string	Temperatureinheit in Rankine
Unspecified	string	Nicht angegebene Temperatureinheit

TemporalModifier

Ein optionaler Modifizierer einer Datums-/Uhrzeitinstanz.

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

TemporalSetMetadata

Metadaten für zeitlich festgelegte Entitätsinstanzen.

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

TemporalSpanMetadata

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

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

Metadaten für Zeitentitätsinstanzen.

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

TokenSentimentValue

Die vorhergesagte Stimmung für den Satz.

Name	Typ	Beschreibung
mixed	string	Gemischte Stimmung
negative	string	Negative Stimmung
positive	string	Positive Stimmung

VolumeMetadata

Stellt das Volume-Entitätsmetadatenmodell dar.

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

VolumeUnit

Die Maßeinheit

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

WarningCodeValue

Definiert die Liste der Warnungscodes.

Name	Typ	Beschreibung
DocumentTruncated	string	Warnung "Dokument abgeschnitten"
LongWordsInDocument	string	Lange Wörter in Dokumentwarnung

WeightMetadata

Represents the Weight ) entity Metadata model.

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

WeightUnit

Die Gewichtseinheit der Maßeinheit.

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