Document Models - Authorize Model Copy

Szolgáltatás:

Azure AI Services

API-verzió:

2024-11-30

A dokumentummodell erre a helyre való másolásának engedélyezése a megadott modelId azonosítóval és opcionális leírással.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A Document Intelligence szolgáltatás végpontja.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem törzse

Name	Kötelező	Típus	Description
modelId	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Egyedi dokumentummodell neve.
description		string maxLength: 4096	A dokumentummodell leírása.
tags		object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

Válaszok

Name	Típus	Description
200 OK	ModelCopyAuthorization	A kérés sikeres volt.
Other Status Codes	DocumentIntelligenceErrorResponse	Váratlan hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: accessCode
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe: https://login.microsoftonline.com/common/oauth2/token

Hatókörök

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

Példák

Authorize Copy of Document Model

Mintakérelem

HTTP

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

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
AuthorizeCopyRequest	Kérje meg a törzset, hogy engedélyezze a dokumentummodell másolatát.
DocumentIntelligenceError	A hibaobjektum.
DocumentIntelligenceErrorResponse	Hibaválasz-objektum.
DocumentIntelligenceInnerError	Egy objektum, amely részletesebb információkat tartalmaz a hibáról.
ModelCopyAuthorization	Dokumentummodell másolásának engedélyezése a megadott célerőforrásba és modelId-be.

AuthorizeCopyRequest

Objektum

Kérje meg a törzset, hogy engedélyezze a dokumentummodell másolatát.

Name	Típus	Description
description	string maxLength: 4096	A dokumentummodell leírása.
modelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	Egyedi dokumentummodell neve.
tags	object	A dokumentummodellhez társított kulcs-érték címkeattribútumok listája.

DocumentIntelligenceError

Objektum

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	DocumentIntelligenceError[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	DocumentIntelligenceInnerError	Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról.
message	string	A hiba ember által olvasható ábrázolása.
target	string	A hiba célja.

DocumentIntelligenceErrorResponse

Objektum

Hibaválasz-objektum.

Name	Típus	Description
error	DocumentIntelligenceError	Hibainformációk.

DocumentIntelligenceInnerError

Objektum

Egy objektum, amely részletesebb információkat tartalmaz a hibáról.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	DocumentIntelligenceInnerError	Belső hiba.
message	string	A hiba ember által olvasható ábrázolása.

ModelCopyAuthorization

Objektum

Dokumentummodell másolásának engedélyezése a megadott célerőforrásba és modelId-be.

Name	Típus	Description
accessToken	string	A kérés engedélyezéséhez használt jogkivonat.
expirationDateTime	string (date-time)	A hozzáférési jogkivonat lejáratának dátuma/időpontja.
targetModelId	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$	A céldokumentum-modell azonosítója.
targetModelLocation	string (uri)	A másolt dokumentummodell URL-címe a célfiókban.
targetResourceId	string	Annak a cél Azure-erőforrásnak az azonosítója, ahová a dokumentummodellt át kell másolni.
targetResourceRegion	string	A cél Azure-erőforrás helye, ahová a dokumentummodellt át kell másolni.