Text Analysis Authoring - Import

Ссылка

Служба:: Azure AI Services

Версия API:: 2023-04-01

Активирует задание для импорта проекта. Если проект с тем же именем уже существует, данные этого проекта заменяются.

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

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
metadata	True	TextAnalysisAuthoringCreateProjectOptions	Представляет метаданные проекта.
projectFileVersion	True	string	Версия экспортированного файла.
stringIndexType	True	StringIndexType	Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Представляет ресурсы проекта.

Ответы

Имя	Тип	Описание
202 Accepted		Запрос был принят для обработки, но обработка еще не завершена. Заголовки Operation-Location: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

202 Accepted

Запрос был принят для обработки, но обработка еще не завершена.

Заголовки

Operation-Location: string

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

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

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

Примеры

SuccessfulImportProject

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

HTTP

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

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "projectName": "LoanAgreements",
    "multilingual": false,
    "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
    "language": "en"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

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

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

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Определения

Имя	Описание
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
ExportedProject	Представляет экспортируемый проект.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	Представляет параметры, используемые для определения поведения проекта.
StringIndexType
TextAnalysisAuthoringCreateProjectOptions	Представляет параметры, используемые для создания или обновления проекта.
TextAnalysisAuthoringExportedClass	Представляет класс экспортированного проекта.
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	Представляет экспортируемый документ для проекта распознавания пользовательских сущностей.
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	Представляет экспортированные ресурсы для проекта распознавания сущностей.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	Представляет экспортируемый документ пользовательского проекта классификации нескольких меток.
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	Представляет экспортированные ресурсы для пользовательского проекта классификации нескольких меток.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	Представляет экспортируемый документ для пользовательского проекта классификации одноклеек.
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Представляет экспортированные ресурсы для проекта классификации одной метки.
TextAnalysisAuthoringExportedDocumentClass	Представляет метку классификации для документа.
TextAnalysisAuthoringExportedDocumentEntityLabel	Представляет метку сущности для документа.
TextAnalysisAuthoringExportedDocumentEntityRegion	Представляет регион в документе для метки сущностей.
TextAnalysisAuthoringExportedEntity	Представляет сущность в экспортируемом проекте.

Error

Объект ошибки.

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

ErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

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

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

ExportedProject

Представляет экспортируемый проект.

Имя	Тип	Описание
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	Представляет ресурсы проекта.
metadata	TextAnalysisAuthoringCreateProjectOptions	Представляет метаданные проекта.
projectFileVersion	string	Версия экспортированного файла.
stringIndexType	StringIndexType	Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

InnerErrorCode

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

Имя	Тип	Описание
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

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

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

ProjectKind

Имя	Тип	Описание
CustomEntityRecognition	string	Для создания модели извлечения для идентификации категорий домена с помощью собственных данных.
CustomMultiLabelClassification	string	Для создания модели классификации для классификации текста с помощью собственных данных. Каждый файл может иметь одну или несколько меток. Например, файл 1 классифицируется как A, B и C, а файл 2 классифицируется как B и C.
CustomSingleLabelClassification	string	Для создания модели классификации для классификации текста с помощью собственных данных. Каждый файл будет иметь только одну метку. Например, файл 1 классифицируется как A, а файл 2 классифицируется как B.

ProjectSettings

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

Имя	Тип	Описание
confidenceThreshold	number	Порог класса с наивысшей уверенностью, при котором прогноз автоматически будет изменен на "Нет". Значение порога должно быть от 0 до 1 включительно.

StringIndexType

Имя	Тип	Описание
Utf16CodeUnit	string	Значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TextAnalysisAuthoringCreateProjectOptions

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

Имя	Тип	Описание
description	string	Описание проекта.
language	string	Язык проекта. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
multilingual	boolean	Будет ли проект использоваться для нескольких языков или нет.
projectKind	ProjectKind	Тип проекта.
projectName	string	Имя нового проекта.
settings	ProjectSettings	Параметры проекта.
storageInputContainerName	string	Имя контейнера хранилища.

TextAnalysisAuthoringExportedClass

Представляет класс экспортированного проекта.

Имя	Тип	Описание
category	string	Категория класса.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

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

Имя	Тип	Описание
dataset	string	Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	Список меток сущностей, принадлежащих документу.
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

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

Имя	Тип	Описание
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	Список документов, принадлежащих проекту.
entities	TextAnalysisAuthoringExportedEntity[]	Список сущностей, принадлежащих проекту.
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Представляет экспортируемый документ пользовательского проекта классификации нескольких меток.

Имя	Тип	Описание
classes	TextAnalysisAuthoringExportedDocumentClass[]	Классы документов.
dataset	string	Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Представляет экспортированные ресурсы для пользовательского проекта классификации нескольких меток.

Имя	Тип	Описание
classes	TextAnalysisAuthoringExportedClass[]	Список классов в проекте.
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	Список документов в проекте.
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Представляет экспортируемый документ для пользовательского проекта классификации одноклеек.

Имя	Тип	Описание
class	TextAnalysisAuthoringExportedDocumentClass	Класс документов.
dataset	string	Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
language	string	Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location	string	Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Представляет экспортированные ресурсы для проекта классификации одной метки.

Имя	Тип	Описание
classes	TextAnalysisAuthoringExportedClass[]	Список классов, принадлежащих этому проекту.
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	Список документов, принадлежащих этому проекту.
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

Представляет метку классификации для документа.

Имя	Тип	Описание
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

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

Имя	Тип	Описание
category	string	Категория сущностей.
length	integer	Длина текста сущности.
offset	integer	Начальная позиция для текста сущности.

TextAnalysisAuthoringExportedDocumentEntityRegion

Представляет регион в документе для метки сущностей.

Имя	Тип	Описание
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	Список меток сущностей, принадлежащих этому региону.
regionLength	integer	Длина текста региона.
regionOffset	integer	Начальная позиция для региона.

TextAnalysisAuthoringExportedEntity

Представляет сущность в экспортируемом проекте.

Имя	Тип	Описание
category	string	Категория сущностей.

Поделиться через

Text Analysis Authoring - Import

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

SuccessfulImportProject

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

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

Определения

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringCreateProjectOptions

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

Дополнительные ресурсы