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

Text Analysis Authoring - Import

  • Ссылка
Служба:
Azure AI Services
Версия API:
2022-05-01

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

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

Параметры URI

Имя В Обязательно Тип Описание
Endpoint
 path True

string

Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

Имя используемого проекта.
api-version
 query True

string

Версия КЛИЕНТСКОго API.

Заголовок запроса

Имя Обязательно Тип Описание
Ocp-Apim-Subscription-Key True

string

Ключ подписки для ресурса службы языка.

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

Имя Обязательно Тип Описание
metadata True

TextAnalysisAuthoringCreateProjectOptions

Представляет метаданные проекта.
projectFileVersion True

string

Версия экспортированного файла.
stringIndexType True

StringIndexType

Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
assets TextAnalysisAuthoringExportedProjectAssets:

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

Ответы

Имя Тип Описание
202 Accepted

Результаты успешного вызова с заголовком Operation-Location, используемым для проверки состояния задания.

Заголовки

operation-location: string
Other Status Codes

ErrorResponse

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

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

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса службы языка.

Тип: apiKey
В: header

Примеры

Successful Import Project

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

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:import?api-version=2022-05-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

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

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

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

Тип проекта.
StringIndexType

Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
TextAnalysisAuthoringCreateProjectOptions

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

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

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

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

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

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

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

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

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

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

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

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

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

Error

Object

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

Имя Тип Описание
code

ErrorCode

Один из определяемых сервером кодов ошибок.
details

Error[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

InnerErrorModel

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

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

ErrorCode

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

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

Значение Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

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

Имя Тип Описание
error

Error

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

InnerErrorCode

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

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

Значение Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
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

Целевой объект ошибки.

ProjectKind

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

Тип проекта.

Значение Описание
CustomEntityRecognition

Для создания модели извлечения для идентификации категорий домена с помощью собственных данных.
CustomMultiLabelClassification

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

Для создания модели классификации для классификации текста с помощью собственных данных. Каждый файл будет иметь только одну метку. Например, файл 1 классифицируется как A, а файл 2 классифицируется как B.

StringIndexType

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

Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

Значение Описание
Utf16CodeUnit

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

TextAnalysisAuthoringCreateProjectOptions

Object

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

Имя Тип Описание
description

string

Описание проекта.
language

string

Язык проекта. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
multilingual

boolean

Будет ли проект использоваться для нескольких языков или нет.
projectKind

ProjectKind

Тип проекта.
projectName

string

Имя нового проекта.
settings

object

Параметры проекта.
storageInputContainerName

string

Имя контейнера хранилища.

TextAnalysisAuthoringExportedClass

Object

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

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

string

Категория класса.

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

Object

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

Имя Тип Описание
dataset

string

Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
entities

TextAnalysisAuthoringExportedDocumentRegion[]

Список меток сущностей, принадлежащих документу.
language

string

Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location

string

Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

Object

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

Имя Тип Описание
documents

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]

Список документов, принадлежащих проекту.
entities

TextAnalysisAuthoringExportedEntity[]

Список сущностей, принадлежащих проекту.
projectKind string:

CustomEntityRecognition

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

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

Object

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

Имя Тип Описание
classes

TextAnalysisAuthoringExportedDocumentClass[]

Классы документов.
dataset

string

Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
language

string

Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location

string

Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

Object

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

Имя Тип Описание
classes

TextAnalysisAuthoringExportedClass[]

Список классов в проекте.
documents

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]

Список документов в проекте.
projectKind string:

CustomMultiLabelClassification

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

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

Object

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

Имя Тип Описание
class

TextAnalysisAuthoringExportedDocumentClass

Класс документов.
dataset

string

Набор данных для этого документа. Допустимыми значениями являются "Train" и "Test".
language

string

Представляет язык документа. Это представление языка BCP-47. Например, используйте "en" для английского, "en-gb" для английского (Великобритания), "es" для испанского и т. д.
location

string

Расположение документа в хранилище.

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

Object

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

Имя Тип Описание
classes

TextAnalysisAuthoringExportedClass[]

Список классов, принадлежащих этому проекту.
documents

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]

Список документов, принадлежащих этому проекту.
projectKind string:

CustomSingleLabelClassification

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

TextAnalysisAuthoringExportedDocumentClass

Object

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

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

string

TextAnalysisAuthoringExportedDocumentEntityLabel

Object

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

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

string

Категория сущностей.
length

integer (int32)

Длина текста сущности.
offset

integer (int32)

Начальная позиция для текста сущности.

TextAnalysisAuthoringExportedDocumentRegion

Object

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

Имя Тип Описание
labels

TextAnalysisAuthoringExportedDocumentEntityLabel[]

Список меток сущностей, принадлежащих этому региону.
regionLength

integer (int32)

Длина текста региона.
regionOffset

integer (int32)

Начальная позиция для региона.

TextAnalysisAuthoringExportedEntity

Object

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

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

string

Категория сущностей.

TextAnalysisAuthoringExportedProject

Object

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

Имя Тип Описание
assets TextAnalysisAuthoringExportedProjectAssets:

Представляет ресурсы проекта.
metadata

TextAnalysisAuthoringCreateProjectOptions

Представляет метаданные проекта.
projectFileVersion

string

Версия экспортированного файла.
stringIndexType

StringIndexType

Задает метод, используемый для интерпретации смещения строк. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.