Document Models - Authorize Model Copy

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-07-31-preview

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

POST {endpoint}/documentintelligence/documentModels:authorizeCopy?api-version=2024-07-31-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string uri	O ponto de extremidade do serviço de Inteligência de Documentos.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Necessário	Tipo	Description
modelId	True	string	Nome exclusivo do modelo de documento.
description		string	Descrição do modelo do documento.
tags		object	Lista de atributos de tag chave-valor associados ao modelo de documento.

Respostas

Name	Tipo	Description
200 OK	CopyAuthorization	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Âmbitos

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

Exemplos

Authorize Copy of Document Model

Pedido de amostra

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:authorizeCopy?api-version=2024-07-31-preview

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

Resposta da amostra

Código de estado:: 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

Name	Description
AuthorizeCopyRequest	Solicitar ao corpo que autorize a cópia do modelo do documento.
CopyAuthorization	Autorização para copiar um modelo de documento para o recurso de destino especificado e modelId.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.

AuthorizeCopyRequest

Solicitar ao corpo que autorize a cópia do modelo do documento.

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

CopyAuthorization

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

Name	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.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	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 por humanos do erro.
target	string	O alvo do erro.

ErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	Error	Informações de erro.

InnerError

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

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

Partilhar via