Document Models - Authorize Model Copy

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-11-30

Generuje autoryzację do kopiowania modelu dokumentów do tej lokalizacji z określonym identyfikatorem modelId i opcjonalnym opisem.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Punkt końcowy usługi Analizy dokumentów.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
modelId	True	string	Unikatowa nazwa modelu dokumentu.
description		string	Opis modelu dokumentu.
tags		object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ModelCopyAuthorization	Żądanie zakończyło się pomyślnie.
Other Status Codes	DocumentIntelligenceErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Authorize Copy of Document Model

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
AuthorizeCopyRequest	Żądanie treści autoryzowania kopii modelu dokumentu.
DocumentIntelligenceError	Obiekt błędu.
DocumentIntelligenceErrorResponse	Błąd obiektu odpowiedzi.
DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie.
ModelCopyAuthorization	Autoryzacja kopiowania modelu dokumentu do określonego zasobu docelowego i identyfikatora modelId.

AuthorizeCopyRequest

Żądanie treści autoryzowania kopii modelu dokumentu.

Nazwa	Typ	Opis
description	string	Opis modelu dokumentu.
modelId	string	Unikatowa nazwa modelu dokumentu.
tags	object	Lista atrybutów tagów klucz-wartość skojarzonych z modelem dokumentu.

DocumentIntelligenceError

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	DocumentIntelligenceError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	DocumentIntelligenceInnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

DocumentIntelligenceErrorResponse

Błąd obiektu odpowiedzi.

Nazwa	Typ	Opis
error	DocumentIntelligenceError	Informacje o błędzie.

DocumentIntelligenceInnerError

Obiekt zawierający bardziej szczegółowe informacje o błędzie.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	DocumentIntelligenceInnerError	Błąd wewnętrzny.
message	string	Czytelna dla człowieka reprezentacja błędu.

ModelCopyAuthorization

Autoryzacja kopiowania modelu dokumentu do określonego zasobu docelowego i identyfikatora modelId.

Nazwa	Typ	Opis
accessToken	string	Token używany do autoryzowania żądania.
expirationDateTime	string	Data/godzina wygaśnięcia tokenu dostępu.
targetModelId	string	Identyfikator docelowego modelu dokumentu.
targetModelLocation	string	Adres URL skopiowanego modelu dokumentu na koncie docelowym.
targetResourceId	string	Identyfikator docelowego zasobu platformy Azure, do którego ma zostać skopiowany model dokumentu.
targetResourceRegion	string	Lokalizacja docelowego zasobu platformy Azure, do którego ma zostać skopiowany model dokumentu.

Udostępnij za pośrednictwem