Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Fordern Sie eine Textanalyse für eine Sammlung von Dokumenten an.

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

With optional parameters:

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

URI-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	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
showStats	query		boolean	(Optional) Wenn auf true festgelegt ist, enthält die Antwort Statistiken auf Anforderungs- und Dokumentebene.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

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

Name	Beschreibung
AnalyzeTextEntityLinkingInput	Enthält den Analysetext Entitätsverknüpfungseingabe.
AnalyzeTextEntityRecognitionInput	Die Entitätserkennung analysiert die Anforderung des Texteingabetasks.
AnalyzeTextKeyPhraseExtractionInput	Enthält die KeyPhraseExtraction-Taskeingabe für den Analysetext.
AnalyzeTextLanguageDetectionInput	Enthält die Eingabe des Spracherkennungsdokumentanalysetasks.
AnalyzeTextPiiEntitiesRecognitionInput	Enthält den Analysetext PIIEntityRecognition-Taskeingabe.
AnalyzeTextSentimentAnalysisInput	Enthält die Eingabe des Analysetexts SentimentAnalysis-Task.

AnalyzeTextEntityLinkingInput

Enthält den Analysetext Entitätsverknüpfungseingabe.

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

AnalyzeTextEntityRecognitionInput

Die Entitätserkennung analysiert die Anforderung des Texteingabetasks.

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

AnalyzeTextKeyPhraseExtractionInput

Enthält die KeyPhraseExtraction-Taskeingabe für den Analysetext.

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

AnalyzeTextLanguageDetectionInput

Enthält die Eingabe des Spracherkennungsdokumentanalysetasks.

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

AnalyzeTextPiiEntitiesRecognitionInput

Enthält den Analysetext PIIEntityRecognition-Taskeingabe.

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

AnalyzeTextSentimentAnalysisInput

Enthält die Eingabe des Analysetexts SentimentAnalysis-Task.

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

Antworten

Name	Typ	Beschreibung
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	ErrorResponse	Eine unerwartete Fehlerantwort. Headers x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

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

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

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


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

Sample Response

Status code:

200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definitionen

Name	Beschreibung
AnalyzeTextEntityLinkingInput	Enthält den Analysetext Entitätsverknüpfungseingabe.
AnalyzeTextEntityRecognitionInput	Die Entitätserkennung analysiert die Anforderung des Texteingabetasks.
AnalyzeTextKeyPhraseExtractionInput	Enthält die KeyPhraseExtraction-Taskeingabe für den Analysetext.
AnalyzeTextLanguageDetectionInput	Enthält die Eingabe des Spracherkennungsdokumentanalysetasks.
AnalyzeTextPiiEntitiesRecognitionInput	Enthält die Eingabe des PiIEntityRecognition-Vorgangs zum Analysieren von Text.
AnalyzeTextSentimentAnalysisInput	Enthält die Eingabe des Analysetexts SentimentAnalysis-Task.
AnalyzeTextTaskKind	Die Art der unterstützten Analysetextaufgaben.
AnalyzeTextTaskResultsKind	Die Art des Antwortobjekts, das vom Task analyze-text zurückgegeben wird.
DetectedLanguage	Enthält die Details der erkannten Sprache für den Text.
DocumentError	Enthält Details zu Fehlern, die während einer Auftragsausführung auftreten.
DocumentSentimentValue	Vorhergesagte Stimmung für ein 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 Warnobjekt mit Warnungen für das verarbeitete Dokument.
EntitiesDocumentResult	Enthält das Ergebnis des Entitätserkennungstasks für das Dokument.
EntitiesResult	Enthält das Ergebnis des Entitätserkennungstasks.
EntitiesTaskParameters	Unterstützte Parameter für einen Entitätserkennungstask.
EntitiesTaskResult	Enthält die Entitätsaufgabe.
Entity	Definiert das erkannte Entitätsobjekt, das die Entitätskategorie und den erkannten Entitätstext usw. enthält.
EntityLinkingResult	Ergebnis der Entitätsverknüpfung.
EntityLinkingTaskParameters	Unterstützte Parameter für einen Entity Linking-Task.
EntityLinkingTaskResult	Enthält den Analysetext Entitätsverknüpfungstaskergebnis.
Error	Das Fehlerantwortobjekt wird zurückgegeben, wenn beim Dienst während der Verarbeitung der Anforderung Fehler auftreten.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen 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 keyPhraseResult.
KeyPhrasesDocumentResult	Enthält die Ergebnisse der Schlüsselbegriffsextraktion für ein Dokument.
KeyPhraseTaskParameters	Unterstützte Parameter für einen Schlüsselbegriffserkennungstask.
KeyPhraseTaskResult	Enthält das Ergebnis des KeyPhraseExtraction-Analysetasks.
LanguageDetectionAnalysisInput	Enthält die Spracherkennungsdokumentanalyseeingabe.
LanguageDetectionDocumentResult	Enthält die Spracherkennung für ein Dokument.
LanguageDetectionResult	Enthält das Spracherkennungsergebnis für die Anforderung.
LanguageDetectionTaskParameters	Unterstützte Parameter für einen Spracherkennungstask.
LanguageDetectionTaskResult	Enthält das Ergebnis des Spracherkennungstasks für die Anforderung.
LanguageInput	Enthält die Spracherkennungseingabe.
LinkedEntitiesDocumentResult	Ergebnis des Entitätsverknüpfungsdokuments.
LinkedEntity	Das LinkedEntity-Objekt, das die erkannte Entität mit den zugeordneten Quellen/Links enthält.
Match	Das Match-Objekt, das den erkannten Entitätstext mit dem Offset und der Länge enthält.
MultiLanguageAnalysisInput	Sammlung von Eingabedokumenten, die vom Dienst analysiert werden sollen.
MultiLanguageInput	Enthält ein Eingabedokument, das vom Dienst analysiert werden soll.
PiiCategory	(Optional) beschreibt die zurückzugebenden PII-Kategorien.
PiiDomain	Aufgabe Domäne für PII
PiiEntitiesDocumentResult	Enthält die PII-Ergebnisse.
PiiResult	Enthält piiResult.
PiiTaskParameters	Unterstützte Parameter für einen Task für die Erkennung personenbezogener Entitäten.
PiiTaskResult	Enthält den LRO-Task zum Analysieren von Text PIIEntityRecognition.
RequestStatistics	wenn showStats=true in der Anforderung angegeben wurde, enthält dieses Feld Informationen zur Anforderungsnutzlast.
SentenceAssessment	Stellt eine Satzbewertung und die damit verbundenen Bewertungen oder Zielobjekte dar.
SentenceSentiment	Die Satzstimmung eines Dokuments.
SentenceSentimentValue	Die vorhergesagte Stimmung für den Satz.
SentenceTarget	Stellt ein Satzziel und die damit verbundenen Bewertungen oder Zielobjekte dar.
SentimentAnalysisTaskParameters	Unterstützte Parameter für einen Standpunktanalysetask.
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	Stimmungsanalyseergebnisse für die Eingabedokumente.
SentimentTaskResult	Enthält das Analysetext-LRO-Vorgangsergebnis von SentimentAnalysis.
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 sich auf das Ziel bezieht.
TokenSentimentValue	Die vorhergesagte Stimmung für den Satz.
WarningCodeValue	Definiert die Liste der Warnungscodes.

AnalyzeTextEntityLinkingInput

Enthält den Analysetext Entitätsverknüpfungseingabe.

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

AnalyzeTextEntityRecognitionInput

Die Entitätserkennung analysiert die Anforderung des Texteingabetasks.

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

AnalyzeTextKeyPhraseExtractionInput

Enthält die KeyPhraseExtraction-Taskeingabe für den Analysetext.

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

AnalyzeTextLanguageDetectionInput

Enthält die Eingabe des Spracherkennungsdokumentanalysetasks.

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

AnalyzeTextPiiEntitiesRecognitionInput

Enthält die Eingabe des PiIEntityRecognition-Vorgangs zum Analysieren von Text.

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

AnalyzeTextSentimentAnalysisInput

Enthält die Eingabe des Analysetexts SentimentAnalysis-Task.

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

AnalyzeTextTaskKind

Die Art der unterstützten Analysetextaufgaben.

Name	Typ	Beschreibung
EntityLinking	string	Entitätsverknüpfungsaufgabe
EntityRecognition	string	Entitätserkennungsaufgabe
KeyPhraseExtraction	string	Schlüsselbegriffserkennungstask
LanguageDetection	string	Spracherkennungstask
PiiEntityRecognition	string	PiI-Entitätserkennungsaufgabe
SentimentAnalysis	string	Standpunktanalyseaufgabe

AnalyzeTextTaskResultsKind

Die Art des Antwortobjekts, das vom Task analyze-text zurückgegeben wird.

Name	Typ	Beschreibung
EntityLinkingResults	string	Entitätsverknüpfungsergebnisse
EntityRecognitionResults	string	Ergebnisse der Entitätserkennung
KeyPhraseExtractionResults	string	Ergebnisse der Schlüsselbegriffsextraktion
LanguageDetectionResults	string	Spracherkennungsergebnisse
PiiEntityRecognitionResults	string	Ergebnisse der Erkennung von PII-Entitäten
SentimentAnalysisResults	string	Ergebnisse der Stimmungsanalyse

DetectedLanguage

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

Name	Typ	Beschreibung
confidenceScore	number	Eine Zuverlässigkeitsbewertung zwischen 0 und 1. Werte nahe 1 stehen für 100 %-ige Sicherheit, dass die identifizierte Sprache stimmt.
iso6391Name	string	Eine Zwei-Buchstaben-Darstellung der erkannten Sprache nach dem ISO 639-1-Standard (z. B. en, fr).
name	string	Langer Name einer erkannten Sprache (z. B. Englisch, Französisch).

DocumentError

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

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

DocumentSentimentValue

Vorhergesagte Stimmung für ein Dokument (Negativ, Neutral, Positiv oder Gemischt).

Name	Typ	Beschreibung
mixed	string	Mixed-Anweisung
negative	string	Negative Anweisung
neutral	string	Neutral-Anweisung
positive	string	Positive Anweisung

DocumentStatistics

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

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

DocumentWarning

Enthält das Warnobjekt 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.

EntitiesDocumentResult

Enthält das Ergebnis des Entitätserkennungstasks für das Dokument.

Name	Typ	Beschreibung
entities	Entity[]	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, die beim Verarbeiten des Dokuments auftreten.

EntitiesResult

Enthält das Ergebnis des Entitätserkennungstasks.

Name	Typ	Beschreibung
documents	EntitiesDocumentResult[]	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 einen Entitätserkennungstask.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
stringIndexType	StringIndexType	TextElements_v8	Parameter (Optional) zum Bereitstellen des Zeichenfolgenindextyps, der zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Der Standardwert ist TextElements (Grapheme).

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 usw. enthält.

Name	Typ	Beschreibung
category	string	Der 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 wird.

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 einen Entity Linking-Task.

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 Zeichenfolgenoffsets verwendet wird. Der Standardwert ist TextElements (Grapheme).

EntityLinkingTaskResult

Enthält den Analysetext Entitätsverknüpfungstaskergebnis.

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

Error

Das Fehlerantwortobjekt wird zurückgegeben, wenn beim Dienst während der Verarbeitung der Anforderung Fehler auftreten.

Name	Typ	Beschreibung
code	ErrorCode	Einer von einem serverdefiniertem Satz 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

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchIndexLimitReached	string	fehler Azure Cognitive Search Indexlimit erreicht
AzureCognitiveSearchIndexNotFound	string	Fehler Azure Cognitive Search Index nicht gefunden
AzureCognitiveSearchNotFound	string	Fehler Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	string	Azure Cognitive Search Drosselungsfehler
Conflict	string	Konfliktfehler
Forbidden	string	Fehler beim unzulässigen Zugriff
InternalServerError	string	Interner Serverfehler
InvalidArgument	string	Fehler "Ungültiges Argument"
InvalidRequest	string	Fehler "Ungültige Anforderung"
NotFound	string	Fehler nicht gefunden
OperationNotFound	string	Fehler "Vorgang nicht gefunden"
ProjectNotFound	string	Fehler "Projekt nicht gefunden"
QuotaExceeded	string	Fehler aufgrund von Kontingentüberschreitung
ServiceUnavailable	string	Fehler "Dienst nicht verfügbar"
Timeout	string	Timeoutfehler
TooManyRequests	string	Fehler "Zu viele Anforderungen"
Unauthorized	string	Fehler beim nicht autorisierten Zugriff
Warning	string	Warnungsfehler

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchNotFound	string	Fehler Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	string	Azure Cognitive Search Drosselungsfehler
EmptyRequest	string	Fehler "Leere Anforderung"
ExtractionFailure	string	Fehler bei Extraktionsfehlern
InvalidCountryHint	string	Ungültiger Länderhinweisfehler
InvalidDocument	string	Ungültiger Dokumentfehler
InvalidDocumentBatch	string	Ungültiger Dokumentbatchfehler
InvalidParameterValue	string	Ungültiger Parameterwertfehler
InvalidRequest	string	Fehler "Ungültige Anforderung"
InvalidRequestBodyFormat	string	Fehler beim Format "Ungültiger Anforderungstext"
KnowledgeBaseNotFound	string	Fehler der Wissensdatenbank nicht gefunden
MissingInputDocuments	string	Fehler bei fehlenden Eingabedokumenten
ModelVersionIncorrect	string	Falsche Modellversionsfehler
UnsupportedLanguageCode	string	Nicht unterstützter Sprachcodefehler

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	Einer der vom Server definierten 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 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üsselbegriffsextraktion für ein Dokument.

Name	Typ	Beschreibung
id	string	Eindeutiger, nicht leerer Dokumentbezeichner.
keyPhrases	string[]	Eine Liste mit repräsentativen Wörtern oder Ausdrücken. Die Anzahl der zurückgegebenen Schlüsselbegriffe 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, die beim Verarbeiten des Dokuments auftreten.

KeyPhraseTaskParameters

Unterstützte Parameter für einen Schlüsselbegriffserkennungstask.

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

KeyPhraseTaskResult

Enthält das Ergebnis des KeyPhraseExtraction-Analysetasks.

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

LanguageDetectionAnalysisInput

Enthält die Spracherkennungsdokumentanalyseeingabe.

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, die beim Verarbeiten des Dokuments auftreten.

LanguageDetectionResult

Enthält das Spracherkennungsergebnis für die Anforderung.

Name	Typ	Beschreibung
documents	LanguageDetectionDocumentResult[]	Enumeration der Spracherkennungsergebnisse 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 einen Spracherkennungstask.

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

LanguageDetectionTaskResult

Enthält das Ergebnis des Spracherkennungstasks für die Anforderung.

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

LanguageInput

Enthält die Spracherkennungseingabe.

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

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, die beim Verarbeiten des Dokuments auftreten.

LinkedEntity

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

Name	Typ	Beschreibung
bingId	string	Bing Entity Search API eindeutiger Bezeichner der erkannten 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 Name der Entitätsverknüpfung.
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 das Konfidenzniveau 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 wird.

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. (Folgendes 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.

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-Steueridentifikationsnummer
ATValueAddedTaxNumber	string	AT-Umsatzsteuernummer
AUBankAccountNumber	string	AT Identity Card
AUBusinessNumber	string	AU-Geschäftsnummer
AUCompanyNumber	string	AU-Firmennummer
AUDriversLicenseNumber	string	AU-Führerscheinnummer
AUMedicalAccountNumber	string	AU Medical Account Number
AUPassportNumber	string	AU-Passnummer
AUTaxFileNumber	string	AU-Steuerdateinummer
Address	string	Adresse
Age	string	Age
All	string	Alle PII-Kategorien.
AzureDocumentDBAuthKey	string	Azure Document DB-Authentifizierungsschlüssel
AzureIAASDatabaseConnectionAndSQLString	string	Azure IAAS-Datenbankverbindung und SQL-Zeichenfolge
AzureIoTConnectionString	string	Azure IoT-Verbindungszeichenfolge
AzurePublishSettingPassword	string	Azure-Veröffentlichungseinstellung: Kennwort
AzureRedisCacheString	string	Azure Redis Cache-Zeichenfolge
AzureSAS	string	Azure SaaS
AzureServiceBusString	string	Azure Service Bus Zeichenfolge
AzureStorageAccountGeneric	string	Azure Storage-Konto Generisch
AzureStorageAccountKey	string	Azure Storage-Kontoschlüssel
BENationalNumber	string	Be Nationale Nummer
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE-Mehrwertsteuernummer
BGUniformCivilNumber	string	BG Uniform Civil Number
BRCPFNumber	string	BR CPF-Nummer
BRLegalEntityNumber	string	BR-Nummer der juristischen Person
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	CA-Bankkontonummer
CADriversLicenseNumber	string	Lizenznummer des Ca-Treibers
CAHealthServiceNumber	string	Nummer des CA-Integritätsdiensts
CAPassportNumber	string	Ca Passport-Nummer
CAPersonalHealthIdentification	string	Identifizierung der persönlichen Integrität von CA
CASocialInsuranceNumber	string	Ca Sozialversicherungsnummer
CHSocialSecurityNumber	string	CH Sozialversicherungsnummer
CLIdentityCardNumber	string	CL-Identitätskartennummer
CNResidentIdentityCardNumber	string	Nummer des CN-Personalausweises
CYIdentityCard	string	CY-Identitätskarte
CYTaxIdentificationNumber	string	CY-Steueridentifikationsnummer
CZPersonalIdentityNumber	string	CZ Persönliche Identitätsnummer
CZPersonalIdentityV2	string	CZ Personal Identity V2
CreditCardNumber	string	Credit Card Number (Kreditkartennummer)
DEDriversLicenseNumber	string	DE-Führerscheinnummer
DEIdentityCardNumber	string	DE-Identitätskartennummer
DEPassportNumber	string	DE Passnummer
DETaxIdentificationNumber	string	DE Steueridentifikationsnummer
DEValueAddedNumber	string	DE Value Added Number
DKPersonalIdentificationNumber	string	DK Persönliche Identifikationsnummer
DKPersonalIdentificationV2	string	DK Personal Identification V2
Date	string	Date
Default	string	Standard-PII-Kategorien für die Sprache.
DrugEnforcementAgencyNumber	string	Nummer der Drogendurchsetzungsbehörde
EEPersonalIdentificationCode	string	EE Persönlicher Identifikationscode
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	ES Sozialversicherungsnummer
ESTaxIdentificationNumber	string	ES-Steueridentifikationsnummer
EUDebitCardNumber	string	EU-Debitkartennummer
EUDriversLicenseNumber	string	EU-Führerscheinnummer
EUGPSCoordinates	string	EU-GPS-Koordinaten
EUNationalIdentificationNumber	string	EU-Personalausweisnummer
EUPassportNumber	string	EU-Reisepassnummer
EUSocialSecurityNumber	string	EU-Sozialversicherungsnummer
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-Nummer
FRDriversLicenseNumber	string	FR-Führerscheinnummer
FRHealthInsuranceNumber	string	FR Krankenversicherungsnummer
FRNationalID	string	FR National ID
FRPassportNumber	string	FR Passnummer
FRSocialSecurityNumber	string	FR Sozialversicherungsnummer
FRTaxIdentificationNumber	string	FR Steueridentifikationsnummer
FRValueAddedTaxNumber	string	FR-Mehrwertsteuernummer
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 Persönliche Identifikationsnummer
HRPersonalIdentificationOIBNumberV2	string	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	string	HU Persönliche Identifikationsnummer
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-Kontonummer
ILNationalID	string	IL National ID
INPermanentAccount	string	IN Permanent Account
INUniqueIdentificationNumber	string	EINDEUTIGE IDENTIFIKATIONSNUMMER
IPAddress	string	IP-Adresse
ITDriversLicenseNumber	string	Lizenznummer des IT-Treibers
ITFiscalCode	string	IT-Steuercode
ITValueAddedTaxNumber	string	IT-Mehrwertsteuernummer
InternationalBankingAccountNumber	string	IBAN (International Banking Account Number)
JPBankAccountNumber	string	JP-Kontonummer
JPDriversLicenseNumber	string	JP-Führerscheinnummer
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	JP Passport-Nummer
JPResidenceCardNumber	string	JP Residence Card Number
JPResidentRegistrationNumber	string	Registriernummer des JP-Gebietsansässigen
JPSocialInsuranceNumber	string	JP Sozialversicherungsnummer
KRResidentRegistrationNumber	string	KR-Einwohnerregistrierungsnummer
LTPersonalCode	string	LT Personal Code
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	LU Nationale Identifikationsnummer nicht natürlich
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-Mehrwertsteuernummer
NOIdentityNumber	string	KEINE Identitätsnummer
NZBankAccountNumber	string	NZ-Bankkontonummer
NZDriversLicenseNumber	string	NZ-Führerscheinnummer
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Nummer des NZ-Gesundheitsministeriums
NZSocialWelfareNumber	string	NZ-Sozialversicherungsnummer
Organization	string	Organization
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 Passnummer
PLREGONNumber	string	PL REGON-Nummer
PLTaxIdentificationNumber	string	PL Steueridentifikationsnummer
PTCitizenCardNumber	string	PT Bürgerkartennummer
PTCitizenCardNumberV2	string	PT Bürgerkarte Nummer V2
PTTaxIdentificationNumber	string	PT-Steueridentifikationsnummer
Person	string	Person
PhoneNumber	string	Rufnummer
ROPersonalNumericalCode	string	PERSÖNLICHER NUMERISCHER RO-Code
RUPassportNumberDomestic	string	RU Passport Nummer Inland
RUPassportNumberInternational	string	RU Passport Nummer International
SANationalID	string	SA National ID
SENationalID	string	SE National ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	SE Passport-Nummer
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	SK Persönliche Nummer
SQLServerConnectionString	string	SQL Server-Verbindungszeichenfolge
SWIFTCode	string	SWIFT-Code
THPopulationIdentificationCode	string	TH Population Identification Code
TRNationalIdentificationNumber	string	Tr Nationale Identifikationsnummer
TWNationalID	string	TW National ID
TWPassportNumber	string	TW Passport-Nummer
TWResidentCertificate	string	TW-Resident-Zertifikat
UAPassportNumberDomestic	string	UA Passport Number Domestic
UAPassportNumberInternational	string	UA Passport Nummer International
UKDriversLicenseNumber	string	UK Driver's License Number
UKElectoralRollNumber	string	UK Electoral Roll Number
UKNationalHealthNumber	string	UK National Health Number
UKNationalInsuranceNumber	string	UK National Insurance Number
UKUniqueTaxpayerNumber	string	Eindeutige Steuernummer des Vereinigten Königreichs
URL	string	URL
USBankAccountNumber	string	US-Bankkontonummer
USDriversLicenseNumber	string	US-Führerscheinnummer
USIndividualTaxpayerIdentification	string	Us-Amerikanischer Steuerzahleridentifikation
USSocialSecurityNumber	string	US-Sozialversicherungsnummer
USUKPassportNumber	string	US UK Passport Number
ZAIdentificationNumber	string	ZA-Identifikationsnummer

PiiDomain

Aufgabe Domäne für PII

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, die beim Verarbeiten des Dokuments auftreten.

PiiResult

Enthält 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 einen Task für die Erkennung personenbezogener Entitäten.

Name	Typ	Standardwert	Beschreibung
domain	PiiDomain	none	Aufgabe "Domäne für PII"
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
piiCategories	PiiCategory[]		Enumeration der in der Antwort zurückzugebenden personenbezogene Datenkategorien.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType, der für die Analyse verwendet werden soll.

PiiTaskResult

Enthält den LRO-Task zum Analysieren von Text PIIEntityRecognition.

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

RequestStatistics

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

Name	Typ	Beschreibung
documentsCount	integer	Anzahl der in der Anforderung übermittelten Dokumente.
erroneousDocumentsCount	integer	Anzahl ungültiger Dokumente. Dies schließt leere, überformatige oder nicht unterstützte Sprachdokumente ein.
transactionsCount	integer	Anzahl der Transaktionen für die Anforderung.
validDocumentsCount	integer	Anzahl gültiger Dokumente. Dies schließt leere, überformatige oder nicht unterstützte Sprachdokumente aus.

SentenceAssessment

Stellt eine Satzbewertung und die damit verbundenen Bewertungen oder Zielobjekte dar.

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	Die Stimmung des Satzes.
text	string	Der erkannte Zieltext.

SentenceSentiment

Die Satzstimmung 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 damit verbundenen Bewertungen oder Zielobjekte dar.

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, das mit dem Ziel verknüpft ist.
sentiment	TokenSentimentValue	Die Stimmung des Satzes.
text	string	Der erkannte Zieltext.

SentimentAnalysisTaskParameters

Unterstützte Parameter für einen Standpunktanalysetask.

Name	Typ	Standardwert	Beschreibung
loggingOptOut	boolean	False	Abmelden
modelVersion	string	latest	Modellversion
opinionMining	boolean	False	Ob Opinion Mining in der Anforderung verwendet werden soll oder nicht.
stringIndexType	StringIndexType	TextElements_v8	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets 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 sind stimmungsvoll.
sentiment	DocumentSentimentValue	Vorhergesagte Stimmung für ein 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, die beim Verarbeiten des Dokuments auftreten.

SentimentResponse

Stimmungsanalyseergebnisse 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 das Analysetext-LRO-Vorgangsergebnis von SentimentAnalysis.

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

StringIndexType

Zeichenfolgenindextyp

Name	Typ	Beschreibung
TextElements_v8	string	Zurückgegebene Offset- und Längenwerte entsprechen TextElements (Grapheme- und Graphemcluster), die den 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 ist, 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 ist, die Unicode unterstützt, z. B. Java, 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 sich auf das Ziel bezieht.

TargetRelationType

Der Typ, der sich auf das Ziel bezieht.

Name	Typ	Beschreibung
assessment	string
target	string

TokenSentimentValue

Die vorhergesagte Stimmung für den Satz.

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

WarningCodeValue

Definiert die Liste der Warnungscodes.

Name	Typ	Beschreibung
DocumentTruncated	string	Warnung zum Abschneiden des Dokuments
LongWordsInDocument	string	Warnung zu langen Wörtern in Dokumenten