Document Models - Authorize Model Copy

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-30

Gera autorização para copiar um modelo de documento para esse local com modelId e descrição opcional especificadas.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
modelId	True	string	Nome exclusivo do modelo de documento.
description		string	Descrição do modelo de documento.
tags		object	Lista de atributos de marca chave-valor associados ao modelo de documento.

Respostas

Nome	Tipo	Description
200 OK	ModelCopyAuthorization	A solicitação foi bem-sucedida.
Other Status Codes	DocumentIntelligenceErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Authorize Copy of Document Model

Solicitação de exemplo

HTTP

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

{
  "modelId": "targetModel",
  "description": "Target model description"
}

Resposta de exemplo

Código de status:: 200

{
  "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService",
  "targetResourceRegion": "targetResourceRegion",
  "targetModelId": "targetModel",
  "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel",
  "accessToken": "accessToken",
  "expirationDateTime": "2021-09-23T09:12:54.552Z"
}

Definições

Nome	Description
AuthorizeCopyRequest	Solicitar corpo para autorizar a cópia do modelo de documento.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.
ModelCopyAuthorization	Autorização para copiar um modelo de documento para o recurso de destino e modelId especificados.

AuthorizeCopyRequest

Solicitar corpo para autorizar a cópia do modelo de documento.

Nome	Tipo	Description
description	string	Descrição do modelo de documento.
modelId	string	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

DocumentIntelligenceErrorResponse

Objeto de resposta de erro.

Nome	Tipo	Description
error	DocumentIntelligenceError	Informações de erro.

DocumentIntelligenceInnerError

Um objeto que contém informações mais específicas sobre o erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.

ModelCopyAuthorization

Autorização para copiar um modelo de documento para o recurso de destino e modelId especificados.

Nome	Tipo	Description
accessToken	string	Token usado para autorizar a solicitação.
expirationDateTime	string	Data/hora em que o token de acesso expira.
targetModelId	string	Identificador do modelo de documento de destino.
targetModelLocation	string	URL do modelo de documento copiado na conta de destino.
targetResourceId	string	ID do recurso do Azure de destino para o qual o modelo de documento deve ser copiado.
targetResourceRegion	string	Local do recurso do Azure de destino para o qual o modelo de documento deve ser copiado.

Compartilhar via