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 minLength: 1	Версия 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

Object

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

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

AgeUnit

Перечисление

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

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

AllowOverlapEntityPolicyType

Object

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

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

AnalyzeTextEntityLinkingInput

Object

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

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

AnalyzeTextEntityRecognitionInput

Object

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

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

AnalyzeTextKeyPhraseExtractionInput

Object

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

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

AnalyzeTextLanguageDetectionInput

Object

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

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

AnalyzeTextPiiEntitiesRecognitionInput

Object

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

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

AnalyzeTextSentimentAnalysisInput

Object

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

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

AnalyzeTextTaskKind

Перечисление

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

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

AnalyzeTextTaskResultsKind

Перечисление

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

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

AreaMetadata

Object

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

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

AreaUnit

Перечисление

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

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

CurrencyMetadata

Object

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

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

DateMetadata

Object

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

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

DateTimeMetadata

Object

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

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

DateValue

Object

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

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

DetectedLanguage

Object

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

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

DocumentError

Object

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

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

DocumentSentimentValue

Перечисление

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

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

DocumentStatistics

Object

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

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

DocumentWarning

Object

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

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

EntitiesDocumentResultWithMetadata

Object

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

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

EntitiesResult

Object

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

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

EntitiesTaskParameters

Object

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

Имя	Тип	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

Object

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

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

Entity

Object

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

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

EntityCategory

Перечисление

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

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

EntityInferenceOptions

Object

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

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

EntityLinkingResult

Object

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

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

EntityLinkingTaskParameters

Object

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

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

EntityLinkingTaskResult

Object

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

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

EntityTag

Object

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

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

EntityWithMetadata

Object

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

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

Error

Object

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

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

ErrorCode

Перечисление

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

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

ErrorResponse

Object

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

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

InformationMetadata

Object

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

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

InformationUnit

Перечисление

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

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

InnerErrorCode

Перечисление

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

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

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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

Object

Содержит keyPhraseResult.

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

KeyPhrasesDocumentResult

Object

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

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

KeyPhraseTaskParameters

Object

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

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

KeyPhraseTaskResult

Object

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

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

LanguageDetectionAnalysisInput

Object

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

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

LanguageDetectionDocumentResult

Object

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

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

LanguageDetectionResult

Object

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

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

LanguageDetectionTaskParameters

Object

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

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

LanguageDetectionTaskResult

Object

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

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

LanguageInput

Object

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

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

LengthMetadata

Object

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

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

LengthUnit

Перечисление

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

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

LinkedEntitiesDocumentResult

Object

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

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

LinkedEntity

Object

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

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

Match

Object

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

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

MatchLongestEntityPolicyType

Object

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

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

MetadataKind

Перечисление

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

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

MultiLanguageAnalysisInput

Object

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

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

MultiLanguageInput

Object

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

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

NumberKind

Перечисление

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

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

NumberMetadata

Object

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

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

NumericRangeMetadata

Object

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

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

OrdinalMetadata

Object

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

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

PiiCategory

Перечисление

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

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

PiiDomain

Перечисление

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

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

PiiEntitiesDocumentResult

Object

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

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

PiiResult

Object

Содержит PiiResult.

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

PiiTaskParameters

Object

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

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

PiiTaskResult

Object

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

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

RangeInclusivity

Перечисление

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

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

RangeKind

Перечисление

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

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

RelativeTo

Перечисление

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

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

RequestStatistics

Object

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

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

ScriptCode

Перечисление

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

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

ScriptKind

Перечисление

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

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

SentenceAssessment

Object

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

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

SentenceSentiment

Object

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

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

SentenceSentimentValue

Перечисление

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

Значение	Описание
negative	Отрицательные тональности
neutral	Нейтральные тональности
positive	Положительные настроения

SentenceTarget

Object

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

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

SentimentAnalysisTaskParameters

Object

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

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

SentimentConfidenceScores

Object

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

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

SentimentDocumentResult

Object

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

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

SentimentResponse

Object

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

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

SentimentTaskResult

Object

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

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

SpeedMetadata

Object

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

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

SpeedUnit

Перечисление

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

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

StringIndexType

Перечисление

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

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

TargetConfidenceScoreLabel

Object

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

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

TargetRelation

Object

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

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

TargetRelationType

Перечисление

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

Значение	Описание
assessment	Отношение оценки.
target	Целевое отношение.

TemperatureMetadata

Object

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

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

TemperatureUnit

Перечисление

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

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

TemporalModifier

Перечисление

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

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

TemporalSetMetadata

Object

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

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

TemporalSpanMetadata

Object

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

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

TemporalSpanValues

Object

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

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

TimeMetadata

Object

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

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

TokenSentimentValue

Перечисление

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

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

VolumeMetadata

Object

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

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

VolumeUnit

Перечисление

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

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

WarningCodeValue

Перечисление

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

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

WeightMetadata

Object

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

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

WeightUnit

Перечисление

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

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