Text Analysis Runtime - Analyze Text

Служба:

Azure AI Services

Версия API:

2024-11-01

Запрос анализа текста по коллекции документов.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Версия API, используемая для этой операции.
showStats	query		boolean	(Необязательно) если задано значение true, ответ будет содержать статистику уровня запросов и документов.

Текст запроса

Текст запроса может быть таким:

Имя	Описание
AnalyzeTextEntityLinkingInput	Содержит входные данные для связывания текстовых сущностей.
AnalyzeTextEntityRecognitionInput	Распознавание сущностей анализирует запрос задачи ввода текста.
AnalyzeTextKeyPhraseExtractionInput	Содержит входные данные задачи анализа текста KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Содержит входные данные задачи анализа документов обнаружения языка.
AnalyzeTextPiiEntitiesRecognitionInput	Содержит входные данные задачи анализа текста PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Содержит входные данные задачи анализа текста SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Содержит входные данные для связывания текстовых сущностей.

Имя	Обязательно	Тип	Описание
kind	True	string: EntityLinking	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные данные анализа, обрабатываемые службой.
parameters		EntityLinkingTaskParameters	Параметры задачи.

AnalyzeTextEntityRecognitionInput

Распознавание сущностей анализирует запрос задачи ввода текста.

Имя	Обязательно	Тип	Описание
kind	True	string: EntityRecognition	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Входные данные, которые необходимо проанализировать.
parameters		EntitiesTaskParameters	Параметры задачи.

AnalyzeTextKeyPhraseExtractionInput

Содержит входные данные задачи анализа текста KeyPhraseExtraction.

Имя	Обязательно	Тип	Описание
kind	True	string: KeyPhraseExtraction	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		KeyPhraseTaskParameters	Параметры задачи извлечения ключевых фраз.

AnalyzeTextLanguageDetectionInput

Содержит входные данные задачи анализа документов обнаружения языка.

Имя	Обязательно	Тип	Описание
kind	True	string: LanguageDetection	Тип выполняемой задачи.
analysisInput		LanguageDetectionAnalysisInput	Документы для анализа.
parameters		LanguageDetectionTaskParameters	Параметры задачи.

AnalyzeTextPiiEntitiesRecognitionInput

Содержит входные данные задачи анализа текста PIIEntityRecognition.

Имя	Обязательно	Тип	Описание
kind	True	string: PiiEntityRecognition	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		PiiTaskParameters	Параметры задачи Pii.

AnalyzeTextSentimentAnalysisInput

Содержит входные данные задачи анализа текста SentimentAnalysis.

Имя	Обязательно	Тип	Описание
kind	True	string: SentimentAnalysis	Тип выполняемой задачи.
analysisInput		MultiLanguageAnalysisInput	Содержит входные документы.
parameters		SentimentAnalysisTaskParameters	Параметры задачи анализа тональности.

Ответы

Имя	Тип	Описание
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	Запрос выполнен успешно.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

200

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

SuccessfulEntityRecognitionExclusionRequest

Образец запроса

HTTP

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Пример ответа

Код состояния:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Образец запроса

HTTP

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Пример ответа

Код состояния:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Образец запроса

HTTP

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Пример ответа

Код состояния:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Образец запроса

HTTP

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Пример ответа

Код состояния:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Образец запроса

HTTP

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

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Пример ответа

Код состояния:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

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

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

200

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

SuccessfulPiiEntityRecognitionRequest

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

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

Образец запроса

HTTP

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

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AgeMetadata	Представляет модель метаданных сущности age.
AgeUnit	Единица измерения возраста
AllowOverlapEntityPolicyType	Представляет политику перекрытия разрешений. Не будет применяться логика последующей обработки для сущностей. Что бы ни предсказывала модель, то, что будет возвращено пользователю. Это позволяет пользователю получить полное представление возможных значений каждой модели и применить собственную пользовательскую логику к выбору сущностей.
AnalyzeTextEntityLinkingInput	Содержит входные данные для связывания текстовых сущностей.
AnalyzeTextEntityRecognitionInput	Распознавание сущностей анализирует запрос задачи ввода текста.
AnalyzeTextKeyPhraseExtractionInput	Содержит входные данные задачи анализа текста KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Содержит входные данные задачи анализа документов обнаружения языка.
AnalyzeTextPiiEntitiesRecognitionInput	Содержит входные данные задачи анализа текста PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Содержит входные данные задачи анализа текста SentimentAnalysis.
AnalyzeTextTaskKind	Тип поддерживаемых задач анализа текста.
AnalyzeTextTaskResultsKind	Тип объекта ответа, возвращаемого задачей анализа текста.
AreaMetadata	Представляет модель метаданных сущности области.
AreaUnit	Единица измерения области.
CurrencyMetadata	Представляет модель метаданных сущности "Валюта").
DateMetadata	Метаданные для экземпляров сущностей даты.
DateTimeMetadata	Метаданные для экземпляров сущностей datetime.
DateValue	Представляет значение даты.
DetectedLanguage	Содержит сведения об обнаружении языка для текста.
DocumentError	Содержит сведения об ошибках, возникающих во время выполнения задания.
DocumentSentimentValue	Прогнозируемые тональности для документа (отрицательные, нейтральные, положительные или смешанные).
DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
DocumentWarning	Содержит объект предупреждений с предупреждениями, найденными для обработанного документа.
EntitiesDocumentResultWithMetadata	Документы сущностей приводят к метаданным.
EntitiesResult	Содержит результат задачи распознавания сущностей.
EntitiesTaskParameters	Поддерживаемые параметры для задачи распознавания сущностей.
EntitiesTaskResult	Содержит задачу сущности
Entity	Определяет обнаруженный объект сущности, содержащий категорию сущностей и обнаруженный текст сущности и т. д.
EntityCategory	Содержит все категории сущностей, обнаруженные распознаванием сущностей.
EntityInferenceOptions	Класс, в котором размещаются параметры вывода, разрешенные для распознавания именованных сущностей.
EntityLinkingResult	Результат связывания сущностей.
EntityLinkingTaskParameters	Поддерживаемые параметры для задачи "Связывание сущностей".
EntityLinkingTaskResult	Содержит результат задачи связывания текстовых сущностей.
EntityTag	Объект тега сущности, содержащий имя тегов в любом связанном показателе достоверности. Теги сущностей используются для выражения некоторых сходств и сходства между сущностями.
EntityWithMetadata	Объект сущности с тегами и метаданными.
Error	Объект ответа об ошибке, возвращаемый при возникновении некоторых ошибок при обработке запроса.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InformationMetadata	Представляет модель метаданных сущности Information (data).
InformationUnit	Единица измерения сведений (данных).
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KeyPhraseResult	Содержит keyPhraseResult.
KeyPhrasesDocumentResult	Содержит результаты извлечения ключевых фраз для документа.
KeyPhraseTaskParameters	Поддерживаемые параметры для задачи извлечения ключевых фраз.
KeyPhraseTaskResult	Содержит результат задачи анализа текста KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Содержит входные данные анализа документов обнаружения языка.
LanguageDetectionDocumentResult	Содержит обнаружение языка для документа.
LanguageDetectionResult	Содержит результат обнаружения языка для запроса.
LanguageDetectionTaskParameters	Поддерживаемые параметры для задачи распознавания языка.
LanguageDetectionTaskResult	Содержит результат задачи обнаружения языка для запроса.
LanguageInput	Содержит входные данные обнаружения языка.
LengthMetadata	Представляет модель метаданных сущности Length.
LengthUnit	Единица измерения длины.
LinkedEntitiesDocumentResult	Результат связывания сущностей.
LinkedEntity	Объект LinkedEntity, содержащий обнаруженную сущность с соответствующими источниками или ссылками.
Match	Объект Match, содержащий обнаруженный текст сущности со смещением и длиной.
MatchLongestEntityPolicyType	Представляет политику сопоставления с самым длинным перекрытием. Никакие перекрывающиеся сущности насколько это возможно. 1. Если есть перекрывающиеся сущности, будет возвращен самый длинный. 2. Если набор символов, прогнозируемых для 2 или более сущностей, точно совпадает, выберите сущность, которая имеет более высокую оценку достоверности.3. Если оценки сущностей идентичны, верните все сущности, которые по-прежнему присутствуют после применения предыдущих правил. 3. Если существует частичное перекрытие (как и в Hello Text Analytics), выполните описанные выше действия, начиная с 1.
MetadataKind	Тип объекта метаданных сущности.
MultiLanguageAnalysisInput	Коллекция входных документов для анализа службой.
MultiLanguageInput	Содержит входной документ, который будет анализироваться службой.
NumberKind	Тип извлеченной сущности номера.
NumberMetadata	Метаданные для числовых экземпляров сущностей.
NumericRangeMetadata	представляет метаданные числовых интервалов.
OrdinalMetadata	Метаданные для числовых экземпляров сущностей.
PiiCategory	(Необязательно) описывает категории piI для возврата
PiiDomain	Задача "Домен для piI"
PiiEntitiesDocumentResult	Содержит результаты piI.
PiiResult	Содержит PiiResult.
PiiTaskParameters	Поддерживаемые параметры для задачи распознавания сущностей PII.
PiiTaskResult	Содержит задачу LRO анализа текста PIIEntityRecognition LRO.
RangeInclusivity	Диапазон инклюзивности этого свойства.
RangeKind	Тип сущности диапазона чисел.
RelativeTo	Эталонная точка, обозначающая порядковый номер.
RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.
ScriptCode	Определяет скрипт входного документа. Сопоставляется со стандартным кодом скрипта ISO 15924.
ScriptKind	Определяет скрипт входного документа. Сопоставляется со стандартным формальным именем ISO 15924.
SentenceAssessment	Представляет оценку предложения и оценки или целевые объекты, связанные с ним.
SentenceSentiment	Тональность предложения документа.
SentenceSentimentValue	Прогнозируемое тональность предложения.
SentenceTarget	Представляет целевой объект предложения и оценки или целевые объекты, связанные с ним.
SentimentAnalysisTaskParameters	Поддерживаемые параметры для задачи анализа тональности.
SentimentConfidenceScores	Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.
SentimentDocumentResult	Объект, представляющий предварительно созданные результаты анализа тональности каждого документа.
SentimentResponse	Результаты анализа тональности для входных документов.
SentimentTaskResult	Содержит результат задачи анализа text SentimentAnalysis LRO.
SpeedMetadata	Представляет модель метаданных сущности Speed.
SpeedUnit	Единица измерения скорости
StringIndexType	Тип строкового индекса
TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
TargetRelation	Представляет отношение между оценками и /или целевыми объектами.
TargetRelationType	Тип, связанный с целевым объектом.
TemperatureMetadata	Представляет модель метаданных сущности Information.
TemperatureUnit	Единица измерения температуры.
TemporalModifier	Необязательный модификатор экземпляра даты и времени.
TemporalSetMetadata	Метаданные для экземпляров сущностей темпорального набора.
TemporalSpanMetadata	представляет метаданные даты и (или) интервала времени.
TemporalSpanValues	Объект темпорального диапазона.
TimeMetadata	Метаданные для экземпляров сущностей времени.
TokenSentimentValue	Прогнозируемое тональность предложения.
VolumeMetadata	Представляет модель метаданных сущности тома.
VolumeUnit	Единица измерения тома
WarningCodeValue	Определяет список кодов предупреждений.
WeightMetadata	Представляет модель метаданных сущности Weight ) .
WeightUnit	Единица измерения веса.

AgeMetadata

Представляет модель метаданных сущности age.

Имя	Тип	Описание
metadataKind	string: AgeMetadata	Тип объекта метаданных сущности.
unit	AgeUnit	Единица измерения для возраста.
value	number	Числовое значение, которое обозначает извлеченный текст.

AgeUnit

Единица измерения возраста

Имя	Тип	Описание
Day	string	Период времени в день
Month	string	Период времени месяца
Unspecified	string	Неопределенный период времени
Week	string	Период времени недели
Year	string	Период времени года

AllowOverlapEntityPolicyType

Представляет политику перекрытия разрешений. Не будет применяться логика последующей обработки для сущностей. Что бы ни предсказывала модель, то, что будет возвращено пользователю. Это позволяет пользователю получить полное представление возможных значений каждой модели и применить собственную пользовательскую логику к выбору сущностей.

Имя	Тип	Default value	Описание
policyKind	string: allowOverlap	matchLongest	Тип объекта OverlapPolicy.

AnalyzeTextEntityLinkingInput

Содержит входные данные для связывания текстовых сущностей.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные данные анализа, обрабатываемые службой.
kind	string: EntityLinking	Тип выполняемой задачи.
parameters	EntityLinkingTaskParameters	Параметры задачи.

AnalyzeTextEntityRecognitionInput

Распознавание сущностей анализирует запрос задачи ввода текста.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Входные данные, которые необходимо проанализировать.
kind	string: EntityRecognition	Тип выполняемой задачи.
parameters	EntitiesTaskParameters	Параметры задачи.

AnalyzeTextKeyPhraseExtractionInput

Содержит входные данные задачи анализа текста KeyPhraseExtraction.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: KeyPhraseExtraction	Тип выполняемой задачи.
parameters	KeyPhraseTaskParameters	Параметры задачи извлечения ключевых фраз.

AnalyzeTextLanguageDetectionInput

Содержит входные данные задачи анализа документов обнаружения языка.

Имя	Тип	Описание
analysisInput	LanguageDetectionAnalysisInput	Документы для анализа.
kind	string: LanguageDetection	Тип выполняемой задачи.
parameters	LanguageDetectionTaskParameters	Параметры задачи.

AnalyzeTextPiiEntitiesRecognitionInput

Содержит входные данные задачи анализа текста PIIEntityRecognition.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: PiiEntityRecognition	Тип выполняемой задачи.
parameters	PiiTaskParameters	Параметры задачи Pii.

AnalyzeTextSentimentAnalysisInput

Содержит входные данные задачи анализа текста SentimentAnalysis.

Имя	Тип	Описание
analysisInput	MultiLanguageAnalysisInput	Содержит входные документы.
kind	string: SentimentAnalysis	Тип выполняемой задачи.
parameters	SentimentAnalysisTaskParameters	Параметры задачи анализа тональности.

AnalyzeTextTaskKind

Тип поддерживаемых задач анализа текста.

Имя	Тип	Описание
EntityLinking	string	Задача связывания сущностей
EntityRecognition	string	Задача распознавания сущностей
KeyPhraseExtraction	string	Задача извлечения ключевых фраз
LanguageDetection	string	Задача обнаружения языка
PiiEntityRecognition	string	Задача распознавания сущностей PII
SentimentAnalysis	string	Задача анализа тональности

AnalyzeTextTaskResultsKind

Тип объекта ответа, возвращаемого задачей анализа текста.

Имя	Тип	Описание
EntityLinkingResults	string	Результаты связывания сущностей
EntityRecognitionResults	string	Результаты распознавания сущностей
KeyPhraseExtractionResults	string	Результаты извлечения ключевых фраз
LanguageDetectionResults	string	Результаты обнаружения языка
PiiEntityRecognitionResults	string	Результаты распознавания сущностей PII
SentimentAnalysisResults	string	Результаты анализа тональности

AreaMetadata

Представляет модель метаданных сущности области.

Имя	Тип	Описание
metadataKind	string: AreaMetadata	Тип объекта метаданных сущности.
unit	AreaUnit	Единица измерения для области.
value	number	Числовое значение, которое обозначает извлеченный текст.

AreaUnit

Единица измерения области.

Имя	Тип	Описание
Acre	string	Единица области в акров
SquareCentimeter	string	Единица области в квадратных сантиметрах
SquareDecameter	string	Единица области в квадратных декаметрах
SquareDecimeter	string	Единица области в квадратных дециметрах
SquareFoot	string	Единица площади в квадратных футах
SquareHectometer	string	Единица области в квадратных гектометрах
SquareInch	string	Единица области в квадратных дюймах
SquareKilometer	string	Единица площади в квадратных километрах
SquareMeter	string	Единица площади в квадратных метрах
SquareMile	string	Единица площади в квадратных милях
SquareMillimeter	string	Единица площади в квадратных миллиметрах
SquareYard	string	Единица площади в квадратных ярдах
Unspecified	string	Единица неопределенной области

CurrencyMetadata

Представляет модель метаданных сущности "Валюта").

Имя	Тип	Описание
iso4217	string	Алфавитный код на основе другого стандарта ISO, ISO 3166, который содержит коды для имен стран. Первые две буквы кода ISO 4217 с тремя буквами совпадают с кодом для имени страны, и, по возможности, третья буква соответствует первой букве имени валюты.
metadataKind	string: CurrencyMetadata	Тип объекта метаданных сущности.
unit	string	Единица валюты.
value	number	Числовое значение, которое обозначает извлеченный текст.

DateMetadata

Метаданные для экземпляров сущностей даты.

Имя	Тип	Описание
dateValues	DateValue[]	Список значений даты.
metadataKind	string: DateMetadata	Тип объекта метаданных сущности.

DateTimeMetadata

Метаданные для экземпляров сущностей datetime.

Имя	Тип	Описание
dateValues	DateValue[]	Список значений даты.
metadataKind	string: DateTimeMetadata	Тип объекта метаданных сущности.

DateValue

Представляет значение даты.

Имя	Тип	Описание
modifier	TemporalModifier	Модификатор даты и времени, указывающий точку ссылки, как раньше, после и т. д.
timex	string	Расширенное представление даты и времени ISO 8601, как описано в (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Фактическое время, обозначаемое извлеченным текстом.

DetectedLanguage

Содержит сведения об обнаружении языка для текста.

Имя	Тип	Описание
confidenceScore	number	Оценка достоверности от 0 до 1. Оценки, близкие к 1, указывают на 100% уверенность в том, что идентифицированный язык имеет значение true.
iso6391Name	string	Двухбуквенный представление обнаруженного языка в соответствии со стандартом ISO 639-1 (например, en, fr).
name	string	Длинное имя обнаруженного языка (например, английский, французский).
scriptIso15924Code	ScriptCode	Определяет код скрипта входного документа в соответствии со стандартом ISO 15924.
scriptName	ScriptKind	Определяет имя скрипта входного документа в соответствии со стандартом ISO 15924.

DocumentError

Содержит сведения об ошибках, возникающих во время выполнения задания.

Имя	Тип	Описание
error	Error	Ошибка.
id	string	Идентификатор входного документа.

DocumentSentimentValue

Прогнозируемые тональности для документа (отрицательные, нейтральные, положительные или смешанные).

Имя	Тип	Описание
mixed	string	Смешанная инструкция
negative	string	Отрицательный оператор
neutral	string	Нейтральная инструкция
positive	string	Положительное утверждение

DocumentStatistics

Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.

Имя	Тип	Описание
charactersCount	integer	Количество текстовых элементов, распознанных в документе.
transactionsCount	integer	Количество транзакций для документа.

DocumentWarning

Содержит объект предупреждений с предупреждениями, найденными для обработанного документа.

Имя	Тип	Описание
code	WarningCodeValue	Код предупреждения.
message	string	Предупреждение.
targetRef	string	Ссылка указателя JSON, указывающая целевой объект.

EntitiesDocumentResultWithMetadata

Документы сущностей приводят к метаданным.

Имя	Тип	Описание
entities	EntityWithMetadata[]	Распознанные сущности в документе.
id	string	Уникальный, непустый идентификатор документа.
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

EntitiesResult

Содержит результат задачи распознавания сущностей.

Имя	Тип	Описание
documents	EntitiesDocumentResultWithMetadata[]	Ответ по документу
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

EntitiesTaskParameters

Поддерживаемые параметры для задачи распознавания сущностей.

Имя	Тип	Default value	Описание
exclusionList	EntityCategory[]		(Необязательно) параметр запроса, который фильтрует все сущности, включенные в список исключений. Если пользователь задает список исключений, он не может получить прогноз, возвращенный сущностью в этом списке. Мы применим список включения перед списком исключений
inclusionList	EntityCategory[]		(Необязательно) параметр запроса, ограничивающий выходные данные запрошенным типам сущностей, включенным в этот список. Мы применим список включения перед списком исключений
inferenceOptions	EntityInferenceOptions		(Необязательно) параметр запроса, позволяющий пользователю предоставлять параметры для выполнения вывода.
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Необязательно) описывает тип политики перекрытия для применения к выходным данным ner.
stringIndexType	StringIndexType	TextElements_v8	Параметр (необязательно) для указания типа индекса строки, используемого для интерпретации смещения строк. По умолчанию используется TextElements (Graphemes).

EntitiesTaskResult

Содержит задачу сущности

Имя	Тип	Описание
kind	string: EntityRecognitionResults	Тип результата задачи.
results	EntitiesResult	Результаты распознавания сущностей.

Entity

Определяет обнаруженный объект сущности, содержащий категорию сущностей и обнаруженный текст сущности и т. д.

Имя	Тип	Описание
category	string	Тип сущности.
confidenceScore	number	Оценка достоверности от 0 до 1 извлеченной сущности.
length	integer	Длина текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемую длину.
offset	integer	Начальная позиция для текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.
subcategory	string	(Необязательно) Подтип сущности.
text	string	Текст сущности, как показано в запросе.

EntityCategory

Содержит все категории сущностей, обнаруженные распознаванием сущностей.

Имя	Тип	Описание
Address	string	Конкретные упоминания на уровне улицы: номера дома и здания, улицы, авеню, шоссе, пересечения, на которые ссылается имя.
Age	string	Значения, связанные с возрастом.
Airport	string	Аэропорты.
Area	string	Область объекта.
City	string	Значения, связанные с городом.
ComputingProduct	string	Вычислительные продукты.
Continent	string	Значения, связанные с континентом.
CountryRegion	string	Значения, связанные с страной или регионом.
CulturalEvent	string	Культурные значения, связанные с событиями.
Currency	string	Значения, связанные с валютой.
Date	string	Даты календаря.
DateRange	string	Диапазон дат.
DateTime	string	Даты календаря с временем.
DateTimeRange	string	Диапазон даты и времени.
Dimension	string	Измерение измерений
Duration	string	Длительность времени.
Email	string	Адреса электронной почты.
Event	string	Социальные, спортивные, деловые, политические, образовательные, естественные, исторические, преступные, насильственные, юридические, военные события с периодом времени.
GPE	string	Города, страны и регионы, государства.
Geological	string	Географические и естественные особенности, такие как реки, океаны и пустыни.
Height	string	Высота объекта.
IP	string	сетевые IP-адреса.
Information	string	Единица измерения цифровой информации.
Length	string	Длина объекта.
Location	string	Конкретная точка или место в физическом пространстве.
NaturalEvent	string	Естественные значения, связанные с событиями.
Number	string	Числа без единицы
NumberRange	string	Диапазон чисел
Numeric	string	Числовые значения, включая цифры и числовые слова.
Ordinal	string	Порядковые номера.
Organization	string	Корпорации, учреждения и другие группы людей, определенные определенной определенной организационной структурой. Эти метки могут включать компании, политические партии и движения, музыкальные группы, спортивные клубы, правительственные органы и общественные организации. Национальности или религии не являются ОРГАНИЗАЦИЕЙ.
OrganizationMedical	string	Медицинские компании и группы.
OrganizationSports	string	Спортивные организации.
OrganizationStockExchange	string	Фондовые биржи группы.
Percentage	string	Процентные значения.
Person	string	Во-первых, последних и средних имен, имена вымышленных символов и псевдонимов. Названия, такие как "г-н". или "Президент", не считаются частью именованной сущности.
PersonType	string	Роли человека, классифицируемые членством в группе.
PhoneNumber	string	Номера телефонов (только для США и ЕС).
Product	string	Один или группа коммерческих, потребляемых объектов, электроники, транспортных средств, групп продовольствия.
SetTemporal	string	Набор значений, связанных с временем.
Skill	string	Возможность, навык или опыт.
Speed	string	Скорость объекта.
SportsEvent	string	Спортивные значения, связанные с событиями.
State	string	Значения, связанные с состоянием.
Structural	string	Искусственные структуры.
Temperature	string	Значения, связанные с температурой.
Temporal	string	Элементы, относящиеся к времени.
Time	string	Время дня.
TimeRange	string	Диапазон времени.
URL	string	URL-адреса веб-сайтов.
Volume	string	Том объекта.
Weight	string	Вес объекта.

EntityInferenceOptions

Класс, в котором размещаются параметры вывода, разрешенные для распознавания именованных сущностей.

Имя	Тип	Default value	Описание
excludeNormalizedValues	boolean	False	Параметр включения и исключения обнаруженных значений сущностей для нормализации и включения в метаданные. Числовые и темпоральные типы сущностей поддерживают нормализацию значений.

EntityLinkingResult

Результат связывания сущностей.

Имя	Тип	Описание
documents	LinkedEntitiesDocumentResult[]	Ответ по документу
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

EntityLinkingTaskParameters

Поддерживаемые параметры для задачи "Связывание сущностей".

Имя	Тип	Default value	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
stringIndexType	StringIndexType	TextElements_v8	Необязательный параметр для указания типа индекса строки, используемого для интерпретации смещения строк. По умолчанию используется TextElements (Graphemes).

EntityLinkingTaskResult

Содержит результат задачи связывания текстовых сущностей.

Имя	Тип	Описание
kind	string: EntityLinkingResults	Тип результата задачи.
results	EntityLinkingResult	Результат связывания сущностей.

EntityTag

Объект тега сущности, содержащий имя тегов в любом связанном показателе достоверности. Теги сущностей используются для выражения некоторых сходств и сходства между сущностями.

Имя	Тип	Описание
confidenceScore	number	Оценка обнаружения от 0 до 1 извлеченной сущности.
name	string	Имя тега. Имена тегов сущностей будут уникальными глобально.

EntityWithMetadata

Объект сущности с тегами и метаданными.

Имя	Тип	Описание
category	string	Тип сущности.
confidenceScore	number	Оценка достоверности от 0 до 1 извлеченной сущности.
length	integer	Длина текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемую длину.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	Объект метаданных сущности.
offset	integer	Начальная позиция для текста сущности. Использование различных значений stringIndexType может повлиять на возвращаемое смещение.
subcategory	string	(Необязательно) Подтип сущности.
tags	EntityTag[]	Список тегов сущностей. Теги предназначены для выражения некоторых сходств и сходства между сущностями.
text	string	Текст сущности, как показано в запросе.
type	string	Тип сущности — это самая низкая (или лучшая) степень детализации, при которой обнаружена сущность. Тип сопоставляется с определенными атрибутами метаданных, связанными с обнаруженной сущностью.

Error

Объект ответа об ошибке, возвращаемый при возникновении некоторых ошибок при обработке запроса.

Имя	Тип	Описание
code	ErrorCode	Один из определяемых сервером кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string	Достигнуто ограничение индекса Когнитивного поиска Azure
AzureCognitiveSearchIndexNotFound	string	Индекс Когнитивного поиска Azure не найден ошибкой
AzureCognitiveSearchNotFound	string	Ошибка "Когнитивный поиск Azure" не найдена
AzureCognitiveSearchThrottling	string	Ошибка регулирования когнитивного поиска Azure
Conflict	string	Ошибка конфликта
Forbidden	string	Ошибка запрещенного доступа
InternalServerError	string	Внутренняя ошибка сервера
InvalidArgument	string	Недопустимая ошибка аргумента
InvalidRequest	string	Недопустимая ошибка запроса
NotFound	string	Ошибка не найдена
OperationNotFound	string	Ошибка операции не найдена
ProjectNotFound	string	Ошибка проекта не найдена
QuotaExceeded	string	Ошибка превышения квоты
ServiceUnavailable	string	Ошибка недоступности службы
Timeout	string	Ошибка времени ожидания
TooManyRequests	string	Ошибка слишком большого количества запросов
Unauthorized	string	Ошибка несанкционированного доступа
Warning	string	Предупреждение об ошибке

ErrorResponse

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InformationMetadata

Представляет модель метаданных сущности Information (data).

Имя	Тип	Описание
metadataKind	string: InformationMetadata	Тип объекта метаданных сущности.
unit	InformationUnit	Единица измерения сведений.
value	number	Числовое значение, которое обозначает извлеченный текст.

InformationUnit

Единица измерения сведений (данных).

Имя	Тип	Описание
Bit	string	Единица размера данных в битах
Byte	string	Единица размера данных в байтах
Gigabit	string	Единица размера данных в гигабитах
Gigabyte	string	Единица размера данных в гигабайтах
Kilobit	string	Единица размера данных в килобитах
Kilobyte	string	Единица размера данных в килобайтах
Megabit	string	Единица размера данных в мегабитах
Megabyte	string	Единица размера данных в мегабайтах
Petabit	string	Единица размера данных в петабитах
Petabyte	string	Единица размера данных в петабайтах
Terabit	string	Единица размера данных в terabits
Terabyte	string	Единица размера данных в терабайтах
Unspecified	string	Единица неопределенного размера данных

InnerErrorCode

Код ошибки, доступный для чтения человеком.

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string	Ошибка "Когнитивный поиск Azure" не найдена
AzureCognitiveSearchThrottling	string	Ошибка регулирования когнитивного поиска Azure
EmptyRequest	string	Ошибка пустого запроса
ExtractionFailure	string	Ошибка извлечения
InvalidCountryHint	string	Недопустимая ошибка указания страны
InvalidDocument	string	Недопустимая ошибка документа
InvalidDocumentBatch	string	Недопустимая ошибка пакета документов
InvalidParameterValue	string	Ошибка недопустимого значения параметра
InvalidRequest	string	Недопустимая ошибка запроса
InvalidRequestBodyFormat	string	Ошибка недопустимого формата текста запроса
KnowledgeBaseNotFound	string	Ошибка базы знаний не найдена
MissingInputDocuments	string	Ошибка ввода документов
ModelVersionIncorrect	string	Ошибка неправильной версии модели
UnsupportedLanguageCode	string	Неподдерживаемая ошибка кода языка

InnerErrorModel

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

KeyPhraseResult

Содержит keyPhraseResult.

Имя	Тип	Описание
documents	KeyPhrasesDocumentResult[]	Ответ по документу
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

KeyPhrasesDocumentResult

Содержит результаты извлечения ключевых фраз для документа.

Имя	Тип	Описание
id	string	Уникальный, непустый идентификатор документа.
keyPhrases	string[]	Список репрезентативных слов или фраз. Количество возвращаемых ключевых фраз пропорционально количеству слов в входном документе.
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

KeyPhraseTaskParameters

Поддерживаемые параметры для задачи извлечения ключевых фраз.

Имя	Тип	Default value	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели

KeyPhraseTaskResult

Содержит результат задачи анализа текста KeyPhraseExtraction.

Имя	Тип	Описание
kind	string: KeyPhraseExtractionResults	Тип результата задачи.
results	KeyPhraseResult	Список результатов извлечения ключевых фраз

LanguageDetectionAnalysisInput

Содержит входные данные анализа документов обнаружения языка.

Имя	Тип	Описание
documents	LanguageInput[]	Список документов для анализа.

LanguageDetectionDocumentResult

Содержит обнаружение языка для документа.

Имя	Тип	Описание
detectedLanguage	DetectedLanguage	Обнаруженный язык.
id	string	Уникальный, непустый идентификатор документа.
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

LanguageDetectionResult

Содержит результат обнаружения языка для запроса.

Имя	Тип	Описание
documents	LanguageDetectionDocumentResult[]	Перечисление результатов обнаружения языка для каждого входного документа.
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

LanguageDetectionTaskParameters

Поддерживаемые параметры для задачи распознавания языка.

Имя	Тип	Default value	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели

LanguageDetectionTaskResult

Содержит результат задачи обнаружения языка для запроса.

Имя	Тип	Описание
kind	string: LanguageDetectionResults	Тип результата задачи.
results	LanguageDetectionResult	Содержит результаты обнаружения языка.

LanguageInput

Содержит входные данные обнаружения языка.

Имя	Тип	Описание
countryHint	string	Указание страны помочь в обнаружении языка текста.
id	string	Уникальный непустый идентификатор документа.
text	string	Входной текст для обработки.

LengthMetadata

Представляет модель метаданных сущности Length.

Имя	Тип	Описание
metadataKind	string: LengthMetadata	Тип объекта метаданных сущности.
unit	LengthUnit	Единица измерения длины.
value	number	Числовое значение, которое обозначает извлеченный текст.

LengthUnit

Единица измерения длины.

Имя	Тип	Описание
Centimeter	string	Длина единицы в сантиметрах.
Decameter	string	Единица длины в декаметрах.
Decimeter	string	Единица длины в дециметрах.
Foot	string	Длина единицы в футах.
Hectometer	string	Единица длины в гектометрах.
Inch	string	Длина единицы в дюймах.
Kilometer	string	Длина единицы в километрах.
LightYear	string	Длина единицы в световых годах.
Meter	string	Единица длины в метрах.
Micrometer	string	Единица длины в микрометрах.
Mile	string	Длина единицы в милях.
Millimeter	string	Длина единицы в миллиметрах.
Nanometer	string	Единица длины в нанометрах.
Picometer	string	Единица длины в пикометрах.
Point	string	Единица длины в точках.
Unspecified	string	Единица неопределенной длины.
Yard	string	Длина единицы в ярдах.

LinkedEntitiesDocumentResult

Результат связывания сущностей.

Имя	Тип	Описание
entities	LinkedEntity[]	Распознанные известные сущности в документе.
id	string	Уникальный, непустый идентификатор документа.
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

LinkedEntity

Объект LinkedEntity, содержащий обнаруженную сущность с соответствующими источниками или ссылками.

Имя	Тип	Описание
bingId	string	Уникальный идентификатор API поиска сущностей Bing для распознанной сущности.
dataSource	string	Источник данных, используемый для извлечения связывания сущностей, таких как Wiki/Bing и т. д.
id	string	Уникальный идентификатор распознанной сущности из источника данных.
language	string	Язык, используемый в источнике данных.
matches	Match[]	Список экземпляров этой сущности отображается в тексте.
name	string	Связывание сущностей формального имени.
url	string	URL-адрес страницы сущности из источника данных.

Match

Объект Match, содержащий обнаруженный текст сущности со смещением и длиной.

Имя	Тип	Описание
confidenceScore	number	Если хорошо известный элемент распознается, возвращается десятичное число, обозначающее уровень достоверности от 0 до 1.
length	integer	Длина текста сопоставления сущностей.
offset	integer	Начальная позиция для текста сопоставления сущностей.
text	string	Текст сущности, как показано в запросе.

MatchLongestEntityPolicyType

Представляет политику сопоставления с самым длинным перекрытием. Никакие перекрывающиеся сущности насколько это возможно. 1. Если есть перекрывающиеся сущности, будет возвращен самый длинный. 2. Если набор символов, прогнозируемых для 2 или более сущностей, точно совпадает, выберите сущность, которая имеет более высокую оценку достоверности.3. Если оценки сущностей идентичны, верните все сущности, которые по-прежнему присутствуют после применения предыдущих правил. 3. Если существует частичное перекрытие (как и в Hello Text Analytics), выполните описанные выше действия, начиная с 1.

Имя	Тип	Default value	Описание
policyKind	string: matchLongest	matchLongest	Тип объекта OverlapPolicy.

MetadataKind

Тип объекта метаданных сущности.

Имя	Тип	Описание
AgeMetadata	string	Метаданные для значений, связанных с возрастом.
AreaMetadata	string	Метаданные для значений, связанных с областями.
CurrencyMetadata	string	Метаданные для значений, связанных с валютой.
DateMetadata	string	Метаданные для значений, связанных с датой.
DateTimeMetadata	string	Метаданные для значений даты и времени.
InformationMetadata	string	Метаданные для значений, связанных с информацией.
LengthMetadata	string	Метаданные для значений, связанных с длиной.
NumberMetadata	string	Метаданные для числовых значений.
NumericRangeMetadata	string	Метаданные для числовых значений диапазона.
OrdinalMetadata	string	Метаданные для порядковых чисел.
SpeedMetadata	string	Метаданные для значений, связанных со скоростью.
TemperatureMetadata	string	Метаданные для значений, связанных с температурой.
TemporalSetMetadata	string	Метаданные для набора значений, связанных с временем.
TemporalSpanMetadata	string	Метаданные для значений темпорального диапазона.
TimeMetadata	string	Метаданные для значений, связанных с временем.
VolumeMetadata	string	Метаданные для значений, связанных с томом.
WeightMetadata	string	Метаданные для значений, связанных с весом.

MultiLanguageAnalysisInput

Коллекция входных документов для анализа службой.

Имя	Тип	Описание
documents	MultiLanguageInput[]	Входные документы, которые необходимо проанализировать.

MultiLanguageInput

Содержит входной документ, который будет анализироваться службой.

Имя	Тип	Описание
id	string	Уникальный непустый идентификатор документа.
language	string	(Необязательно) Это 2 буква ISO 639-1 представления языка. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию. (Далее применяется только 2023-04-15-preview и выше) Для автоматического обнаружения языка используйте функцию auto. Если не задано, используйте en для английского языка по умолчанию.
text	string	Входной текст для обработки.

NumberKind

Тип извлеченной сущности номера.

Имя	Тип	Описание
Decimal	string	Десятичное число
Fraction	string	Номер дроби
Integer	string	Целочисленный номер
Percent	string	Процент числа
Power	string	Номер питания
Unspecified	string	Тип неопределенного числа

NumberMetadata

Метаданные для числовых экземпляров сущностей.

Имя	Тип	Описание
metadataKind	string: NumberMetadata	Тип объекта метаданных сущности.
numberKind	NumberKind	Тип числа.
value	number	Числовое представление того, что извлекаемый текст обозначает.

NumericRangeMetadata

представляет метаданные числовых интервалов.

Имя	Тип	Описание
maximum	number	Конечное значение интервала.
metadataKind	string: NumericRangeMetadata	Тип объекта метаданных сущности.
minimum	number	Начальное значение интервала.
rangeInclusivity	RangeInclusivity	Инклюзивность этого диапазона.
rangeKind	RangeKind	Поддерживаемые числовые диапазоны: число, скорость и т. д.

OrdinalMetadata

Метаданные для числовых экземпляров сущностей.

Имя	Тип	Описание
metadataKind	string: OrdinalMetadata	Тип объекта метаданных сущности.
offset	string	Смещение относительно ссылки (например, смещение = -1 указывает на последнее значение)
relativeTo	RelativeTo	Эталонная точка, обозначающая порядковый номер.
value	string	Простое арифметическое выражение, которое обозначает порядковый номер.

PiiCategory

(Необязательно) описывает категории piI для возврата

Имя	Тип	Описание
ABARoutingNumber	string	Номер маршрутизации ABA
ARNationalIdentityNumber	string	Номер удостоверений AR
ATIdentityCard	string	Карточка удостоверения AT
ATTaxIdentificationNumber	string	Идентификационный номер AT
ATValueAddedTaxNumber	string	Добавленный налоговый номер AT
AUBankAccountNumber	string	Карточка удостоверения AT
AUBusinessNumber	string	Бизнес-номер AU
AUCompanyNumber	string	Номер компании AU
AUDriversLicenseNumber	string	Номер лицензии драйвера AU
AUMedicalAccountNumber	string	Номер медицинской учетной записи AU
AUPassportNumber	string	Номер паспорта AU
AUTaxFileNumber	string	Номер налогового файла AU
Address	string	Адрес
Age	string	Возраст
All	string	Все категории PII.
AzureDocumentDBAuthKey	string	Ключ проверки подлинности базы данных документов Azure
AzureIAASDatabaseConnectionAndSQLString	string	Подключение к базе данных Azure IAAS и строка SQL
AzureIoTConnectionString	string	Строка подключения Интернета вещей Azure
AzurePublishSettingPassword	string	Пароль параметра публикации Azure
AzureRedisCacheString	string	Строка кэша Redis Для Azure
AzureSAS	string	Azure SAS
AzureServiceBusString	string	Строка служебной шины Azure
AzureStorageAccountGeneric	string	Универсальная учетная запись хранения Azure
AzureStorageAccountKey	string	Ключ учетной записи хранения Azure
BENationalNumber	string	Национальный номер BE
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	Добавленный налоговый номер BE
BGUniformCivilNumber	string	Единый гражданский номер BG
BRCPFNumber	string	Номер CPF BR
BRLegalEntityNumber	string	Номер юридического лица BR
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Номер банковского счета ЦС
CADriversLicenseNumber	string	Номер лицензии драйвера ЦС
CAHealthServiceNumber	string	Номер службы работоспособности ЦС
CAPassportNumber	string	Номер паспорта ЦС
CAPersonalHealthIdentification	string	Идентификация личного работоспособности ЦС
CASocialInsuranceNumber	string	Номер социального страхования ЦС
CHSocialSecurityNumber	string	Номер социального страхования CH
CLIdentityCardNumber	string	Номер карточки удостоверений CL
CNResidentIdentityCardNumber	string	Номер удостоверения резидента CN
CYIdentityCard	string	Карточка удостоверения CY
CYTaxIdentificationNumber	string	Идентификационный номер налога CY
CZPersonalIdentityNumber	string	Номер личного удостоверения CZ
CZPersonalIdentityV2	string	Личное удостоверение CZ версии 2
CreditCardNumber	string	Номер кредитной карты
DEDriversLicenseNumber	string	Номер лицензии драйвера DE
DEIdentityCardNumber	string	Номер карточки удостоверения DE
DEPassportNumber	string	Номер паспорта DE
DETaxIdentificationNumber	string	Идентификационный номер DE
DEValueAddedNumber	string	Добавленный номер DE
DKPersonalIdentificationNumber	string	Личный идентификационный номер DK
DKPersonalIdentificationV2	string	Личная идентификация DK версии 2
Date	string	Дата
Default	string	Категории piI по умолчанию для языка.
DrugEnforcementAgencyNumber	string	Номер агентства по борьбе с наркотиками
EEPersonalIdentificationCode	string	EE Персональный идентификационный код
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Номер социального страхования ES
ESTaxIdentificationNumber	string	Идентификационный номер ES
EUDebitCardNumber	string	Номер дебетовой карты ЕС
EUDriversLicenseNumber	string	Номер лицензии водителя ЕС
EUGPSCoordinates	string	Координаты GPS ЕС
EUNationalIdentificationNumber	string	Национальный идентификационный номер ЕС
EUPassportNumber	string	Номер паспорта ЕС
EUSocialSecurityNumber	string	Номер социального страхования ЕС
EUTaxIdentificationNumber	string	Идентификационный номер налога ЕС
Email	string	Отправить по электронной почте
FIEuropeanHealthNumber	string	Номер работоспособности FI Для Европы
FINationalID	string	Национальный идентификатор FI
FINationalIDV2	string	Национальный идентификатор FI версии 2
FIPassportNumber	string	Номер паспорта FI
FRDriversLicenseNumber	string	Номер лицензии драйвера FR
FRHealthInsuranceNumber	string	Номер страхования здоровья FR
FRNationalID	string	Национальный идентификатор FR
FRPassportNumber	string	Номер паспорта FR
FRSocialSecurityNumber	string	Номер социального страхования FR
FRTaxIdentificationNumber	string	Идентификационный номер FR
FRValueAddedTaxNumber	string	Добавленный налоговый номер FR
GRNationalIDCard	string	Национальный идентификатор GR
GRNationalIDV2	string	Национальный идентификатор GR версии 2
GRTaxIdentificationNumber	string	Идентификационный номер GR
HKIdentityCardNumber	string	Номер карточки удостоверения HK
HRIdentityCardNumber	string	Номер удостоверения кадров
HRNationalIDNumber	string	Номер национального идентификатора отдела кадров
HRPersonalIdentificationNumber	string	Личный идентификационный номер отдела кадров
HRPersonalIdentificationOIBNumberV2	string	Номер OIB для личной идентификации кадров V2
HUPersonalIdentificationNumber	string	Персональный идентификационный номер HU
HUTaxIdentificationNumber	string	Идентификационный номер ХУ
HUValueAddedNumber	string	Добавлено значение HU
IDIdentityCardNumber	string	Номер удостоверения идентификатора
IEPersonalPublicServiceNumber	string	Номер ЛИЧНЫХ общедоступных служб IE
IEPersonalPublicServiceNumberV2	string	Номер общедоступной службы IE версии 2
ILBankAccountNumber	string	Номер банковского счета IL
ILNationalID	string	Национальный идентификатор IL
INPermanentAccount	string	Постоянная учетная запись IN
INUniqueIdentificationNumber	string	Уникальный идентификационный номер IN
IPAddress	string	IP-адрес
ITDriversLicenseNumber	string	Номер лицензии ИТ-водителя
ITFiscalCode	string	ИТ-финансовый код
ITValueAddedTaxNumber	string	Добавленный ИТ-номер налога
InternationalBankingAccountNumber	string	Номер счета международного банковского счета
JPBankAccountNumber	string	Номер банковского счета JP
JPDriversLicenseNumber	string	Номер лицензии драйвера JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP My Number Personal
JPPassportNumber	string	Номер паспорта JP
JPResidenceCardNumber	string	Номер карточки проживания JP
JPResidentRegistrationNumber	string	Номер регистрации резидентов JP
JPSocialInsuranceNumber	string	Номер социального страхования JP
KRResidentRegistrationNumber	string	Номер регистрации резидентов KR
LTPersonalCode	string	Личный код LT
LUNationalIdentificationNumberNatural	string	Естественный идентификационный номер LU
LUNationalIdentificationNumberNonNatural	string	Национальный идентификационный номер LU, не естественный
LVPersonalCode	string	Личный код LV
MTIdentityCardNumber	string	Номер удостоверения MT
MTTaxIDNumber	string	Номер налогового идентификатора MT
MYIdentityCardNumber	string	Номер карточки удостоверения
NLCitizensServiceNumber	string	Номер службы граждан NL
NLCitizensServiceNumberV2	string	Номер службы граждан NL версии 2
NLTaxIdentificationNumber	string	NL Налоговый идентификационный номер
NLValueAddedTaxNumber	string	NL Добавленный налоговый номер
NOIdentityNumber	string	Номер удостоверения NO
NZBankAccountNumber	string	Номер банковского счета NZ
NZDriversLicenseNumber	string	Номер лицензии водителя NZ
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Номер министерства здравоохранения NZ
NZSocialWelfareNumber	string	Номер социального обеспечения NZ
Organization	string	Организация
PHUnifiedMultiPurposeIDNumber	string	Номер идентификатора единого многоцелевой идентификации PH
PLIdentityCard	string	Карточка удостоверения PL
PLNationalID	string	Национальный идентификатор PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Номер паспорта PL
PLREGONNumber	string	Номер PL REGON
PLTaxIdentificationNumber	string	Идентификационный номер PL
PTCitizenCardNumber	string	Номер карточки гражданина PT
PTCitizenCardNumberV2	string	Номер карточки гражданина PT версии 2
PTTaxIdentificationNumber	string	Идентификационный номер налога PT
Person	string	Человек
PhoneNumber	string	Номер телефона
ROPersonalNumericalCode	string	Личные числовые коды RO
RUPassportNumberDomestic	string	Внутренний номер паспорта ЕЗ
RUPassportNumberInternational	string	Номер паспорта RU International
SANationalID	string	Национальный идентификатор SA
SENationalID	string	Национальный идентификатор SE
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Номер паспорта SE
SETaxIdentificationNumber	string	Идентификационный номер SE
SGNationalRegistrationIdentityCardNumber	string	Номер удостоверения удостоверения национальной регистрации SG
SITaxIdentificationNumber	string	Идентификационный номер SI
SIUniqueMasterCitizenNumber	string	Уникальный номер гражданина SI
SKPersonalNumber	string	Персональный номер SK
SQLServerConnectionString	string	Строка подключения SQL Server
SWIFTCode	string	КОД SWIFT
THPopulationIdentificationCode	string	Код идентификации популяции TH
TRNationalIdentificationNumber	string	TR Национальный идентификационный номер
TWNationalID	string	Национальный идентификатор TW
TWPassportNumber	string	Номер паспорта TW
TWResidentCertificate	string	Сертификат резидента TW
UAPassportNumberDomestic	string	Номер паспорта UA внутренний
UAPassportNumberInternational	string	Номер паспорта UA International
UKDriversLicenseNumber	string	Номер лицензии водителя Великобритании
UKElectoralRollNumber	string	Номер избирательного списка Великобритании
UKNationalHealthNumber	string	Номер национального здравоохранения Великобритании
UKNationalInsuranceNumber	string	Номер национального страхования Великобритании
UKUniqueTaxpayerNumber	string	Уникальный номер налогоплательщиков Великобритании
URL	string	URL-адрес
USBankAccountNumber	string	Номер банковского счета США
USDriversLicenseNumber	string	Номер лицензии водителя США
USIndividualTaxpayerIdentification	string	Идентификация отдельных налогоплательщиков США
USSocialSecurityNumber	string	Номер социального страхования США
USUKPassportNumber	string	Номер паспорта ВЕЛИКОБРИТАНИи
ZAIdentificationNumber	string	Идентификационный номер ZA

PiiDomain

Задача "Домен для piI"

Имя	Тип	Описание
none	string	Указывает, что домен не указан.
phi	string	Указывает, что сущности в домене личной информации о работоспособности должны быть отредактированы.

PiiEntitiesDocumentResult

Содержит результаты piI.

Имя	Тип	Описание
entities	Entity[]	Распознанные сущности в документе.
id	string	Уникальный, непустый идентификатор документа.
redactedText	string	Возвращает отредактированный текст.
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

PiiResult

Содержит PiiResult.

Имя	Тип	Описание
documents	PiiEntitiesDocumentResult[]	Ответ по документу
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

PiiTaskParameters

Поддерживаемые параметры для задачи распознавания сущностей PII.

Имя	Тип	Default value	Описание
domain	PiiDomain	none	Задача "Домен для piI"
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
piiCategories	PiiCategory[]		Перечисление категорий PII, возвращаемых в ответе.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType, используемый для анализа.

PiiTaskResult

Содержит задачу LRO анализа текста PIIEntityRecognition LRO.

Имя	Тип	Описание
kind	string: PiiEntityRecognitionResults	Тип результата задачи.
results	PiiResult	Список результатов pii

RangeInclusivity

Диапазон инклюзивности этого свойства.

Имя	Тип	Описание
LeftInclusive	string	Слева включительно
LeftRightInclusive	string	Обе стороны включительно
NoneInclusive	string	Нет инклюзивности
RightInclusive	string	Правой стороне включительно

RangeKind

Тип сущности диапазона чисел.

Имя	Тип	Описание
Age	string	Диапазон возрастов
Area	string	Диапазон областей
Currency	string	Диапазон валют
Information	string	Диапазон сведений
Length	string	Диапазон длины
Number	string	Диапазон чисел
Speed	string	Диапазон скорости
Temperature	string	Диапазон температур
Volume	string	Диапазон томов
Weight	string	Диапазон веса

RelativeTo

Эталонная точка, обозначающая порядковый номер.

Имя	Тип	Описание
Current	string	Текущее состояние или положение
End	string	Конечное состояние или положение
Start	string	Состояние запуска или положение

RequestStatistics

Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

Имя	Тип	Описание
documentsCount	integer	Количество документов, отправленных в запросе.
erroneousDocumentsCount	integer	Количество недопустимых документов. К ним относятся пустые, слишком многоуровневые или не поддерживаемые языки.
transactionsCount	integer	Количество транзакций для запроса.
validDocumentsCount	integer	Количество допустимых документов. Это исключает пустые, слишком многоуровневые или не поддерживаемые документы языков.

ScriptCode

Определяет скрипт входного документа. Сопоставляется со стандартным кодом скрипта ISO 15924.

Имя	Тип	Описание
Arab	string	Код скрипта для арабского скрипта.
Armn	string	Код скрипта для армянского скрипта.
Beng	string	Код скрипта для скрипта Bangla.
Cans	string	Код скрипта для скрипта UnifiedCanadianAboriginalSyllabics.
Cyrl	string	Код скрипта для скрипта кириллицы.
Deva	string	Код скрипта для скрипта Devanagari.
Ethi	string	Код скрипта для скрипта Ethiopic.
Geor	string	Код скрипта для грузинского скрипта.
Grek	string	Код скрипта для греческого скрипта.
Gujr	string	Код скрипта для скрипта Gujarati.
Guru	string	Код скрипта для скрипта Gurmukhi.
Hang	string	Код скрипта для скрипта Hangul.
Hani	string	Код скрипта для скрипта HanLiteral.
Hans	string	Код скрипта для скрипта HanSimplified.
Hant	string	Код скрипта для скрипта HanTraditional.
Hebr	string	Код скрипта для ивритского скрипта.
Jpan	string	Код скрипта для японского скрипта.
Khmr	string	Код скрипта для скрипта Кхмера.
Knda	string	Код скрипта для скрипта Kannada.
Laoo	string	Код скрипта для лаосского скрипта.
Latn	string	Код скрипта для латинского скрипта.
Mlym	string	Код скрипта для скрипта Малаялам.
Mong	string	Код скрипта для монголийского скрипта.
Mtei	string	Код скрипта для скрипта Meitei.
Mymr	string	Код скрипта для скрипта Мьянмы.
Olck	string	Код скрипта для скрипта Santali.
Orya	string	Код скрипта для скрипта Odia.
Shrd	string	Код скрипта для скрипта Sharada.
Sinh	string	Код скрипта для скрипта Sinhala.
Taml	string	Код скрипта для скрипта Тамил.
Telu	string	Код скрипта для скрипта Telugu.
Thaa	string	Код скрипта для скрипта Thaana.
Thai	string	Код скрипта для тайского скрипта.
Tibt	string	Код скрипта для тибетского скрипта.

ScriptKind

Определяет скрипт входного документа. Сопоставляется со стандартным формальным именем ISO 15924.

Имя	Тип	Описание
Arabic	string	Имя скрипта для арабского скрипта.
Armenian	string	Имя сценария для армянского сценария.
Bangla	string	Имя скрипта Bangla.
Cyrillic	string	Имя скрипта для скрипта кириллицы.
Devanagari	string	Имя скрипта Devanagari.
Ethiopic	string	Имя скрипта для скрипта Ethiopic.
Georgian	string	Имя скрипта для грузинского скрипта.
Greek	string	Имя скрипта для греческого скрипта.
Gujarati	string	Имя скрипта Gujarati.
Gurmukhi	string	Имя скрипта Гурмухи.
HanLiteral	string	Имя скрипта HanLiteral.
HanSimplified	string	Имя скрипта HanSimplified.
HanTraditional	string	Имя скрипта HanTraditional.
Hangul	string	Имя скрипта Hangul.
Hebrew	string	Имя скрипта для ивритского скрипта.
Japanese	string	Имя скрипта для японского скрипта.
Kannada	string	Имя скрипта Kannada.
Khmer	string	Имя скрипта кхмера.
Lao	string	Имя скрипта для лаосского скрипта.
Latin	string	Имя скрипта для латинского скрипта.
Malayalam	string	Имя скрипта Малаялам.
Meitei	string	Имя скрипта Meitei.
Mongolian	string	Имя скрипта для монголийского скрипта.
Myanmar	string	Имя скрипта Мьянмы.
Odia	string	Имя скрипта Odia.
Santali	string	Имя скрипта Santali.
Sharada	string	Имя скрипта Sharada.
Sinhala	string	Имя скрипта Синхала.
Tamil	string	Имя скрипта Тамил.
Telugu	string	Имя скрипта Telugu.
Thaana	string	Имя скрипта Thaana.
Thai	string	Имя скрипта для тайского скрипта.
Tibetan	string	Имя скрипта для тибетского сценария.
UnifiedCanadianAboriginalSyllabics	string	Имя скрипта UnifiedCanadianAboriginalSyllabics.

SentenceAssessment

Представляет оценку предложения и оценки или целевые объекты, связанные с ним.

Имя	Тип	Описание
confidenceScores	TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
isNegated	boolean	Индикатор, представляющий, отрицает ли оценка.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
sentiment	TokenSentimentValue	Тональность предложения.
text	string	Обнаруженный целевой текст.

SentenceSentiment

Тональность предложения документа.

Имя	Тип	Описание
assessments	SentenceAssessment[]	Массив оценок для предложения.
confidenceScores	SentimentConfidenceScores	Оценка достоверности тональности от 0 до 1 для предложения для всех классов.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
sentiment	SentenceSentimentValue	Прогнозируемое тональность предложения.
targets	SentenceTarget[]	Массив предложений, предназначенный для предложения.
text	string	Текст предложения.

SentenceSentimentValue

Прогнозируемое тональность предложения.

Имя	Тип	Описание
negative	string	Отрицательные тональности
neutral	string	Нейтральные тональности
positive	string	Положительные настроения

SentenceTarget

Представляет целевой объект предложения и оценки или целевые объекты, связанные с ним.

Имя	Тип	Описание
confidenceScores	TargetConfidenceScoreLabel	Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.
length	integer	Длина целевого объекта.
offset	integer	Целевое смещение от начала предложения.
relations	TargetRelation[]	Массив объектов оценки или целевых объектов, связанных с целевым объектом.
sentiment	TokenSentimentValue	Тональность предложения.
text	string	Обнаруженный целевой текст.

SentimentAnalysisTaskParameters

Поддерживаемые параметры для задачи анализа тональности.

Имя	Тип	Default value	Описание
loggingOptOut	boolean	False	отказ от ведения журнала
modelVersion	string	latest	версия модели
opinionMining	boolean	False	Следует ли использовать интеллектуальный анализ мнений в запросе или нет.
stringIndexType	StringIndexType	TextElements_v8	Задает метод, используемый для интерпретации смещения строк.

SentimentConfidenceScores

Представляет оценки достоверности между 0 и 1 для всех классов тональности: положительные, нейтральные, отрицательные.

Имя	Тип	Описание
negative	number	Оценка достоверности для отрицательной тональности
neutral	number	Оценка достоверности для нейтральной тональности
positive	number	Оценка достоверности для положительной тональности

SentimentDocumentResult

Объект, представляющий предварительно созданные результаты анализа тональности каждого документа.

Имя	Тип	Описание
confidenceScores	SentimentConfidenceScores	Оценка достоверности тональности от 0 до 1 для предложения для всех классов.
id	string	Уникальный, непустый идентификатор документа.
sentences	SentenceSentiment[]	Тональность предложений документа.
sentiment	DocumentSentimentValue	Прогнозируемые тональности для документа (отрицательные, нейтральные, положительные или смешанные).
statistics	DocumentStatistics	Значение , если showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных документа.
warnings	DocumentWarning[]	Предупреждения, возникающие при обработке документа.

SentimentResponse

Результаты анализа тональности для входных документов.

Имя	Тип	Описание
documents	SentimentDocumentResult[]	Результаты анализа тональности для каждого документа в входных данных.
errors	DocumentError[]	Ошибки по идентификатору документа.
modelVersion	string	Это поле указывает, какая модель используется для оценки.
statistics	RequestStatistics	Значение , если значение showStats=true было указано в запросе, это поле будет содержать сведения о полезных данных запроса.

SentimentTaskResult

Содержит результат задачи анализа text SentimentAnalysis LRO.

Имя	Тип	Описание
kind	string: SentimentAnalysisResults	Тип результата задачи.
results	SentimentResponse	Результаты анализа тональности

SpeedMetadata

Представляет модель метаданных сущности Speed.

Имя	Тип	Описание
metadataKind	string: SpeedMetadata	Тип объекта метаданных сущности.
unit	SpeedUnit	Единица измерения скорости.
value	number	Числовое значение, которое обозначает извлеченный текст.

SpeedUnit

Единица измерения скорости

Имя	Тип	Описание
CentimetersPerMillisecond	string	Единица скорости в сантиметрах на миллисекунда.
FeetPerMinute	string	Единица скорости в футах в минуту.
FeetPerSecond	string	Единица скорости в футах в секунду.
KilometersPerHour	string	Единица скорости в километрах в час.
KilometersPerMillisecond	string	Единица скорости в километрах за миллисекунда.
KilometersPerMinute	string	Единица скорости в километрах в минуту.
KilometersPerSecond	string	Единица скорости в километрах в секунду.
Knots	string	Единица скорости в узлах.
MetersPerMillisecond	string	Единица скорости в метрах в миллисекундах.
MetersPerSecond	string	Единица скорости в метрах в секунду.
MilesPerHour	string	Единица скорости в милях в час.
Unspecified	string	Неопределенная единица скорости.
YardsPerMinute	string	Единица скорости в ярдах в минуту.
YardsPerSecond	string	Единица скорости в ярдах в секунду.

StringIndexType

Тип строкового индекса

Имя	Тип	Описание
TextElements_v8	string	Возвращаемые значения смещения и длины будут соответствовать TextElements (кластерам Graphemes и Grapheme), подтверждающим стандарту Юникод 8.0.0. Используйте этот параметр, если приложение написано в .Net Framework или .Net Core, и вы будете использовать StringInfo.
UnicodeCodePoint	string	Возвращаемые значения смещения и длины будут соответствовать точкам кода Юникода. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Python.
Utf16CodeUnit	string	Возвращаемые значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TargetConfidenceScoreLabel

Представляет оценки достоверности для всех классов тональности: положительные и отрицательные.

Имя	Тип	Описание
negative	number	Оценка достоверности для отрицательной тональности
positive	number	Оценка достоверности для положительной тональности

TargetRelation

Представляет отношение между оценками и /или целевыми объектами.

Имя	Тип	Описание
ref	string	Указатель JSON, указывающий связанный объект.
relationType	TargetRelationType	Тип, связанный с целевым объектом.

TargetRelationType

Тип, связанный с целевым объектом.

Имя	Тип	Описание
assessment	string	Отношение оценки.
target	string	Целевое отношение.

TemperatureMetadata

Представляет модель метаданных сущности Information.

Имя	Тип	Описание
metadataKind	string: TemperatureMetadata	Тип объекта метаданных сущности.
unit	TemperatureUnit	Единица измерения для температуры.
value	number	Числовое значение, которое обозначает извлеченный текст.

TemperatureUnit

Единица измерения температуры.

Имя	Тип	Описание
Celsius	string	Единица температуры в Цельсиях
Fahrenheit	string	Единица температуры в Фаренхейте
Kelvin	string	Единица температуры в Келвине
Rankine	string	Единица температуры в Rankine
Unspecified	string	Неопределенная единица температуры

TemporalModifier

Необязательный модификатор экземпляра даты и времени.

Имя	Тип	Описание
After	string	Через определенное время
AfterApprox	string	После приблизительного времени
AfterMid	string	После середины периода времени
AfterStart	string	После начала периода времени
Approx	string	Приблизительно в определенное время
Before	string	До определенного времени
BeforeApprox	string	До приблизительного времени
BeforeEnd	string	До окончания периода времени
BeforeStart	string	До начала периода времени
End	string	В конце периода времени
Less	string	Меньше определенного времени
Mid	string	В середине периода времени
More	string	Более определенного времени
ReferenceUndefined	string	Ссылка на неопределенное время
Since	string	С определенного времени
SinceEnd	string	С конца периода времени
Start	string	В начале периода времени
Until	string	До определенного времени

TemporalSetMetadata

Метаданные для экземпляров сущностей темпорального набора.

Имя	Тип	Описание
dateValues	DateValue[]	Список значений даты.
metadataKind	string: TemporalSetMetadata	Тип объекта метаданных сущности.

TemporalSpanMetadata

представляет метаданные даты и (или) интервала времени.

Имя	Тип	Описание
metadataKind	string: TemporalSpanMetadata	Тип объекта метаданных сущности.
spanValues	TemporalSpanValues[]	Список обнаруженных временных диапазонов.

TemporalSpanValues

Объект темпорального диапазона.

Имя	Тип	Описание
begin	string	Начальное значение диапазона.
duration	string	Необязательное значение длительности в формате ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Конечное значение диапазона.
modifier	TemporalModifier	Модификатор даты и времени, указывающий точку ссылки, как раньше, после и т. д.
timex	string	Необязательный триплет, содержащий начало, конец и длительность, указанную как строки форматирования ISO 8601.

TimeMetadata

Метаданные для экземпляров сущностей времени.

Имя	Тип	Описание
dateValues	DateValue[]	Список значений даты.
metadataKind	string: TimeMetadata	Тип объекта метаданных сущности.

TokenSentimentValue

Прогнозируемое тональность предложения.

Имя	Тип	Описание
mixed	string	Смешанные настроения
negative	string	Отрицательные тональности
positive	string	Положительные настроения

VolumeMetadata

Представляет модель метаданных сущности тома.

Имя	Тип	Описание
metadataKind	string: VolumeMetadata	Тип объекта метаданных сущности.
unit	VolumeUnit	Единица измерения для тома.
value	number	Числовое значение, которое обозначает извлеченный текст.

VolumeUnit

Единица измерения тома

Имя	Тип	Описание
Barrel	string	Единица тома в баррелях.
Bushel	string	Единица тома в бушелях.
Centiliter	string	Единица тома в центитерах.
Cord	string	Единица тома в кордах.
CubicCentimeter	string	Единица тома в кубических сантиметрах.
CubicFoot	string	Единица тома в кубических футах.
CubicInch	string	Единица тома в кубических дюймах.
CubicMeter	string	Единица тома в кубометрах.
CubicMile	string	Единица тома в кубических милях.
CubicMillimeter	string	Единица тома в кубических миллиметрах.
CubicYard	string	Единица тома в кубовых ярдах.
Cup	string	Единица тома в чашках.
Decaliter	string	Единица тома в декалитерах.
FluidDram	string	Единица тома в текучих кадрах.
FluidOunce	string	Единица тома в жидкости унции.
Gill	string	Единица тома в гибрах.
Hectoliter	string	Единица тома в гектолитерах.
Hogshead	string	Единица тома в кречках.
Liter	string	Единица тома в литрах.
Milliliter	string	Единица тома в миллилитерах.
Minim	string	Единица тома в минимах.
Peck	string	Единица тома в местах.
Pinch	string	Единица тома в пикселях.
Pint	string	Единица тома в закреплении.
Quart	string	Единица тома в квартах.
Tablespoon	string	Единица тома в таблицах.
Teaspoon	string	Единица тома в чайных ложках.
Unspecified	string	Неопределенная единица тома.

WarningCodeValue

Определяет список кодов предупреждений.

Имя	Тип	Описание
DocumentTruncated	string	Усеченное предупреждение документа
LongWordsInDocument	string	Длинные слова в предупреждении документа

WeightMetadata

Представляет модель метаданных сущности Weight ) .

Имя	Тип	Описание
metadataKind	string: WeightMetadata	Тип объекта метаданных сущности.
unit	WeightUnit	Единица измерения для веса.
value	number	Числовое значение, которое обозначает извлеченный текст.

WeightUnit

Единица измерения веса.

Имя	Тип	Описание
Dram	string	Единица веса в кадрах
Gallon	string	Единица тома в галлонах
Grain	string	Единица веса в зернах
Gram	string	Единица веса в граммах
Kilogram	string	Единица веса в килограммах
LongTonBritish	string	Весовая единица в длинных тоннах (британская)
MetricTon	string	Единица веса в тоннах метрик
Milligram	string	Единица веса в миллиграммах
Ounce	string	Единица веса в унциях
PennyWeight	string	Единица веса в пеннивесах
Pound	string	Единица веса в фунтах
ShortHundredWeightUS	string	Единица веса в коротких сотнях (США)
ShortTonUS	string	Единица веса в коротких тоннах (США)
Stone	string	Единица веса в камнях
Ton	string	Единица веса в тоннах
Unspecified	string	Неопределенная единица веса