Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Zażądaj analizy tekstu w kolekcji dokumentów.

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

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
showStats	query		boolean	(Opcjonalnie) jeśli ustawiono wartość true, odpowiedź będzie zawierać statystyki dotyczące żądań i poziomu dokumentu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Treść żądania może być jedną z następujących:

Nazwa	Opis
AnalyzeTextEntityLinkingInput	Zawiera tekst analizowania danych wejściowych łączenia jednostek.
AnalyzeTextEntityRecognitionInput	Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.
AnalyzeTextKeyPhraseExtractionInput	Zawiera tekst wejściowy zadania analizy KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.
AnalyzeTextPiiEntitiesRecognitionInput	Zawiera dane wejściowe zadania analizy PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Zawiera dane wejściowe zadania analyze SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Zawiera tekst analizowania danych wejściowych łączenia jednostek.

Nazwa	Wymagane	Typ	Opis
kind	True	string: EntityLinking	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dane wejściowe analizy, które mają być obsługiwane przez usługę.
parameters		EntityLinkingTaskParameters	Parametry zadania.

AnalyzeTextEntityRecognitionInput

Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.

Nazwa	Wymagane	Typ	Opis
kind	True	string: EntityRecognition	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Dane wejściowe do przeanalizowania.
parameters		EntitiesTaskParameters	Parametry zadania.

AnalyzeTextKeyPhraseExtractionInput

Zawiera tekst wejściowy zadania analizy KeyPhraseExtraction.

Nazwa	Wymagane	Typ	Opis
kind	True	string: KeyPhraseExtraction	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		KeyPhraseTaskParameters	Parametry zadania wyodrębniania kluczowych fraz.

AnalyzeTextLanguageDetectionInput

Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.

Nazwa	Wymagane	Typ	Opis
kind	True	string: LanguageDetection	Rodzaj zadania do wykonania.
analysisInput		LanguageDetectionAnalysisInput	Dokumenty do przeanalizowania.
parameters		LanguageDetectionTaskParameters	parametry zadania.

AnalyzeTextPiiEntitiesRecognitionInput

Zawiera dane wejściowe zadania analizy PIIEntityRecognition.

Nazwa	Wymagane	Typ	Opis
kind	True	string: PiiEntityRecognition	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		PiiTaskParameters	Parametry zadania pii.

AnalyzeTextSentimentAnalysisInput

Zawiera dane wejściowe zadania analyze SentimentAnalysis.

Nazwa	Wymagane	Typ	Opis
kind	True	string: SentimentAnalysis	Rodzaj zadania do wykonania.
analysisInput		MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
parameters		SentimentAnalysisTaskParameters	Parametry zadania Analiza tonacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd. Headers x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
AnalyzeTextEntityLinkingInput	Zawiera tekst analizowania danych wejściowych łączenia jednostek.
AnalyzeTextEntityRecognitionInput	Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.
AnalyzeTextKeyPhraseExtractionInput	Zawiera tekst wejściowy zadania analizy KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.
AnalyzeTextPiiEntitiesRecognitionInput	Zawiera dane wejściowe zadania analizy PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Zawiera dane wejściowe zadania analyze SentimentAnalysis.
AnalyzeTextTaskKind	Rodzaj obsługiwanych zadań analizy tekstu.
AnalyzeTextTaskResultsKind	Rodzaj obiektu odpowiedzi zwróconego przez zadanie analyze-text.
DetectedLanguage	Zawiera szczegóły wykrytego języka dla tekstu.
DocumentError	Zawiera szczegółowe informacje o błędach napotkanych podczas wykonywania zadania.
DocumentSentimentValue	Przewidywana tonacja dokumentu (ujemna, neutralna, pozytywna lub mieszana).
DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
DocumentWarning	Zawiera obiekt ostrzeżeń z ostrzeżeniami napotkanymi dla przetworzonego dokumentu.
EntitiesDocumentResult	Zawiera wynik zadania rozpoznawania jednostek dla dokumentu.
EntitiesResult	Zawiera wynik zadania rozpoznawania jednostek.
EntitiesTaskParameters	Obsługiwane parametry zadania rozpoznawania jednostek.
EntitiesTaskResult	Zawiera zadanie jednostki
Entity	Definiuje wykryty obiekt jednostki zawierający wykrytą kategorię jednostki i wykryty tekst jednostki itp.
EntityLinkingResult	Wynik łączenia jednostek.
EntityLinkingTaskParameters	Obsługiwane parametry zadania Entity Linking.
EntityLinkingTaskResult	Zawiera wynik zadania analizowania jednostek łączących jednostki.
Error	Obiekt odpowiedzi o błędzie zwrócony, gdy usługa napotka pewne błędy podczas przetwarzania żądania.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Zawiera wartość KeyPhraseResult.
KeyPhrasesDocumentResult	Zawiera wyniki wyodrębniania kluczowych fraz dla dokumentu.
KeyPhraseTaskParameters	Obsługiwane parametry zadania wyodrębniania fraz kluczowych.
KeyPhraseTaskResult	Zawiera wynik zadania analizy KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Zawiera dane wejściowe analizy dokumentów wykrywania języka.
LanguageDetectionDocumentResult	Zawiera wykrywanie języka dla dokumentu.
LanguageDetectionResult	Zawiera wynik wykrywania języka dla żądania.
LanguageDetectionTaskParameters	Obsługiwane parametry zadania wykrywania języka.
LanguageDetectionTaskResult	Zawiera wynik zadania wykrywania języka dla żądania.
LanguageInput	Zawiera dane wejściowe wykrywania języka.
LinkedEntitiesDocumentResult	Wynik dokumentu łączenia jednostek.
LinkedEntity	Obiekt LinkedEntity zawierający wykrytą jednostkę ze skojarzonymi źródłami/linkami.
Match	Obiekt Match zawierający wykryty tekst jednostki z przesunięciem i długością.
MultiLanguageAnalysisInput	Kolekcja dokumentów wejściowych do przeanalizowania przez usługę.
MultiLanguageInput	Zawiera dokument wejściowy do analizy przez usługę.
PiiCategory	(Opcjonalnie) opisuje kategorie danych pii do zwrócenia
PiiDomain	Domena dla zadania pii
PiiEntitiesDocumentResult	Zawiera wyniki danych pii.
PiiResult	Zawiera wartość PiiResult.
PiiTaskParameters	Obsługiwane parametry zadania rozpoznawania jednostek PII.
PiiTaskResult	Zawiera zadanie LRO analizy tekstu PIIEntityRecognition.
RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.
SentenceAssessment	Reprezentuje ocenę zdania oraz oceny lub obiekty docelowe powiązane z nim.
SentenceSentiment	Tonacja zdań dokumentu.
SentenceSentimentValue	Przewidywana tonacja dla zdania.
SentenceTarget	Reprezentuje element docelowy zdania i powiązane z nim oceny lub obiekty docelowe.
SentimentAnalysisTaskParameters	Obsługiwane parametry zadania Analiza tonacji.
SentimentConfidenceScores	Reprezentuje wyniki ufności z zakresu od 0 do 1 we wszystkich klasach tonacji: dodatnie, neutralne, ujemne.
SentimentDocumentResult	Obiekt reprezentujący wstępnie utworzone wyniki analizy tonacji każdego dokumentu.
SentimentResponse	Wyniki analizy tonacji dla dokumentów wejściowych.
SentimentTaskResult	Zawiera wynik zadania analizy SentimentAnalysis LRO.
StringIndexType	Typ indeksu ciągu
TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
TargetRelation	Reprezentuje relację między ocenami i/lub elementami docelowymi.
TargetRelationType	Typ powiązany z obiektem docelowym.
TokenSentimentValue	Przewidywana tonacja dla zdania.
WarningCodeValue	Definiuje listę kodów ostrzegawczych.

AnalyzeTextEntityLinkingInput

Zawiera tekst analizowania danych wejściowych łączenia jednostek.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dane wejściowe analizy, które mają być obsługiwane przez usługę.
kind	string: EntityLinking	Rodzaj zadania do wykonania.
parameters	EntityLinkingTaskParameters	Parametry zadania.

AnalyzeTextEntityRecognitionInput

Rozpoznawanie jednostki analizuje żądanie zadania wprowadzania tekstu.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Dane wejściowe do przeanalizowania.
kind	string: EntityRecognition	Rodzaj zadania do wykonania.
parameters	EntitiesTaskParameters	Parametry zadania.

AnalyzeTextKeyPhraseExtractionInput

Zawiera tekst wejściowy zadania analizy KeyPhraseExtraction.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: KeyPhraseExtraction	Rodzaj zadania do wykonania.
parameters	KeyPhraseTaskParameters	Parametry zadania wyodrębniania kluczowych fraz.

AnalyzeTextLanguageDetectionInput

Zawiera dane wejściowe zadania analizy dokumentów wykrywania języka.

Nazwa	Typ	Opis
analysisInput	LanguageDetectionAnalysisInput	Dokumenty do przeanalizowania.
kind	string: LanguageDetection	Rodzaj zadania do wykonania.
parameters	LanguageDetectionTaskParameters	parametry zadania.

AnalyzeTextPiiEntitiesRecognitionInput

Zawiera dane wejściowe zadania analizy PIIEntityRecognition.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: PiiEntityRecognition	Rodzaj zadania do wykonania.
parameters	PiiTaskParameters	Parametry zadania pii.

AnalyzeTextSentimentAnalysisInput

Zawiera dane wejściowe zadania analyze SentimentAnalysis.

Nazwa	Typ	Opis
analysisInput	MultiLanguageAnalysisInput	Zawiera dokumenty wejściowe.
kind	string: SentimentAnalysis	Rodzaj zadania do wykonania.
parameters	SentimentAnalysisTaskParameters	Parametry zadania Analiza tonacji.

AnalyzeTextTaskKind

Rodzaj obsługiwanych zadań analizy tekstu.

Nazwa	Typ	Opis
EntityLinking	string	Zadanie łączenia jednostek
EntityRecognition	string	Zadanie rozpoznawania jednostek
KeyPhraseExtraction	string	Zadanie wyodrębniania kluczowych fraz
LanguageDetection	string	Zadanie wykrywania języka
PiiEntityRecognition	string	Zadanie rozpoznawania jednostek PII
SentimentAnalysis	string	Zadanie analizy tonacji

AnalyzeTextTaskResultsKind

Rodzaj obiektu odpowiedzi zwróconego przez zadanie analyze-text.

Nazwa	Typ	Opis
EntityLinkingResults	string	Wyniki łączenia jednostek
EntityRecognitionResults	string	Wyniki rozpoznawania jednostek
KeyPhraseExtractionResults	string	Wyniki wyodrębniania kluczowych fraz
LanguageDetectionResults	string	Wyniki wykrywania języka
PiiEntityRecognitionResults	string	Wyniki rozpoznawania jednostek PII
SentimentAnalysisResults	string	Wyniki analizy tonacji

DetectedLanguage

Zawiera szczegóły wykrytego języka dla tekstu.

Nazwa	Typ	Opis
confidenceScore	number	Wskaźnik ufności z zakresu od 0 do 1. Wyniki zbliżone do 1 wskazują 100% pewności, że zidentyfikowany język jest prawdziwy.
iso6391Name	string	Dwuliterowa reprezentacja wykrytego języka zgodnie ze standardem ISO 639-1 (np. en, fr).
name	string	Długa nazwa wykrytego języka (np. angielski, francuski).

DocumentError

Zawiera szczegółowe informacje o błędach napotkanych podczas wykonywania zadania.

Nazwa	Typ	Opis
error	Error	Napotkano błąd.
id	string	Identyfikator dokumentu wejściowego.

DocumentSentimentValue

Przewidywana tonacja dokumentu (ujemna, neutralna, pozytywna lub mieszana).

Nazwa	Typ	Opis
mixed	string	Instrukcja mieszana
negative	string	Ujemna instrukcja
neutral	string	Neutralna instrukcja
positive	string	Pozytywna instrukcja

DocumentStatistics

jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.

Nazwa	Typ	Opis
charactersCount	integer	Liczba elementów tekstowych rozpoznanych w dokumencie.
transactionsCount	integer	Liczba transakcji dla dokumentu.

DocumentWarning

Zawiera obiekt ostrzeżeń z ostrzeżeniami napotkanymi dla przetworzonego dokumentu.

Nazwa	Typ	Opis
code	WarningCodeValue	Kod ostrzegawczy.
message	string	Komunikat ostrzegawczy.
targetRef	string	Odwołanie do wskaźnika JSON wskazujące obiekt docelowy.

EntitiesDocumentResult

Zawiera wynik zadania rozpoznawania jednostek dla dokumentu.

Nazwa	Typ	Opis
entities	Entity[]	Rozpoznane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

EntitiesResult

Zawiera wynik zadania rozpoznawania jednostek.

Nazwa	Typ	Opis
documents	EntitiesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

EntitiesTaskParameters

Obsługiwane parametry zadania rozpoznawania jednostek.

Nazwa	Typ	Wartość domyślna	Opis
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu
stringIndexType	StringIndexType	TextElements_v8	(Opcjonalnie) parametr umożliwiający podanie typu indeksu ciągu używanego do interpretowania przesunięć ciągów. Wartość domyślna to TextElements (Graphemes).

EntitiesTaskResult

Zawiera zadanie jednostki

Nazwa	Typ	Opis
kind	string: EntityRecognitionResults	Rodzaj wyniku zadania.
results	EntitiesResult	Wyniki rozpoznawania jednostek.

Entity

Definiuje wykryty obiekt jednostki zawierający wykrytą kategorię jednostki i wykryty tekst jednostki itp.

Nazwa	Typ	Opis
category	string	Typ jednostki.
confidenceScore	number	Wskaźnik ufności z zakresu od 0 do 1 wyodrębnionej jednostki.
length	integer	Długość tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwracaną długość.
offset	integer	Pozycja początkowa dla tekstu jednostki. Użycie różnych wartości "stringIndexType" może mieć wpływ na zwrócone przesunięcie.
subcategory	string	(Opcjonalnie) Typ podrzędny jednostki.
text	string	Tekst jednostki wyświetlany w żądaniu.

EntityLinkingResult

Wynik łączenia jednostek.

Nazwa	Typ	Opis
documents	LinkedEntitiesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

EntityLinkingTaskParameters

Obsługiwane parametry zadania Entity Linking.

Nazwa	Typ	Wartość domyślna	Opis
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu
stringIndexType	StringIndexType	TextElements_v8	Opcjonalny parametr umożliwiający podanie typu indeksu ciągu używanego do interpretowania przesunięć ciągów. Wartość domyślna to TextElements (Graphemes).

EntityLinkingTaskResult

Zawiera wynik zadania analizowania jednostek łączących jednostki.

Nazwa	Typ	Opis
kind	string: EntityLinkingResults	Rodzaj wyniku zadania.
results	EntityLinkingResult	Wynik łączenia jednostek.

Error

Obiekt odpowiedzi o błędzie zwrócony, gdy usługa napotka pewne błędy podczas przetwarzania żądania.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchIndexLimitReached	string	Błąd Azure Cognitive Search osiągnięto limit indeksu
AzureCognitiveSearchIndexNotFound	string	Błąd nie znaleziono indeksu Azure Cognitive Search
AzureCognitiveSearchNotFound	string	Azure Cognitive Search nie znaleziono błędu
AzureCognitiveSearchThrottling	string	błąd ograniczania przepustowości Azure Cognitive Search
Conflict	string	Błąd powodujący konflikt
Forbidden	string	Błąd dostępu zabronionego
InternalServerError	string	Wewnętrzny błąd serwera
InvalidArgument	string	Nieprawidłowy błąd argumentu
InvalidRequest	string	Błąd nieprawidłowego żądania
NotFound	string	Nie znaleziono błędu
OperationNotFound	string	Błąd nie znaleziono operacji
ProjectNotFound	string	Błąd nie znaleziono projektu
QuotaExceeded	string	Błąd przekroczenia limitu przydziału
ServiceUnavailable	string	Błąd niedostępności usługi
Timeout	string	Błąd przekroczenia limitu czasu
TooManyRequests	string	Błąd zbyt wielu żądań
Unauthorized	string	Błąd nieautoryzowanego dostępu
Warning	string	Błąd ostrzegawczy

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchNotFound	string	Azure Cognitive Search nie znaleziono błędu
AzureCognitiveSearchThrottling	string	błąd ograniczania przepustowości Azure Cognitive Search
EmptyRequest	string	Błąd pustego żądania
ExtractionFailure	string	Błąd wyodrębniania
InvalidCountryHint	string	Nieprawidłowy błąd wskazówki kraju
InvalidDocument	string	Nieprawidłowy błąd dokumentu
InvalidDocumentBatch	string	Nieprawidłowy błąd wsadowy dokumentu
InvalidParameterValue	string	Błąd nieprawidłowej wartości parametru
InvalidRequest	string	Błąd nieprawidłowego żądania
InvalidRequestBodyFormat	string	Błąd nieprawidłowego formatu treści żądania
KnowledgeBaseNotFound	string	Nie znaleziono błędu bazy wiedzy
MissingInputDocuments	string	Błąd brakujących dokumentów wejściowych
ModelVersionIncorrect	string	Nieprawidłowy błąd wersji modelu
UnsupportedLanguageCode	string	Nieobsługiwany błąd kodu języka

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

KeyPhraseResult

Zawiera wartość KeyPhraseResult.

Nazwa	Typ	Opis
documents	KeyPhrasesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

KeyPhrasesDocumentResult

Zawiera wyniki wyodrębniania kluczowych fraz dla dokumentu.

Nazwa	Typ	Opis
id	string	Unikatowy, niepusty identyfikator dokumentu.
keyPhrases	string[]	Lista reprezentatywnych słów lub fraz. Liczba zwracanych kluczowych fraz jest proporcjonalna do liczby wyrazów w dokumencie wejściowym.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

KeyPhraseTaskParameters

Obsługiwane parametry zadania wyodrębniania fraz kluczowych.

Nazwa	Typ	Wartość domyślna	Opis
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu

KeyPhraseTaskResult

Zawiera wynik zadania analizy KeyPhraseExtraction.

Nazwa	Typ	Opis
kind	string: KeyPhraseExtractionResults	Rodzaj wyniku zadania.
results	KeyPhraseResult	Lista wyników wyodrębniania fraz kluczowych

LanguageDetectionAnalysisInput

Zawiera dane wejściowe analizy dokumentów wykrywania języka.

Nazwa	Typ	Opis
documents	LanguageInput[]	Lista dokumentów do przeanalizowania.

LanguageDetectionDocumentResult

Zawiera wykrywanie języka dla dokumentu.

Nazwa	Typ	Opis
detectedLanguage	DetectedLanguage	Wykryty język.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

LanguageDetectionResult

Zawiera wynik wykrywania języka dla żądania.

Nazwa	Typ	Opis
documents	LanguageDetectionDocumentResult[]	Wyliczanie wyników wykrywania języka dla każdego dokumentu wejściowego.
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

LanguageDetectionTaskParameters

Obsługiwane parametry zadania wykrywania języka.

Nazwa	Typ	Wartość domyślna	Opis
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu

LanguageDetectionTaskResult

Zawiera wynik zadania wykrywania języka dla żądania.

Nazwa	Typ	Opis
kind	string: LanguageDetectionResults	Rodzaj wyniku zadania.
results	LanguageDetectionResult	Zawiera wyniki wykrywania języka.

LanguageInput

Zawiera dane wejściowe wykrywania języka.

Nazwa	Typ	Opis
countryHint	string	Wskazówka dotycząca kraju, która pomaga w wykrywaniu języka tekstu.
id	string	Unikatowy, niepusty identyfikator dokumentu.
text	string	Tekst wejściowy do przetworzenia.

LinkedEntitiesDocumentResult

Wynik dokumentu łączenia jednostek.

Nazwa	Typ	Opis
entities	LinkedEntity[]	Rozpoznano dobrze znane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

LinkedEntity

Obiekt LinkedEntity zawierający wykrytą jednostkę ze skojarzonymi źródłami/linkami.

Nazwa	Typ	Opis
bingId	string	Unikatowy identyfikator rozpoznanej jednostki interfejsu API wyszukiwania jednostek Bing.
dataSource	string	Źródło danych używane do wyodrębniania linków jednostek, takich jak wiki/Bing itp.
id	string	Unikatowy identyfikator rozpoznanej jednostki ze źródła danych.
language	string	Język używany w źródle danych.
matches	Match[]	Lista wystąpień tej jednostki jest wyświetlana w tekście.
name	string	Nazwa formalna łączenia jednostek.
url	string	Adres URL strony jednostki ze źródła danych.

Match

Obiekt Match zawierający wykryty tekst jednostki z przesunięciem i długością.

Nazwa	Typ	Opis
confidenceScore	number	Jeśli dobrze znany element zostanie rozpoznany, zostanie zwrócona liczba dziesiętna oznaczającą poziom ufności z zakresu od 0 do 1.
length	integer	Długość tekstu dopasowania jednostki.
offset	integer	Pozycja początkowa dla tekstu dopasowania jednostki.
text	string	Tekst jednostki wyświetlany w żądaniu.

MultiLanguageAnalysisInput

Kolekcja dokumentów wejściowych do przeanalizowania przez usługę.

Nazwa	Typ	Opis
documents	MultiLanguageInput[]	Dokumenty wejściowe do przeanalizowania.

MultiLanguageInput

Zawiera dokument wejściowy do analizy przez usługę.

Nazwa	Typ	Opis
id	string	Unikatowy, niepusty identyfikator dokumentu.
language	string	(Opcjonalnie) Jest to 2 litera ISO 639-1 reprezentacja języka. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego. (Poniżej dotyczy tylko wersji 2023-04-15-preview i nowszych) W przypadku wykrywania automatycznego języka użyj polecenia "auto". Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
text	string	Tekst wejściowy do przetworzenia.

PiiCategory

(Opcjonalnie) opisuje kategorie danych pii do zwrócenia

Nazwa	Typ	Opis
ABARoutingNumber	string	Numer routingu usługi ABA
ARNationalIdentityNumber	string	Numer tożsamości krajowej AR
ATIdentityCard	string	AT Identity Card
ATTaxIdentificationNumber	string	NUMER IDENTYFIKACYJNY PODATKU AT
ATValueAddedTaxNumber	string	Numer podatku od wartości dodanej AT
AUBankAccountNumber	string	AT Identity Card
AUBusinessNumber	string	Numer biznesowy jednostki organizacyjnej
AUCompanyNumber	string	Numer firmy jednostki organizacyjnej
AUDriversLicenseNumber	string	Numer licencji kierowcy AU
AUMedicalAccountNumber	string	Numer konta medycznego AU
AUPassportNumber	string	Numer paszportu jednostki organizacyjnej
AUTaxFileNumber	string	Numer pliku podatkowego jednostki organizacyjnej
Address	string	Adres
Age	string	Wiek
All	string	Wszystkie kategorie danych pii.
AzureDocumentDBAuthKey	string	Klucz uwierzytelniania usługi Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Połączenie z bazą danych Iaas platformy Azure i parametry SQL
AzureIoTConnectionString	string	Parametry połączenia usługi Azure IoT
AzurePublishSettingPassword	string	Hasło ustawienia publikowania platformy Azure
AzureRedisCacheString	string	Ciąg usługi Azure Redis Cache
AzureSAS	string	Sygnatura dostępu współdzielonego platformy
AzureServiceBusString	string	ciąg Azure Service Bus
AzureStorageAccountGeneric	string	Ogólne konto usługi Azure Storage
AzureStorageAccountKey	string	Klucz konta usługi Azure Storage
BENationalNumber	string	Numer krajowy BE
BENationalNumberV2	string	Numer krajowy BE V2
BEValueAddedTaxNumber	string	Numer podatku od wartości dodanej BE
BGUniformCivilNumber	string	BG Uniform Civil Number
BRCPFNumber	string	Numer CPF BR
BRLegalEntityNumber	string	Numer podmiotu prawnego BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Numer konta bankowego urzędu certyfikacji
CADriversLicenseNumber	string	Numer licencji kierowcy urzędu certyfikacji
CAHealthServiceNumber	string	Numer usługi kondycji urzędu certyfikacji
CAPassportNumber	string	Numer paszportu urzędu certyfikacji
CAPersonalHealthIdentification	string	Identyfikacja kondycji osobistej urzędu certyfikacji
CASocialInsuranceNumber	string	CA Numer ubezpieczenia społecznego
CHSocialSecurityNumber	string	Numer ubezpieczenia społecznego CH
CLIdentityCardNumber	string	Numer karty tożsamości CL
CNResidentIdentityCardNumber	string	Numer karty tożsamości rezydenta cn
CYIdentityCard	string	Karta tożsamości CY
CYTaxIdentificationNumber	string	Numer identyfikacyjny podatku CY
CZPersonalIdentityNumber	string	Osobisty numer tożsamości CZ
CZPersonalIdentityV2	string	CZ Personal Identity V2
CreditCardNumber	string	Numer karty kredytowej
DEDriversLicenseNumber	string	Numer licencji de kierowcy
DEIdentityCardNumber	string	DE Numer karty tożsamości
DEPassportNumber	string	Numer paszportu DE
DETaxIdentificationNumber	string	DE Tax Identification Number
DEValueAddedNumber	string	Liczba dodana wartości DE
DKPersonalIdentificationNumber	string	Osobisty numer identyfikacyjny klucza DK
DKPersonalIdentificationV2	string	Identyfikacja osobista klucza DK w wersji 2
Date	string	Date
Default	string	Domyślne kategorie danych pii dla języka.
DrugEnforcementAgencyNumber	string	Numer agencji egzekwowania narkotyków
EEPersonalIdentificationCode	string	Kod identyfikacji osobistej EE
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Numer ubezpieczenia społecznego ES
ESTaxIdentificationNumber	string	Numer identyfikacyjny podatku ES
EUDebitCardNumber	string	Numer karty debetowej UE
EUDriversLicenseNumber	string	Numer licencji kierowcy UE
EUGPSCoordinates	string	Współrzędne GPS UE
EUNationalIdentificationNumber	string	Krajowy numer identyfikacyjny UE
EUPassportNumber	string	Numer paszportu UE
EUSocialSecurityNumber	string	Numer ubezpieczenia społecznego UE
EUTaxIdentificationNumber	string	Numer identyfikacyjny podatku UE
Email	string	E-mail
FIEuropeanHealthNumber	string	Europejski numer kondycji FI
FINationalID	string	Identyfikator krajowy FI
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	Numer paszportu FI
FRDriversLicenseNumber	string	Numer licencji kierowcy FR
FRHealthInsuranceNumber	string	Numer ubezpieczenia zdrowotnego FR
FRNationalID	string	Identyfikator krajowy FR
FRPassportNumber	string	Numer paszportu FR
FRSocialSecurityNumber	string	FR Numer ubezpieczenia społecznego
FRTaxIdentificationNumber	string	Numer identyfikacyjny podatku FR
FRValueAddedTaxNumber	string	Numer podatku od wartości dodanej FR
GRNationalIDCard	string	GR National ID Card
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	GR Numer identyfikacyjny podatku
HKIdentityCardNumber	string	Numer karty tożsamości HK
HRIdentityCardNumber	string	Numer karty tożsamości działu kadr
HRNationalIDNumber	string	Numer identyfikatora krajowego HR
HRPersonalIdentificationNumber	string	Osobisty numer identyfikacyjny działu kadr
HRPersonalIdentificationOIBNumberV2	string	HR Personal Identification OIB Number V2
HUPersonalIdentificationNumber	string	Osobisty numer identyfikacyjny HU
HUTaxIdentificationNumber	string	Numer identyfikacyjny podatku HU
HUValueAddedNumber	string	Liczba dodana wartości HU
IDIdentityCardNumber	string	Numer karty tożsamości identyfikatora
IEPersonalPublicServiceNumber	string	Osobisty numer usługi publicznej programu IE
IEPersonalPublicServiceNumberV2	string	Osobisty numer usługi publicznej programu IE w wersji 2
ILBankAccountNumber	string	Numer konta bankowego IL
ILNationalID	string	Identyfikator narodowy IL
INPermanentAccount	string	W przypadku konta stałego
INUniqueIdentificationNumber	string	W unikatowym numerze identyfikacyjnym
IPAddress	string	Adres IP
ITDriversLicenseNumber	string	Numer licencji kierowcy IT
ITFiscalCode	string	Kod fiskalny IT
ITValueAddedTaxNumber	string	Numer podatku od wartości dodanej IT
InternationalBankingAccountNumber	string	Numer konta bankowego międzynarodowego
JPBankAccountNumber	string	Numer konta bankowego JP
JPDriversLicenseNumber	string	Numer licencji JP Driver
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Numer paszportu JP
JPResidenceCardNumber	string	Numer karty rezydencji JP
JPResidentRegistrationNumber	string	Numer rejestracji rezydenta JP
JPSocialInsuranceNumber	string	JP Numer ubezpieczenia społecznego
KRResidentRegistrationNumber	string	Numer rejestracji rezydenta kr
LTPersonalCode	string	LT Personal Code
LUNationalIdentificationNumberNatural	string	Krajowy numer identyfikacyjny LU Naturalny
LUNationalIdentificationNumberNonNatural	string	Krajowy numer identyfikacyjny LU inny niż naturalny
LVPersonalCode	string	LV Personal Code
MTIdentityCardNumber	string	Numer karty tożsamości MT
MTTaxIDNumber	string	Numer nip MT
MYIdentityCardNumber	string	Mój numer karty tożsamości
NLCitizensServiceNumber	string	Numer usługi nl citizens
NLCitizensServiceNumberV2	string	NL Citizens Service Number V2
NLTaxIdentificationNumber	string	Numer identyfikacyjny podatku NL
NLValueAddedTaxNumber	string	Numer podatku od wartości dodanej nl
NOIdentityNumber	string	BRAK numeru tożsamości
NZBankAccountNumber	string	Numer konta bankowego NZ
NZDriversLicenseNumber	string	Numer licencji kierowcy NZ
NZInlandRevenueNumber	string	Numer przychodu NZ w landzie
NZMinistryOfHealthNumber	string	NZ Ministerstwo Zdrowia
NZSocialWelfareNumber	string	Numer opieki społecznej NZ
Organization	string	Organizacja
PHUnifiedMultiPurposeIDNumber	string	PH Unified Multi Purpose ID Number
PLIdentityCard	string	Karta tożsamości PL
PLNationalID	string	Identyfikator krajowy PL
PLNationalIDV2	string	Identyfikator krajowy PL V2
PLPassportNumber	string	Numer paszportu PL
PLREGONNumber	string	Numer REGON PL
PLTaxIdentificationNumber	string	Numer identyfikacyjny podatku PL
PTCitizenCardNumber	string	Numer karty obywatela PT
PTCitizenCardNumberV2	string	Numer karty obywatela PT V2
PTTaxIdentificationNumber	string	Numer identyfikacyjny podatku PT
Person	string	Person (Osoba)
PhoneNumber	string	Numer telefonu
ROPersonalNumericalCode	string	Osobisty kod liczbowy RO
RUPassportNumberDomestic	string	Numer krajowy paszportu RU
RUPassportNumberInternational	string	Numer paszportu RU International
SANationalID	string	Identyfikator krajowy skojarzenia zabezpieczeń
SENationalID	string	Identyfikator krajowy SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Numer paszportu SE
SETaxIdentificationNumber	string	Numer identyfikacyjny podatku SE
SGNationalRegistrationIdentityCardNumber	string	Krajowy numer karty tożsamości rejestracji SG
SITaxIdentificationNumber	string	Numer identyfikacyjny podatku SI
SIUniqueMasterCitizenNumber	string	Unikatowy numer obywatela głównego si
SKPersonalNumber	string	Numer osobisty sk
SQLServerConnectionString	string	SQL Server parametry połączenia
SWIFTCode	string	Kod SWIFT
THPopulationIdentificationCode	string	Kod identyfikacji populacji TH
TRNationalIdentificationNumber	string	Krajowy numer identyfikacyjny TR
TWNationalID	string	Identyfikator krajowy TW
TWPassportNumber	string	Numer paszportu TW
TWResidentCertificate	string	Certyfikat rezydenta TW
UAPassportNumberDomestic	string	Numer paszportu UA Krajowy
UAPassportNumberInternational	string	Numer paszportu UA International
UKDriversLicenseNumber	string	Numer licencji kierowcy w Wielkiej Brytanii
UKElectoralRollNumber	string	Numer pakietu wyborczego w Wielkiej Brytanii
UKNationalHealthNumber	string	Numer zdrowia narodowego w Wielkiej Brytanii
UKNationalInsuranceNumber	string	Numer ubezpieczenia narodowego w Wielkiej Brytanii
UKUniqueTaxpayerNumber	string	Unikatowy numer podatnika w Wielkiej Brytanii
URL	string	Adres URL
USBankAccountNumber	string	Numer konta bankowego USA
USDriversLicenseNumber	string	Numer licencji kierowcy USA
USIndividualTaxpayerIdentification	string	Identyfikacja podatników indywidualnych w USA
USSocialSecurityNumber	string	US Social Security Number
USUKPassportNumber	string	US UK Passport Number
ZAIdentificationNumber	string	Numer identyfikacyjny ZA

PiiDomain

Domena dla zadania pii

Nazwa	Typ	Opis
none	string	Wskazuje, że nie określono żadnej domeny.
phi	string	Wskazuje, że jednostki w domenie informacji o kondycji osobistej powinny zostać zredagowane.

PiiEntitiesDocumentResult

Zawiera wyniki danych pii.

Nazwa	Typ	Opis
entities	Entity[]	Rozpoznane jednostki w dokumencie.
id	string	Unikatowy, niepusty identyfikator dokumentu.
redactedText	string	Zwraca tekst zredagowany.
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

PiiResult

Zawiera wartość PiiResult.

Nazwa	Typ	Opis
documents	PiiEntitiesDocumentResult[]	Odpowiedź według dokumentu
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

PiiTaskParameters

Obsługiwane parametry zadania rozpoznawania jednostek PII.

Nazwa	Typ	Wartość domyślna	Opis
domain	PiiDomain	none	Domena zadania piI
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu
piiCategories	PiiCategory[]		Wyliczenie kategorii danych pii, które mają być zwracane w odpowiedzi.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType, który ma być używany do analizy.

PiiTaskResult

Zawiera zadanie LRO analizy tekstu PIIEntityRecognition.

Nazwa	Typ	Opis
kind	string: PiiEntityRecognitionResults	Rodzaj wyniku zadania.
results	PiiResult	Lista wyników pii

RequestStatistics

jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

Nazwa	Typ	Opis
documentsCount	integer	Liczba dokumentów przesłanych w żądaniu.
erroneousDocumentsCount	integer	Liczba nieprawidłowych dokumentów. Obejmuje to puste, nadmierne rozmiary lub dokumenty nieobsługiwane w językach.
transactionsCount	integer	Liczba transakcji dla żądania.
validDocumentsCount	integer	Liczba prawidłowych dokumentów. Nie obejmuje to pustych, nadmiernych limitów rozmiaru lub dokumentów języków nieobsługiwanych.

SentenceAssessment

Reprezentuje ocenę zdania oraz oceny lub obiekty docelowe powiązane z nim.

Nazwa	Typ	Opis
confidenceScores	TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
isNegated	boolean	Wskaźnik reprezentujący, czy ocena jest negowana.
length	integer	Długość obiektu docelowego.
offset	integer	Przesunięcie docelowe od początku zdania.
sentiment	TokenSentimentValue	Tonacja zdania.
text	string	Wykryto tekst docelowy.

SentenceSentiment

Tonacja zdań dokumentu.

Nazwa	Typ	Opis
assessments	SentenceAssessment[]	Tablica ocen dla zdania.
confidenceScores	SentimentConfidenceScores	Wskaźnik ufności tonacji z zakresu od 0 do 1 dla zdania dla wszystkich klas.
length	integer	Długość obiektu docelowego.
offset	integer	Przesunięcie docelowe od początku zdania.
sentiment	SentenceSentimentValue	Przewidywana tonacja dla zdania.
targets	SentenceTarget[]	Tablica obiektów docelowych zdań dla zdania.
text	string	Tekst zdania.

SentenceSentimentValue

Przewidywana tonacja dla zdania.

Nazwa	Typ	Opis
negative	string	Negatywna tonacja
neutral	string	Neutralna tonacja
positive	string	Pozytywna tonacja

SentenceTarget

Reprezentuje element docelowy zdania i powiązane z nim oceny lub obiekty docelowe.

Nazwa	Typ	Opis
confidenceScores	TargetConfidenceScoreLabel	Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.
length	integer	Długość obiektu docelowego.
offset	integer	Przesunięcie docelowe od początku zdania.
relations	TargetRelation[]	Tablica obiektów oceny lub obiektów docelowych, które są powiązane z obiektem docelowym.
sentiment	TokenSentimentValue	Tonacja zdania.
text	string	Wykryto tekst docelowy.

SentimentAnalysisTaskParameters

Obsługiwane parametry zadania Analiza tonacji.

Nazwa	Typ	Wartość domyślna	Opis
loggingOptOut	boolean	False	Wylogowanie się z rezygnacji
modelVersion	string	latest	wersja modelu
opinionMining	boolean	False	Czy należy używać wyszukiwania opinii w żądaniu, czy nie.
stringIndexType	StringIndexType	TextElements_v8	Określa metodę używaną do interpretowania przesunięcia ciągów.

SentimentConfidenceScores

Reprezentuje wyniki ufności z zakresu od 0 do 1 we wszystkich klasach tonacji: dodatnie, neutralne, ujemne.

Nazwa	Typ	Opis
negative	number	Wskaźnik ufności dla negatywnej tonacji
neutral	number	Wskaźnik ufności dla neutralnej tonacji
positive	number	Wskaźnik ufności dla pozytywnej tonacji

SentimentDocumentResult

Obiekt reprezentujący wstępnie utworzone wyniki analizy tonacji każdego dokumentu.

Nazwa	Typ	Opis
confidenceScores	SentimentConfidenceScores	Wskaźnik ufności tonacji z zakresu od 0 do 1 dla zdania dla wszystkich klas.
id	string	Unikatowy, niepusty identyfikator dokumentu.
sentences	SentenceSentiment[]	Tonacja zdań dokumentu.
sentiment	DocumentSentimentValue	Przewidywana tonacja dokumentu (negatywna, neutralna, dodatnia lub mieszana).
statistics	DocumentStatistics	jeśli właściwość showStats=true została określona w żądaniu, to pole będzie zawierać informacje o ładunku dokumentu.
warnings	DocumentWarning[]	Napotkano ostrzeżenia podczas przetwarzania dokumentu.

SentimentResponse

Wyniki analizy tonacji dla dokumentów wejściowych.

Nazwa	Typ	Opis
documents	SentimentDocumentResult[]	Analiza tonacji daje wyniki dla każdego dokumentu w danych wejściowych.
errors	DocumentError[]	Błędy według identyfikatora dokumentu.
modelVersion	string	To pole wskazuje, który model jest używany do oceniania.
statistics	RequestStatistics	jeśli parametr showStats=true został określony w żądaniu, to pole będzie zawierać informacje o ładunku żądania.

SentimentTaskResult

Zawiera wynik zadania analizy SentimentAnalysis LRO.

Nazwa	Typ	Opis
kind	string: SentimentAnalysisResults	Rodzaj wyniku zadania.
results	SentimentResponse	Wyniki analizy tonacji

StringIndexType

Typ indeksu ciągu

Nazwa	Typ	Opis
TextElements_v8	string	Zwrócone wartości przesunięcia i długości będą odpowiadać elementom TextElements (klastrom Graphemes i Grapheme) potwierdzającym standard Unicode 8.0.0. Użyj tej opcji, jeśli aplikacja jest napisana w programie .Net Framework lub .Net Core i będziesz używać funkcji StringInfo.
UnicodeCodePoint	string	Zwrócone wartości przesunięcia i długości odpowiadają punktom kodu Unicode. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład w języku Python.
Utf16CodeUnit	string	Zwrócone wartości przesunięcia i długości będą odpowiadać jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

TargetConfidenceScoreLabel

Reprezentuje wyniki ufności we wszystkich klasach tonacji: dodatnich i ujemnych.

Nazwa	Typ	Opis
negative	number	Wskaźnik ufności dla negatywnej tonacji
positive	number	Wskaźnik ufności dla pozytywnej tonacji

TargetRelation

Reprezentuje relację między ocenami i/lub elementami docelowymi.

Nazwa	Typ	Opis
ref	string	Wskaźnik JSON wskazujący połączony obiekt.
relationType	TargetRelationType	Typ powiązany z obiektem docelowym.

TargetRelationType

Typ powiązany z obiektem docelowym.

Nazwa	Typ	Opis
assessment	string	Relacja oceny.
target	string	Relacja docelowa.

TokenSentimentValue

Przewidywana tonacja dla zdania.

Nazwa	Typ	Opis
mixed	string	Mieszane tonacje
negative	string	Negatywna tonacja
positive	string	Pozytywna tonacja

WarningCodeValue

Definiuje listę kodów ostrzegawczych.

Nazwa	Typ	Opis
DocumentTruncated	string	Ostrzeżenie o obciętym dokumencie
LongWordsInDocument	string	Długie wyrazy w ostrzeżeniu dokumentu