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

Document Classifiers - Authorize Classifier Copy

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-11-30

Создает авторизацию для копирования классификатора документов в это расположение с указанным классификатором и необязательным описанием.

POST {endpoint}/documentintelligence/documentClassifiers:authorizeCopy?api-version=2024-11-30

Параметры URI

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

string (uri)

Конечная точка службы аналитики документов.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

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

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

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Уникальное имя классификатора документов.
description

string

maxLength: 4096

Описание классификатора документов.
tags

object

Список атрибутов тега "ключ-значение", связанных с классификатором документов.

Ответы

Имя Тип Описание
200 OK

ClassifierCopyAuthorization

Запрос выполнен успешно.
Other Status Codes

DocumentIntelligenceErrorResponse

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

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

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

Примеры

Authorize Copy of Document Classifier

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

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers:authorizeCopy?api-version=2024-11-30

{
  "classifierId": "targetClassifier",
  "description": "Target classifier description"
}

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

Код состояния:
200 
{
  "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
  "targetResourceRegion": "targetResourceRegion",
  "targetClassifierId": "targetClassifier",
  "targetClassifierLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier",
  "accessToken": "accessToken",
  "expirationDateTime": "2021-09-23T09:12:54.552Z"
}

Определения

Имя Описание
AuthorizeClassifierCopyRequest

Текст запроса на авторизацию копирования классификатора документов.
ClassifierCopyAuthorization

Авторизация для копирования классификатора документов в указанный целевой ресурс и классификаторId.
DocumentIntelligenceError

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

Объект ответа об ошибке.
DocumentIntelligenceInnerError

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

AuthorizeClassifierCopyRequest

Object

Текст запроса на авторизацию копирования классификатора документов.

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

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Уникальное имя классификатора документов.
description

string

maxLength: 4096

Описание классификатора документов.
tags

object

Список атрибутов тега "ключ-значение", связанных с классификатором документов.

ClassifierCopyAuthorization

Object

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

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

string

Маркер, используемый для авторизации запроса.
expirationDateTime

string (date-time)

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

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Идентификатор целевого классификатора документов.
targetClassifierLocation

string (uri)

URL-адрес скопированного классификатора документов в целевой учетной записи.
targetResourceId

string

Идентификатор целевого ресурса Azure, в который следует скопировать классификатор документов.
targetResourceRegion

string

Расположение целевого ресурса Azure, в который следует скопировать классификатор документов.

DocumentIntelligenceError

Object

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

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

string

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

DocumentIntelligenceError[]

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

DocumentIntelligenceInnerError

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

string

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

string

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

DocumentIntelligenceErrorResponse

Object

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

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

DocumentIntelligenceError

Сведения об ошибке.

DocumentIntelligenceInnerError

Object

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

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

string

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

DocumentIntelligenceInnerError

Внутренняя ошибка.
message

string

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