Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Žádost o analýzu textu pro kolekci dokumentů

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
showStats	query		boolean	(Volitelné) Pokud je nastavená hodnota true, odpověď bude obsahovat statistiky na úrovni požadavků a dokumentů.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Text žádosti může tvořit:

Name	Description
AnalyzeTextEntityLinkingInput	Obsahuje text analyze text Entity linking input.
AnalyzeTextEntityRecognitionInput	Rozpoznávání entity analyzuje požadavek úkolu na zadání textu.
AnalyzeTextKeyPhraseExtractionInput	Obsahuje vstup úlohy analyzovat text KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Obsahuje vstup úlohy analýzy dokumentu rozpoznávání jazyka.
AnalyzeTextPiiEntitiesRecognitionInput	Obsahuje vstup úlohy analyzovat text PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Obsahuje vstup úlohy Analyzovat text SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Obsahuje text analyze text Entity linking input.

Name	Vyžadováno	Typ	Description
kind	True	string: EntityLinking	Druh úlohy, která se má provést.
analysisInput		MultiLanguageAnalysisInput	Obsahuje vstup analýzy, který má služba zpracovat.
parameters		EntityLinkingTaskParameters	Parametry úlohy.

AnalyzeTextEntityRecognitionInput

Rozpoznávání entity analyzuje požadavek úkolu na zadání textu.

Name	Vyžadováno	Typ	Description
kind	True	string: EntityRecognition	Druh úlohy, která se má provést.
analysisInput		MultiLanguageAnalysisInput	Vstup, který se má analyzovat.
parameters		EntitiesTaskParameters	Parametry úlohy.

AnalyzeTextKeyPhraseExtractionInput

Obsahuje vstup úlohy analyzovat text KeyPhraseExtraction.

Name	Vyžadováno	Typ	Description
kind	True	string: KeyPhraseExtraction	Druh úlohy, která se má provést.
analysisInput		MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
parameters		KeyPhraseTaskParameters	Parametry úlohy extrakce klíčových frází

AnalyzeTextLanguageDetectionInput

Obsahuje vstup úlohy analýzy dokumentu rozpoznávání jazyka.

Name	Vyžadováno	Typ	Description
kind	True	string: LanguageDetection	Druh úlohy, která se má provést.
analysisInput		LanguageDetectionAnalysisInput	Dokumenty, které se mají analyzovat.
parameters		LanguageDetectionTaskParameters	parametry úkolu.

AnalyzeTextPiiEntitiesRecognitionInput

Obsahuje vstup úlohy analyzovat text PIIEntityRecognition.

Name	Vyžadováno	Typ	Description
kind	True	string: PiiEntityRecognition	Druh úlohy, která se má provést.
analysisInput		MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
parameters		PiiTaskParameters	Parametry úlohy Pii.

AnalyzeTextSentimentAnalysisInput

Obsahuje vstup úlohy Analyzovat text SentimentAnalysis.

Name	Vyžadováno	Typ	Description
kind	True	string: SentimentAnalysis	Druh úlohy, která se má provést.
analysisInput		MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
parameters		SentimentAnalysisTaskParameters	Parametry úlohy Analýza mínění.

Odpovědi

Name	Typ	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Žádost byla úspěšná.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď. Headers x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
AnalyzeTextEntityLinkingInput	Obsahuje text analyze entity linking input.
AnalyzeTextEntityRecognitionInput	Rozpoznávání entity analyzuje požadavek úkolu zadávání textu.
AnalyzeTextKeyPhraseExtractionInput	Obsahuje vstup úlohy Analyzovat text KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Obsahuje vstup úlohy analýzy dokumentu detekce jazyka.
AnalyzeTextPiiEntitiesRecognitionInput	Obsahuje vstup úlohy analyzovat text PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Obsahuje vstup úlohy Analyzovat text SentimentAnalysis.
AnalyzeTextTaskKind	Druh podporovaných úloh analyzovat text.
AnalyzeTextTaskResultsKind	Druh objektu odpovědi vráceného úlohou analyze-text.
DetectedLanguage	Obsahuje podrobnosti rozpoznaného jazyka textu.
DocumentError	Obsahuje podrobnosti o chybách, ke kterým došlo při provádění úlohy.
DocumentSentimentValue	Predikované mínění pro dokument (negativní, neutrální, pozitivní nebo smíšené)
DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
DocumentWarning	Obsahuje objekt upozornění s upozorněními zjištěnými pro zpracovaný dokument.
EntitiesDocumentResult	Obsahuje výsledek úkolu rozpoznávání entit pro dokument.
EntitiesResult	Obsahuje výsledek úkolu rozpoznávání entity.
EntitiesTaskParameters	Podporované parametry pro úlohu Rozpoznávání entit.
EntitiesTaskResult	Obsahuje úkol entity.
Entity	Definuje zjištěný objekt entity, který obsahuje kategorii entity, zjištěný text entity atd.
EntityLinkingResult	Výsledek propojení entit.
EntityLinkingTaskParameters	Podporované parametry pro úlohu Entity Linking
EntityLinkingTaskResult	Obsahuje výsledek úkolu propojení entit s textem analyzovat entitu.
Error	Objekt odpovědi na chybu vrácený, když služba při zpracování požadavku narazí na určité chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Obsahuje keyPhraseResult.
KeyPhrasesDocumentResult	Obsahuje výsledky extrakce klíčových frází pro dokument.
KeyPhraseTaskParameters	Podporované parametry pro úlohu extrakce klíčových frází
KeyPhraseTaskResult	Obsahuje výsledek úlohy Analyzovat text KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Obsahuje vstup analýzy dokumentu detekce jazyka.
LanguageDetectionDocumentResult	Obsahuje rozpoznávání jazyka pro dokument.
LanguageDetectionResult	Obsahuje výsledek rozpoznávání jazyka pro požadavek.
LanguageDetectionTaskParameters	Podporované parametry pro úlohu Rozpoznávání jazyka.
LanguageDetectionTaskResult	Obsahuje výsledek úlohy rozpoznávání jazyka pro požadavek.
LanguageInput	Obsahuje vstup rozpoznávání jazyka.
LinkedEntitiesDocumentResult	Výsledek dokumentu pro propojení entit.
LinkedEntity	Objekt LinkedEntity obsahující zjištěnou entitu s přidruženými zdroji nebo odkazy.
Match	Match objekt obsahující text zjištěné entity s posunem a délkou.
MultiLanguageAnalysisInput	Kolekce vstupních dokumentů, které má služba analyzovat.
MultiLanguageInput	Obsahuje vstupní dokument, který má služba analyzovat.
PiiCategory	(Volitelné) popisuje kategorie pii, které se mají vrátit.
PiiDomain	Doména pro úlohu PII
PiiEntitiesDocumentResult	Obsahuje výsledky PII.
PiiResult	Obsahuje PiiResult.
PiiTaskParameters	Podporované parametry pro úlohu rozpoznávání entit PII
PiiTaskResult	Obsahuje úlohu analýza textu PIIEntityRecognition LRO.
RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.
SentenceAssessment	Představuje vyhodnocení věty a posouzení nebo cílové objekty, které s ním souvisejí.
SentenceSentiment	Mínění ve větách dokumentu
SentenceSentimentValue	Předpovězené mínění pro větu
SentenceTarget	Představuje cíl věty a hodnocení nebo cílové objekty, které s ním souvisejí.
SentimentAnalysisTaskParameters	Podporované parametry pro úlohu Analýza mínění.
SentimentConfidenceScores	Představuje skóre spolehlivosti mezi 0 a 1 ve všech třídách mínění: pozitivní, neutrální, negativní.
SentimentDocumentResult	Objekt představující předem vytvořené výsledky analýzy mínění v jednotlivých dokumentech.
SentimentResponse	Výsledky analýzy mínění pro vstupní dokumenty
SentimentTaskResult	Obsahuje výsledek úkolu analýza textu SentimentAnalysis LRO.
StringIndexType	Typ indexu řetězce
TargetConfidenceScoreLabel	Představuje skóre spolehlivosti ve všech třídách mínění: pozitivních i negativních.
TargetRelation	Představuje vztah mezi posouzeními a/nebo cíli.
TargetRelationType	Typ související s cílem.
TokenSentimentValue	Předpovězené mínění pro větu
WarningCodeValue	Definuje seznam kódů upozornění.

AnalyzeTextEntityLinkingInput

Obsahuje text analyze entity linking input.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Obsahuje vstup analýzy, který má služba zpracovat.
kind	string: EntityLinking	Druh úlohy, která se má provést.
parameters	EntityLinkingTaskParameters	Parametry úlohy.

AnalyzeTextEntityRecognitionInput

Rozpoznávání entity analyzuje požadavek úkolu zadávání textu.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Vstup, který se má analyzovat.
kind	string: EntityRecognition	Druh úlohy, která se má provést.
parameters	EntitiesTaskParameters	Parametry úlohy.

AnalyzeTextKeyPhraseExtractionInput

Obsahuje vstup úlohy Analyzovat text KeyPhraseExtraction.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
kind	string: KeyPhraseExtraction	Druh úlohy, která se má provést.
parameters	KeyPhraseTaskParameters	Parametry úlohy extrakce klíčových frází

AnalyzeTextLanguageDetectionInput

Obsahuje vstup úlohy analýzy dokumentu detekce jazyka.

Name	Typ	Description
analysisInput	LanguageDetectionAnalysisInput	Dokumenty, které se mají analyzovat.
kind	string: LanguageDetection	Druh úlohy, která se má provést.
parameters	LanguageDetectionTaskParameters	parametry úkolu.

AnalyzeTextPiiEntitiesRecognitionInput

Obsahuje vstup úlohy analyzovat text PIIEntityRecognition.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
kind	string: PiiEntityRecognition	Druh úlohy, která se má provést.
parameters	PiiTaskParameters	Parametry úlohy Pii.

AnalyzeTextSentimentAnalysisInput

Obsahuje vstup úlohy Analyzovat text SentimentAnalysis.

Name	Typ	Description
analysisInput	MultiLanguageAnalysisInput	Obsahuje vstupní dokumenty.
kind	string: SentimentAnalysis	Druh úlohy, která se má provést.
parameters	SentimentAnalysisTaskParameters	Parametry úlohy Analýza mínění.

AnalyzeTextTaskKind

Druh podporovaných úloh analyzovat text.

Name	Typ	Description
EntityLinking	string	Úkol propojení entit
EntityRecognition	string	Úloha rozpoznávání entit
KeyPhraseExtraction	string	Úloha extrakce klíčových frází
LanguageDetection	string	Úloha rozpoznávání jazyka
PiiEntityRecognition	string	Úloha rozpoznávání entit PII
SentimentAnalysis	string	Úloha analýzy mínění

AnalyzeTextTaskResultsKind

Druh objektu odpovědi vráceného úlohou analyze-text.

Name	Typ	Description
EntityLinkingResults	string	Výsledky propojení entit
EntityRecognitionResults	string	Výsledky rozpoznávání entit
KeyPhraseExtractionResults	string	Výsledky extrakce klíčových frází
LanguageDetectionResults	string	Výsledky rozpoznávání jazyka
PiiEntityRecognitionResults	string	Výsledky rozpoznávání entit PII
SentimentAnalysisResults	string	Výsledky analýzy mínění

DetectedLanguage

Obsahuje podrobnosti rozpoznaného jazyka textu.

Name	Typ	Description
confidenceScore	number	Skóre spolehlivosti mezi 0 a 1. Skóre blížící se 1 značí 100% jistotu, že identifikovaný jazyk je pravdivý.
iso6391Name	string	Dvoumísmenné vyjádření zjištěného jazyka podle normy ISO 639-1 (např. en, fr).
name	string	Dlouhý název rozpoznaného jazyka (např. angličtina, francouzština).

DocumentError

Obsahuje podrobnosti o chybách, ke kterým došlo při provádění úlohy.

Name	Typ	Description
error	Error	Došlo k chybě.
id	string	ID vstupního dokumentu.

DocumentSentimentValue

Predikované mínění pro dokument (negativní, neutrální, pozitivní nebo smíšené)

Name	Typ	Description
mixed	string	Smíšený příkaz
negative	string	Záporný příkaz
neutral	string	Neutrální příkaz
positive	string	Kladné tvrzení

DocumentStatistics

Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.

Name	Typ	Description
charactersCount	integer	Počet rozpoznaných textových prvků v dokumentu
transactionsCount	integer	Počet transakcí pro dokument

DocumentWarning

Obsahuje objekt upozornění s upozorněními zjištěnými pro zpracovaný dokument.

Name	Typ	Description
code	WarningCodeValue	Kód upozornění.
message	string	Zpráva upozornění.
targetRef	string	Odkaz na ukazatel JSON označující cílový objekt.

EntitiesDocumentResult

Obsahuje výsledek úkolu rozpoznávání entit pro dokument.

Name	Typ	Description
entities	Entity[]	Rozpoznané entity v dokumentu
id	string	Jedinečný, neprázdný identifikátor dokumentu.
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

EntitiesResult

Obsahuje výsledek úkolu rozpoznávání entity.

Name	Typ	Description
documents	EntitiesDocumentResult[]	Odpověď podle dokumentu
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

EntitiesTaskParameters

Podporované parametry pro úlohu Rozpoznávání entit.

Name	Typ	Výchozí hodnota	Description
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu
stringIndexType	StringIndexType	TextElements_v8	(Nepovinný) parametr pro zadání typu indexu řetězce, který se používá k interpretaci posunů řetězců. Výchozí hodnota je TextElements (Graphemes).

EntitiesTaskResult

Obsahuje úkol entity.

Name	Typ	Description
kind	string: EntityRecognitionResults	Druh výsledku úkolu.
results	EntitiesResult	Výsledky pro rozpoznávání entit.

Entity

Definuje zjištěný objekt entity, který obsahuje kategorii entity, zjištěný text entity atd.

Name	Typ	Description
category	string	Typ entity.
confidenceScore	number	Skóre spolehlivosti extrahované entity mezi 0 a 1.
length	integer	Délka textu entity Vrácenou délku může ovlivnit použití různých hodnot stringIndexType.
offset	integer	Počáteční pozice textu entity Použití různých hodnot stringIndexType může ovlivnit vrácený posun.
subcategory	string	(Volitelné) Podtyp entity.
text	string	Text entity, který se zobrazí v požadavku.

EntityLinkingResult

Výsledek propojení entit.

Name	Typ	Description
documents	LinkedEntitiesDocumentResult[]	Odpověď podle dokumentu
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

EntityLinkingTaskParameters

Podporované parametry pro úlohu Entity Linking

Name	Typ	Výchozí hodnota	Description
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu
stringIndexType	StringIndexType	TextElements_v8	Volitelný parametr pro zadání typu indexu řetězce, který se používá k interpretaci posunů řetězců. Výchozí hodnota je TextElements (Graphemes).

EntityLinkingTaskResult

Obsahuje výsledek úkolu propojení entit s textem analyzovat entitu.

Name	Typ	Description
kind	string: EntityLinkingResults	Druh výsledku úkolu.
results	EntityLinkingResult	Výsledek propojení entit.

Error

Objekt odpovědi na chybu vrácený, když služba při zpracování požadavku narazí na určité chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definované sady kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string	chyba Azure Cognitive Search dosažení limitu indexu
AzureCognitiveSearchIndexNotFound	string	chyba Azure Cognitive Search index nenalezena
AzureCognitiveSearchNotFound	string	Chyba Azure Cognitive Search nenalezena
AzureCognitiveSearchThrottling	string	Azure Cognitive Search chyba omezování
Conflict	string	Chyba konfliktu
Forbidden	string	Chyba zakázaného přístupu
InternalServerError	string	Vnitřní chyba serveru
InvalidArgument	string	Chyba neplatného argumentu
InvalidRequest	string	Chyba neplatného požadavku
NotFound	string	Chyba nenalezena
OperationNotFound	string	Chyba operace nenalezena
ProjectNotFound	string	Chyba projekt nenalezl
QuotaExceeded	string	Chyba překročení kvóty
ServiceUnavailable	string	Chyba nedostupnosti služby
Timeout	string	Chyba časového limitu
TooManyRequests	string	Chyba příliš mnoho požadavků
Unauthorized	string	Chyba neoprávněného přístupu
Warning	string	Chyba upozornění

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
AzureCognitiveSearchNotFound	string	Chyba Azure Cognitive Search nenalezena
AzureCognitiveSearchThrottling	string	Azure Cognitive Search chyba omezování
EmptyRequest	string	Chyba prázdného požadavku
ExtractionFailure	string	Chyba selhání extrakce
InvalidCountryHint	string	Chyba nápovědy k neplatné zemi
InvalidDocument	string	Chyba neplatného dokumentu
InvalidDocumentBatch	string	Chyba dávky neplatného dokumentu
InvalidParameterValue	string	Chyba neplatné hodnoty parametru
InvalidRequest	string	Chyba neplatného požadavku
InvalidRequestBodyFormat	string	Chyba neplatného formátu textu požadavku
KnowledgeBaseNotFound	string	Chyba znalostní báze nenalezena
MissingInputDocuments	string	Chyba chybějících vstupních dokumentů
ModelVersionIncorrect	string	Chyba kvůli nesprávné verzi modelu
UnsupportedLanguageCode	string	Chyba kvůli nepodporovanému kódu jazyka

InnerErrorModel

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jeden ze serverem definované sady kódů chyb.
details	object	Podrobnosti o chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace o chybě než aktuální objekt.
message	string	Chybová zpráva.
target	string	Cíl chyby.

KeyPhraseResult

Obsahuje keyPhraseResult.

Name	Typ	Description
documents	KeyPhrasesDocumentResult[]	Odpověď podle dokumentu
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

KeyPhrasesDocumentResult

Obsahuje výsledky extrakce klíčových frází pro dokument.

Name	Typ	Description
id	string	Jedinečný, neprázdný identifikátor dokumentu.
keyPhrases	string[]	Seznam reprezentativních slov nebo frází. Počet vrácených klíčových frází je úměrný počtu slov ve vstupním dokumentu.
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

KeyPhraseTaskParameters

Podporované parametry pro úlohu extrakce klíčových frází

Name	Typ	Výchozí hodnota	Description
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu

KeyPhraseTaskResult

Obsahuje výsledek úlohy Analyzovat text KeyPhraseExtraction.

Name	Typ	Description
kind	string: KeyPhraseExtractionResults	Druh výsledku úkolu.
results	KeyPhraseResult	Seznam výsledků extrakce klíčových frází

LanguageDetectionAnalysisInput

Obsahuje vstup analýzy dokumentu detekce jazyka.

Name	Typ	Description
documents	LanguageInput[]	Seznam dokumentů, které se mají analyzovat.

LanguageDetectionDocumentResult

Obsahuje rozpoznávání jazyka pro dokument.

Name	Typ	Description
detectedLanguage	DetectedLanguage	Zjištěný jazyk.
id	string	Jedinečný, neprázdný identifikátor dokumentu.
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

LanguageDetectionResult

Obsahuje výsledek rozpoznávání jazyka pro požadavek.

Name	Typ	Description
documents	LanguageDetectionDocumentResult[]	Výčet výsledků rozpoznávání jazyka pro každý vstupní dokument
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

LanguageDetectionTaskParameters

Podporované parametry pro úlohu Rozpoznávání jazyka.

Name	Typ	Výchozí hodnota	Description
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu

LanguageDetectionTaskResult

Obsahuje výsledek úlohy rozpoznávání jazyka pro požadavek.

Name	Typ	Description
kind	string: LanguageDetectionResults	Druh výsledku úkolu.
results	LanguageDetectionResult	Obsahuje výsledky rozpoznávání jazyka.

LanguageInput

Obsahuje vstup rozpoznávání jazyka.

Name	Typ	Description
countryHint	string	Nápověda pro zemi, která pomáhá s rozpoznáváním jazyka textu.
id	string	Jedinečný, neprázdný identifikátor dokumentu.
text	string	Vstupní text, který se má zpracovat.

LinkedEntitiesDocumentResult

Výsledek dokumentu pro propojení entit.

Name	Typ	Description
entities	LinkedEntity[]	V dokumentu byly rozpoznány dobře známé entity.
id	string	Jedinečný, neprázdný identifikátor dokumentu.
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

LinkedEntity

Objekt LinkedEntity obsahující zjištěnou entitu s přidruženými zdroji nebo odkazy.

Name	Typ	Description
bingId	string	Jedinečný identifikátor rozhraní API entity Bingu Search rozpoznané entity.
dataSource	string	Zdroj dat používaný k extrakci propojení entit, jako je Wiki, Bing atd.
id	string	Jedinečný identifikátor rozpoznané entity ze zdroje dat.
language	string	Jazyk používaný ve zdroji dat.
matches	Match[]	Seznam instancí, které se tato entita zobrazí v textu.
name	string	Formální název entity Linking
url	string	Adresa URL stránky entity ze zdroje dat

Match

Match objekt obsahující text zjištěné entity s posunem a délkou.

Name	Typ	Description
confidenceScore	number	Pokud je rozpoznána dobře známá položka, vrátí se desetinné číslo označující úroveň spolehlivosti mezi 0 a 1.
length	integer	Délka entity odpovídá textu.
offset	integer	Počáteční pozice pro text shody entity.
text	string	Text entity, který se zobrazí v požadavku.

MultiLanguageAnalysisInput

Kolekce vstupních dokumentů, které má služba analyzovat.

Name	Typ	Description
documents	MultiLanguageInput[]	Vstupní dokumenty, které se mají analyzovat.

MultiLanguageInput

Obsahuje vstupní dokument, který má služba analyzovat.

Name	Typ	Description
id	string	Jedinečný, neprázdný identifikátor dokumentu.
language	string	(Volitelné) Toto je 2 písmena ISO 639-1 reprezentace jazyka. Například pro angličtinu použijte "en". "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu. (Následující informace platí jenom pro verzi 2023-04-15-preview a novější.) Pro automatické rozpoznávání jazyka použijte "auto". Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
text	string	Vstupní text, který se má zpracovat.

PiiCategory

(Volitelné) popisuje kategorie pii, které se mají vrátit.

Name	Typ	Description
ABARoutingNumber	string	Směrovací číslo ABA
ARNationalIdentityNumber	string	Národní identifikační číslo ar
ATIdentityCard	string	AT Identity Card
ATTaxIdentificationNumber	string	DAŇOVÉ IDENTIFIKAČNÍ ČÍSLO AT
ATValueAddedTaxNumber	string	AT Value Added Tax Number
AUBankAccountNumber	string	AT Identity Card
AUBusinessNumber	string	Obchodní číslo AU
AUCompanyNumber	string	Číslo společnosti AU
AUDriversLicenseNumber	string	Číslo řidičského průkazu AU
AUMedicalAccountNumber	string	Číslo lékařského účtu AU
AUPassportNumber	string	Číslo pasu AU
AUTaxFileNumber	string	Daňové číslo AU
Address	string	Adresa
Age	string	Věk
All	string	Všechny kategorie osobních informací.
AzureDocumentDBAuthKey	string	Ověřovací klíč služby Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Připojení k databázi Azure IaaS a řetězec SQL
AzureIoTConnectionString	string	Připojovací řetězec Azure IoT
AzurePublishSettingPassword	string	Heslo pro nastavení publikování v Azure
AzureRedisCacheString	string	Řetězec služby Azure Redis Cache
AzureSAS	string	Azure SAS
AzureServiceBusString	string	Azure Service Bus řetězec
AzureStorageAccountGeneric	string	Obecný účet služby Azure Storage
AzureStorageAccountKey	string	Klíč účtu služby Azure Storage
BENationalNumber	string	Národní číslo BE
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE Číslo daně z přidané hodnoty
BGUniformCivilNumber	string	BG Jednotné občanské číslo
BRCPFNumber	string	Číslo BR CPF
BRLegalEntityNumber	string	Číslo právnické osoby BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Číslo bankovního účtu certifikační autority
CADriversLicenseNumber	string	Číslo řidičského průkazu certifikační autority
CAHealthServiceNumber	string	Číslo služby CA Health Service
CAPassportNumber	string	Číslo pasu certifikační autority
CAPersonalHealthIdentification	string	Identifikace osobního zdraví certifikační autority
CASocialInsuranceNumber	string	Číslo sociálního pojištění CA
CHSocialSecurityNumber	string	Číslo sociálního pojištění CH
CLIdentityCardNumber	string	Číslo průkazu totožnosti CL
CNResidentIdentityCardNumber	string	Číslo průkazu totožnosti rezidenta CN
CYIdentityCard	string	Průkaz totožnosti CY
CYTaxIdentificationNumber	string	Daňové identifikační číslo CY
CZPersonalIdentityNumber	string	Číslo osobního identifikačního čísla CZ
CZPersonalIdentityV2	string	CZ Personal Identity V2
CreditCardNumber	string	Číslo platební karty
DEDriversLicenseNumber	string	DE Číslo řidičského průkazu
DEIdentityCardNumber	string	DE Číslo průkazu totožnosti
DEPassportNumber	string	Číslo pasu DE
DETaxIdentificationNumber	string	DE Daňové identifikační číslo
DEValueAddedNumber	string	DE Value Added Number
DKPersonalIdentificationNumber	string	Osobní identifikační číslo DK
DKPersonalIdentificationV2	string	DK Personal Identification V2
Date	string	Datum
Default	string	Výchozí kategorie PII pro jazyk
DrugEnforcementAgencyNumber	string	Číslo agentury pro vymáhání drog
EEPersonalIdentificationCode	string	Osobní identifikační kód EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Číslo sociálního pojištění ES
ESTaxIdentificationNumber	string	Daňové identifikační číslo ES
EUDebitCardNumber	string	Číslo debetní karty EU
EUDriversLicenseNumber	string	Číslo řidičského průkazu EU
EUGPSCoordinates	string	SOUŘADNICE GPS EU
EUNationalIdentificationNumber	string	Národní identifikační číslo EU
EUPassportNumber	string	Číslo pasu EU
EUSocialSecurityNumber	string	Číslo sociálního pojištění EU
EUTaxIdentificationNumber	string	Daňové identifikační číslo EU
Email	string	E-mail
FIEuropeanHealthNumber	string	Evropské zdravotní číslo FI
FINationalID	string	FI National ID
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	Číslo pasu FI
FRDriversLicenseNumber	string	Číslo řidičského průkazu FR
FRHealthInsuranceNumber	string	Číslo zdravotní pojišťovny FR
FRNationalID	string	NÁRODNÍ ID FR
FRPassportNumber	string	Číslo pasu FR
FRSocialSecurityNumber	string	FR Číslo sociálního pojištění
FRTaxIdentificationNumber	string	Daňové identifikační číslo FR
FRValueAddedTaxNumber	string	FR Číslo daně z přidané hodnoty
GRNationalIDCard	string	GR National ID Card
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	Daňové identifikační číslo GR
HKIdentityCardNumber	string	Číslo průkazu totožnosti HK
HRIdentityCardNumber	string	Číslo průkazu identity personálního oddělení
HRNationalIDNumber	string	Národní identifikační číslo personálního oddělení
HRPersonalIdentificationNumber	string	Osobní identifikační číslo personálního oddělení
HRPersonalIdentificationOIBNumberV2	string	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	string	Osobní identifikační číslo HU
HUTaxIdentificationNumber	string	Daňové identifikační číslo HU
HUValueAddedNumber	string	Přidané číslo hodnoty HU
IDIdentityCardNumber	string	Číslo průkazu totožnosti
IEPersonalPublicServiceNumber	string	Osobní číslo veřejné služby IE
IEPersonalPublicServiceNumberV2	string	Číslo osobní veřejné služby IE V2
ILBankAccountNumber	string	Číslo bankovního účtu IL
ILNationalID	string	IL National ID
INPermanentAccount	string	IN Permanent Account
INUniqueIdentificationNumber	string	Jedinečné identifikační číslo IN
IPAddress	string	IP adresa
ITDriversLicenseNumber	string	Číslo řidičského průkazu IT
ITFiscalCode	string	IT Fiscal Code
ITValueAddedTaxNumber	string	Číslo daně z přidané hodnoty IT
InternationalBankingAccountNumber	string	Číslo účtu mezinárodního bankovnictví
JPBankAccountNumber	string	Číslo bankovního účtu JP
JPDriversLicenseNumber	string	Číslo řidičského průkazu JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Číslo pasu JP
JPResidenceCardNumber	string	JP Residence Card Number
JPResidentRegistrationNumber	string	Registrační číslo rezidenta JP
JPSocialInsuranceNumber	string	JP Číslo sociálního pojištění
KRResidentRegistrationNumber	string	Registrační číslo rezidenta KR
LTPersonalCode	string	LT Personal Code
LUNationalIdentificationNumberNatural	string	LU National Identification Number Natural
LUNationalIdentificationNumberNonNatural	string	Národní identifikační číslo LU, které není přirozené
LVPersonalCode	string	Osobní kód LV
MTIdentityCardNumber	string	Číslo průkazu totožnosti MT
MTTaxIDNumber	string	ČÍSLO DAŇOVÉHO IDENTIFIKAČNÍHO ČÍSLA MT
MYIdentityCardNumber	string	Číslo průkazu totožnosti MY
NLCitizensServiceNumber	string	Číslo služby občanů NL
NLCitizensServiceNumberV2	string	NL Citizens Service Number V2
NLTaxIdentificationNumber	string	Daňové identifikační číslo NL
NLValueAddedTaxNumber	string	NL Číslo daně z přidané hodnoty
NOIdentityNumber	string	ŽÁDNÉ identifikační číslo
NZBankAccountNumber	string	Číslo bankovního účtu NZ
NZDriversLicenseNumber	string	Číslo řidičského průkazu NZ
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Číslo ministerstva zdravotnictví NZ
NZSocialWelfareNumber	string	NZ Číslo sociálního zabezpečení
Organization	string	Organizace
PHUnifiedMultiPurposeIDNumber	string	Sjednocené číslo ID pro více účelů PH
PLIdentityCard	string	Průkaz totožnosti PL
PLNationalID	string	NÁRODNÍ ID PL
PLNationalIDV2	string	PL Národní ID V2
PLPassportNumber	string	Číslo pasu PL
PLREGONNumber	string	PL REGON Number
PLTaxIdentificationNumber	string	DAŇOVÉ IDENTIFIKAČNÍ ČÍSLO PL
PTCitizenCardNumber	string	Číslo občanské karty PT
PTCitizenCardNumberV2	string	PT Číslo občanské karty V2
PTTaxIdentificationNumber	string	DAŇOVÉ IDENTIFIKAČNÍ ČÍSLO PT
Person	string	Person (Osoba)
PhoneNumber	string	Telefonní číslo
ROPersonalNumericalCode	string	Osobní číselný kód RO
RUPassportNumberDomestic	string	Číslo pasu RU – vnitrostátní
RUPassportNumberInternational	string	Číslo pasu RU – mezinárodní
SANationalID	string	Národní ID SA
SENationalID	string	SE National ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Číslo pasu SE
SETaxIdentificationNumber	string	DAŇOVÉ IDENTIFIKAČNÍ ČÍSLO SE
SGNationalRegistrationIdentityCardNumber	string	SG National Registration Identity Card Number
SITaxIdentificationNumber	string	Daňové identifikační číslo SI
SIUniqueMasterCitizenNumber	string	SI Jedinečné hlavní číslo občana
SKPersonalNumber	string	Osobní číslo SK
SQLServerConnectionString	string	SQL Server připojovací řetězec
SWIFTCode	string	Kód SWIFT
THPopulationIdentificationCode	string	Identifikační kód populace TH
TRNationalIdentificationNumber	string	Národní identifikační číslo TR
TWNationalID	string	NÁRODNÍ ID TW
TWPassportNumber	string	Číslo pasu TW
TWResidentCertificate	string	Rezidentní certifikát TW
UAPassportNumberDomestic	string	Číslo pasu UA – Vnitrostátní
UAPassportNumberInternational	string	Číslo pasu UA International
UKDriversLicenseNumber	string	Číslo řidičského průkazu ve Spojeném království
UKElectoralRollNumber	string	Číslo seznamu voličů ve Spojeném království
UKNationalHealthNumber	string	Britské národní zdravotní číslo
UKNationalInsuranceNumber	string	UK National Insurance Number
UKUniqueTaxpayerNumber	string	Jedinečné číslo daňového poplatníka ve Spojeném království
URL	string	URL
USBankAccountNumber	string	Číslo bankovního účtu v USA
USDriversLicenseNumber	string	Číslo řidičského průkazu v USA
USIndividualTaxpayerIdentification	string	Identifikace daňových poplatníků v USA
USSocialSecurityNumber	string	Číslo sociálního pojištění v USA
USUKPassportNumber	string	Číslo pasu PRO SPOJENÉ KRÁLOVSTVÍ
ZAIdentificationNumber	string	Identifikační číslo ZA

PiiDomain

Doména pro úlohu PII

Name	Typ	Description
none	string	Označuje, že není zadána žádná doména.
phi	string	Označuje, že entity v doméně Osobní informace o stavu by měly být redigovány.

PiiEntitiesDocumentResult

Obsahuje výsledky PII.

Name	Typ	Description
entities	Entity[]	Rozpoznané entity v dokumentu
id	string	Jedinečný, neprázdný identifikátor dokumentu.
redactedText	string	Vrátí redigovaný text.
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

PiiResult

Obsahuje PiiResult.

Name	Typ	Description
documents	PiiEntitiesDocumentResult[]	Odpověď podle dokumentu
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

PiiTaskParameters

Podporované parametry pro úlohu rozpoznávání entit PII

Name	Typ	Výchozí hodnota	Description
domain	PiiDomain	none	Doména pro úlohu PII
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu
piiCategories	PiiCategory[]		Výčet kategorií PII, které se mají vrátit v odpovědi.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType se má použít pro analýzu.

PiiTaskResult

Obsahuje úlohu analýza textu PIIEntityRecognition LRO.

Name	Typ	Description
kind	string: PiiEntityRecognitionResults	Druh výsledku úkolu.
results	PiiResult	Seznam výsledků pii

RequestStatistics

Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

Name	Typ	Description
documentsCount	integer	Počet dokumentů odeslaných v žádosti
erroneousDocumentsCount	integer	Počet neplatných dokumentů To zahrnuje prázdné dokumenty, dokumenty s limitem překročení velikosti nebo nepodporované jazyky.
transactionsCount	integer	Počet transakcí pro požadavek
validDocumentsCount	integer	Počet platných dokumentů. Tím se vyloučí prázdné dokumenty, dokumenty s limitem překročení velikosti nebo nepodporované jazyky.

SentenceAssessment

Představuje vyhodnocení věty a posouzení nebo cílové objekty, které s ním souvisejí.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Představuje skóre spolehlivosti ve všech třídách mínění: pozitivních i negativních.
isNegated	boolean	Ukazatel představující, jestli je posouzení negované.
length	integer	Délka cíle.
offset	integer	Cílový posun od začátku věty.
sentiment	TokenSentimentValue	Mínění věty.
text	string	Byl zjištěn cílový text.

SentenceSentiment

Mínění ve větách dokumentu

Name	Typ	Description
assessments	SentenceAssessment[]	Pole hodnocení pro větu.
confidenceScores	SentimentConfidenceScores	Skóre spolehlivosti mínění mezi 0 a 1 pro větu pro všechny třídy.
length	integer	Délka cíle.
offset	integer	Cílový posun od začátku věty.
sentiment	SentenceSentimentValue	Předpovězené mínění pro větu
targets	SentenceTarget[]	Pole cílů věty pro větu.
text	string	Text věty.

SentenceSentimentValue

Předpovězené mínění pro větu

Name	Typ	Description
negative	string	Negativní mínění
neutral	string	Neutrální mínění
positive	string	Pozitivní mínění

SentenceTarget

Představuje cíl věty a hodnocení nebo cílové objekty, které s ním souvisejí.

Name	Typ	Description
confidenceScores	TargetConfidenceScoreLabel	Představuje skóre spolehlivosti ve všech třídách mínění: pozitivních i negativních.
length	integer	Délka cíle.
offset	integer	Cílový posun od začátku věty.
relations	TargetRelation[]	Pole posouzení nebo cílových objektů, které souvisí s cílem.
sentiment	TokenSentimentValue	Mínění věty.
text	string	Byl zjištěn cílový text.

SentimentAnalysisTaskParameters

Podporované parametry pro úlohu Analýza mínění.

Name	Typ	Výchozí hodnota	Description
loggingOptOut	boolean	False	odhlášení odhlášení
modelVersion	string	latest	verze modelu
opinionMining	boolean	False	Zda použít těžbu názorů v žádosti, nebo ne.
stringIndexType	StringIndexType	TextElements_v8	Určuje metodu použitou k interpretaci posunů řetězců.

SentimentConfidenceScores

Představuje skóre spolehlivosti mezi 0 a 1 ve všech třídách mínění: pozitivní, neutrální, negativní.

Name	Typ	Description
negative	number	Skóre spolehlivosti pro negativní mínění
neutral	number	Skóre spolehlivosti neutrálního mínění
positive	number	Skóre spolehlivosti pro pozitivní mínění

SentimentDocumentResult

Objekt představující předem vytvořené výsledky analýzy mínění v jednotlivých dokumentech.

Name	Typ	Description
confidenceScores	SentimentConfidenceScores	Skóre spolehlivosti mínění mezi 0 a 1 pro větu pro všechny třídy
id	string	Jedinečný, neprázdný identifikátor dokumentu.
sentences	SentenceSentiment[]	Mínění vět dokumentu
sentiment	DocumentSentimentValue	Předpovězené mínění pro dokument (negativní, neutrální, kladné nebo smíšené)
statistics	DocumentStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části dokumentu.
warnings	DocumentWarning[]	Při zpracování dokumentu došlo k upozorněním.

SentimentResponse

Výsledky analýzy mínění pro vstupní dokumenty

Name	Typ	Description
documents	SentimentDocumentResult[]	Výsledky analýzy mínění pro každý dokument ve vstupu
errors	DocumentError[]	Chyby podle ID dokumentu.
modelVersion	string	Toto pole označuje, který model se používá pro vyhodnocování.
statistics	RequestStatistics	Pokud byla v požadavku zadána hodnota showStats=true, bude toto pole obsahovat informace o datové části požadavku.

SentimentTaskResult

Obsahuje výsledek úkolu analýza textu SentimentAnalysis LRO.

Name	Typ	Description
kind	string: SentimentAnalysisResults	Druh výsledku úkolu.
results	SentimentResponse	Výsledky analýzy mínění

StringIndexType

Typ indexu řetězce

Name	Typ	Description
TextElements_v8	string	Vrácené hodnoty posunu a délky budou odpovídat TextElements (grafemes a grapheme clustery) potvrzující standard Unicode 8.0.0. Tuto možnost použijte, pokud je vaše aplikace napsaná v rozhraní .Net Framework nebo .Net Core a budete používat StringInfo.
UnicodeCodePoint	string	Vrácené hodnoty posunu a délky budou odpovídat bodům kódu Unicode. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje Kódování Unicode, například Python.
Utf16CodeUnit	string	Vrácené hodnoty posunu a délky budou odpovídat jednotkám kódu UTF-16. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje kódování Unicode, například Java nebo JavaScript.

TargetConfidenceScoreLabel

Představuje skóre spolehlivosti ve všech třídách mínění: pozitivních i negativních.

Name	Typ	Description
negative	number	Skóre spolehlivosti pro negativní mínění
positive	number	Skóre spolehlivosti pro pozitivní mínění

TargetRelation

Představuje vztah mezi posouzeními a/nebo cíli.

Name	Typ	Description
ref	string	Ukazatel JSON označující propojený objekt.
relationType	TargetRelationType	Typ související s cílem.

TargetRelationType

Typ související s cílem.

Name	Typ	Description
assessment	string
target	string

TokenSentimentValue

Předpovězené mínění pro větu

Name	Typ	Description
mixed	string	Smíšené mínění
negative	string	Negativní mínění
positive	string	Pozitivní mínění

WarningCodeValue

Definuje seznam kódů upozornění.

Name	Typ	Description
DocumentTruncated	string	Upozornění na zkrácení dokumentu
LongWordsInDocument	string	Upozornění na dlouhá slova v dokumentu