Dela via

Document Models - Authorize Model Copy

  • Referens
Tjänst:
Azure AI Services
API-version:
2024-11-30

Genererar auktorisering för att kopiera en dokumentmodell till den här platsen med angivet modelId och valfri beskrivning.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (uri)

Slutpunkten för document intelligence-tjänsten.
api-version
 query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
modelId True

string

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

Unikt dokumentmodellnamn.
description

string

maxLength: 4096

Beskrivning av dokumentmodell.
tags

object

Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

Svar

Name Typ Description
200 OK

ModelCopyAuthorization

Begäran har slutförts.
Other Status Codes

DocumentIntelligenceErrorResponse

Ett oväntat felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Authorize Copy of Document Model

Exempelbegäran

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

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

Exempelsvar

Statuskod:
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"
}

Definitioner

Name Description
AuthorizeCopyRequest

Begär brödtext för att auktorisera dokumentmodellkopiering.
DocumentIntelligenceError

Felobjektet.
DocumentIntelligenceErrorResponse

Felsvarsobjekt.
DocumentIntelligenceInnerError

Ett objekt som innehåller mer specifik information om felet.
ModelCopyAuthorization

Auktorisering för att kopiera en dokumentmodell till den angivna målresursen och modelId.

AuthorizeCopyRequest

Objekt

Begär brödtext för att auktorisera dokumentmodellkopiering.

Name Typ Description
description

string

maxLength: 4096

Beskrivning av dokumentmodell.
modelId

string

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

Unikt dokumentmodellnamn.
tags

object

Lista över taggattribut för nyckel/värde som är associerade med dokumentmodellen.

DocumentIntelligenceError

Objekt

Felobjektet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
details

DocumentIntelligenceError[]

En matris med information om specifika fel som ledde till det rapporterade felet.
innererror

DocumentIntelligenceInnerError

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

En mänsklig läsbar representation av felet.
target

string

Målet för felet.

DocumentIntelligenceErrorResponse

Objekt

Felsvarsobjekt.

Name Typ Description
error

DocumentIntelligenceError

Felinformation.

DocumentIntelligenceInnerError

Objekt

Ett objekt som innehåller mer specifik information om felet.

Name Typ Description
code

string

En av en serverdefinierad uppsättning felkoder.
innererror

DocumentIntelligenceInnerError

Inre fel.
message

string

En mänsklig läsbar representation av felet.

ModelCopyAuthorization

Objekt

Auktorisering för att kopiera en dokumentmodell till den angivna målresursen och modelId.

Name Typ Description
accessToken

string

Token som används för att auktorisera begäran.
expirationDateTime

string (date-time)

Datum/tid när åtkomsttoken upphör att gälla.
targetModelId

string

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

Identifierare för måldokumentmodellen.
targetModelLocation

string (uri)

URL för den kopierade dokumentmodellen i målkontot.
targetResourceId

string

ID för den Azure-målresurs där dokumentmodellen ska kopieras till.
targetResourceRegion

string

Plats för den Azure-målresurs där dokumentmodellen ska kopieras till.