Text Analysis Authoring - List Deployments

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2023-04-01

Listy wdrożenia należące do projektu.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments?api-version=2023-04-01

Z parametrami opcjonalnymi:

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nazwa projektu do użycia.
api-version	query	True	string	Wersja interfejsu API klienta.
maxpagesize	query		integer int32	Maksymalna liczba zasobów do uwzględnienia w pojedynczej odpowiedzi.
skip	query		integer int32	Przesunięcie do kolekcji pierwszego zasobu, który ma zostać zwrócony.
top	query		integer int32	Maksymalna liczba zasobów do zwrócenia z kolekcji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TextAnalysisAuthoringProjectDeployments	Lista wszystkich wdrożeń.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

AADToken

Są to przepływy OAuth2 usługi Azure Active Directory . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługuje kont osobistych.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

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

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful List Deployments

Przykładowe żądanie

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments?api-version=2023-04-01

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "deploymentName": "production",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T16:03:51Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    },
    {
      "deploymentName": "staging",
      "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94",
      "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z",
      "lastDeployedDateTime": "2022-04-18T15:53:04Z",
      "deploymentExpirationDate": "2023-10-28",
      "modelTrainingConfigVersion": "2022-05-01"
    }
  ],
  "nextLink": null
}

Definicje

Nazwa	Opis
Error	Obiekt error.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringProjectDeployment	Reprezentuje wdrożenie projektu.
TextAnalysisAuthoringProjectDeployments	Reprezentuje listę pobranych wdrożeń.

Error

Obiekt error.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	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.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt error.

InnerErrorCode