Projects - List Endpoints

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.2-preview.2

Pobiera listę punktów końcowych dla określonego projektu.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints

Z parametrami opcjonalnymi:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints?skip={skip}&top={top}&filter={filter}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Identyfikator projektu.
filter	query		string	Wyrażenie filtrowania służące do wybierania podzestawu dostępnych punktów końcowych. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=locale eq 'en-US'`
skip	query		integer (int32)	Liczba zestawów danych, które zostaną pominięte.
top	query		integer (int32)	Liczba zestawów danych, które zostaną uwzględnione po pomijaniu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PaginatedEndpoints	OK Nagłówki Retry-After: integer
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

200 OK

PaginatedEndpoints

Nagłówki

Retry-After: integer

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z zestawu JWT zwróconego przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Get all endpoints

Przykładowe żądanie

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Przykładowa odpowiedź

Kod stanu:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definicje

Nazwa	Opis
DetailedErrorCode	DetailedErrorCode
Endpoint	Punkt końcowy
EndpointLinks	Punkty końcoweLinki
EndpointProperties	Właściwości punktu końcowego
EntityError	EntityError
EntityReference	EntityReference
Error	Błąd
ErrorCode	Kod błędu
InnerError	InnerError
PaginatedEndpoints	Punkty końcowe podzielone na strony
Status	Status

DetailedErrorCode

Wyliczanie

DetailedErrorCode

Wartość	Opis
InvalidParameterValue	Nieprawidłowa wartość parametru.
InvalidRequestBodyFormat	Nieprawidłowy format treści żądania.
EmptyRequest	Puste żądanie.
MissingInputRecords	Brak rekordów wejściowych.
InvalidDocument	Nieprawidłowy dokument.
ModelVersionIncorrect	Nieprawidłowa wersja modelu.
InvalidDocumentBatch	Nieprawidłowa partia dokumentów.
UnsupportedLanguageCode	Nieobsługiwany kod języka.
DataImportFailed	Importowanie danych nie powiodło się.
InUseViolation	Naruszenie użycia.
InvalidLocale	Nieprawidłowe ustawienia regionalne.
InvalidBaseModel	Nieprawidłowy model podstawowy.
InvalidAdaptationMapping	Nieprawidłowe mapowanie adaptacji.
InvalidDataset	Nieprawidłowy zestaw danych.
InvalidTest	Nieprawidłowy test.
FailedDataset	Zestaw danych, który zakończył się niepowodzeniem.
InvalidModel	Nieprawidłowy model.
InvalidTranscription	Nieprawidłowa transkrypcja.
InvalidPayload	Nieprawidłowy ładunek.
InvalidParameter	Nieprawidłowy parametr.
EndpointWithoutLogging	Punkt końcowy bez rejestrowania.
InvalidPermissions	Nieprawidłowe uprawnienia.
InvalidPrerequisite	Nieprawidłowe wymaganie wstępne.
InvalidProductId	Nieprawidłowy identyfikator produktu.
InvalidSubscription	Nieprawidłowa subskrypcja.
InvalidProject	Nieprawidłowy projekt.
InvalidProjectKind	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	Nieprawidłowy identyfikator URI nagrań.
OnlyOneOfUrlsOrContainerOrDataset	Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ExceededNumberOfRecordingsUris	Przekroczono liczbę nagrań uris.
ModelMismatch	Niezgodność modelu.
ProjectGenderMismatch	Niezgodność płci projektu.
ModelDeprecated	Model jest przestarzały.
ModelExists	Model istnieje.
ModelNotDeployable	Nie można wdrożyć modelu.
EndpointNotUpdatable	Punkt końcowy nie można aktualizować.
SingleDefaultEndpoint	Pojedynczy domyślny punkt końcowy.
EndpointCannotBeDefault	Punkt końcowy nie może być domyślny.
InvalidModelUri	Nieprawidłowy identyfikator URI modelu.
SubscriptionNotFound	Nie można odnaleźć subskrypcji.
QuotaViolation	Naruszenie limitu przydziału.
UnsupportedDelta	Nieobsługiwana delta.
UnsupportedFilter	Nieobsługiwany filtr.
UnsupportedPagination	Nieobsługiwane stronicowanie.
UnsupportedDynamicConfiguration	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedOrderBy	Nieobsługiwana kolejność według.
NoUtf8WithBom	Brak utf8 z bom.
ModelDeploymentNotCompleteState	Wdrożenie modelu nie zostało ukończone.
SkuLimitsExist	Istnieją limity jednostek SKU.
DeployingFailedModel	Wdrażanie modelu nie powiodło się.
UnsupportedTimeRange	Nieobsługiwany zakres czasu.
InvalidLogDate	Nieprawidłowa data dziennika.
InvalidLogId	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	Nieprawidłowy czas rozpoczęcia dziennika.
InvalidLogEndTime	Nieprawidłowy czas zakończenia dziennika.
InvalidTopForLogs	Nieprawidłowy górny element dla dzienników.
InvalidSkipTokenForLogs	Nieprawidłowy token pomijania dzienników.
DeleteNotAllowed	Usuń niedozwolone.
Forbidden	Zakazany.
DeployNotAllowed	Wdrażanie jest niedozwolone.
UnexpectedError	Nieoczekiwany błąd.
InvalidCollection	Nieprawidłowa kolekcja.
InvalidCallbackUri	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidSasValidityDuration	Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InaccessibleCustomerStorage	Niedostępny magazyn klienta.
UnsupportedClassBasedAdaptation	Nieobsługiwana adaptacja oparta na klasach.
InvalidWebHookEventKind	Nieprawidłowy rodzaj zdarzenia elementu webhook.
InvalidTimeToLive	Nieprawidłowy czas wygaśnięcia.
InvalidSourceAzureResourceId	Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
ModelCopyOperationExists	Istnieje operacja kopiowania modelu.

Endpoint

Objekt

Punkt końcowy

Nazwa	Typ	Opis
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
description	string	Opis obiektu.
displayName	string minLength: 1	Nazwa wyświetlana obiektu.
lastActionDateTime	string (date-time)	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	Punkty końcoweLinki
locale	string minLength: 1	Ustawienia regionalne zawartych danych.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	Właściwości punktu końcowego
self	string (uri)	Lokalizacja tej jednostki.
status	Status	Status Opis bieżącego stanu interfejsu API
text	string	Tekst używany do dostosowywania modelu językowego dla tego punktu końcowego.

EndpointLinks

Objekt

Punkty końcoweLinki

Nazwa	Typ	Opis
logs	string (uri)	Dzienniki audio i transkrypcji dla tego punktu końcowego. Aby uzyskać więcej informacji, zobacz operację "Endpoints_ListLogs".
restConversation	string (uri)	Punkt końcowy REST dla żądań do 60 sekund.
restDictation	string (uri)	Punkt końcowy REST dla żądań do 60 sekund, obsługujący dyktowanie znaków interpunkcyjnych.
restInteractive	string (uri)	Punkt końcowy REST dla krótkich żądań do 15 sekund.
webSocketConversation	string (uri)	Punkt końcowy zestawu SPEECH SDK dla długich żądań z wieloma końcowymi wynikami.
webSocketDictation	string (uri)	Punkt końcowy zestawu SPEECH SDK dla długich żądań z wieloma końcowymi wynikami, obsługujący dyktowanie znaków interpunkcyjnych.
webSocketInteractive	string (uri)	Punkt końcowy zestawu SPEECH SDK dla krótkich żądań do 15 sekund z pojedynczym wynikiem końcowym.

EndpointProperties

Objekt

Właściwości punktu końcowego

Nazwa	Typ	Opis
email	string	Adres e-mail do wysyłania powiadomień e-mail na adres w przypadku zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.
error	EntityError	EntityError
loggingEnabled	boolean	Wartość wskazująca, czy rejestrowanie zawartości (transkrypcje audio &) jest używane do wdrożenia.
timeToLive	string	Jak długo punkt końcowy będzie przechowywany w systemie. Gdy punkt końcowy osiągnie czas wygaśnięcia po zakończeniu (powodzenie lub niepowodzenie), zostanie automatycznie usunięty. Ustawienie tej wartości lub wartości 0 spowoduje wyłączenie automatycznego usuwania. Najdłuższy obsługiwany czas trwania to 31 dni. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Objekt

EntityError

Nazwa	Typ	Opis
code	string	Kod tego błędu.
message	string	Komunikat o tym błędzie.

EntityReference

Objekt

EntityReference

Nazwa	Typ	Opis
self	string (uri)	Lokalizacja odwoływania się do jednostki.

Error

Objekt

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Wyliczanie

Kod błędu

Wartość	Opis
InvalidRequest	Reprezentowanie nieprawidłowego kodu błędu żądania.
InvalidArgument	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InternalServerError	Reprezentowanie wewnętrznego kodu błędu serwera.
ServiceUnavailable	Reprezentowanie niedostępnego kodu błędu usługi.
NotFound	Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError	Reprezentowanie kodu błędu potoku.
Conflict	Reprezentowanie kodu błędu powodującego konflikt.
InternalCommunicationFailed	Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
Forbidden	Reprezentowanie niedozwolonego kodu błędu.
NotAllowed	Reprezentowanie niedozwolonego kodu błędu.
Unauthorized	Reprezentowanie nieautoryzowanego kodu błędu.
UnsupportedMediaType	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.
TooManyRequests	Reprezentując kod błędu zbyt wielu żądań.
UnprocessableEntity	Reprezentowanie nieprzetworzonego kodu błędu jednostki.

InnerError

Objekt

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowy wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi w witrynie https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

PaginatedEndpoints

Objekt

Punkty końcowe podzielone na strony

Nazwa	Typ	Opis
@nextLink	string (uri)	Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.
values	Endpoint[]	Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne. Podczas iteracji za pośrednictwem listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.

Nazwa

Typ

Opis

@nextLink

string (uri)

Link do następnego zestawu wyników podzielonych na strony, jeśli jest dostępnych więcej jednostek; w przeciwnym razie wartość null.

values

Endpoint[]

Lista jednostek ograniczonych przez przekazane parametry zapytania "skip" i "top" lub ich wartości domyślne.

Podczas iteracji za pośrednictwem listy przy użyciu stronicowania i usuwania jednostek równolegle niektóre jednostki zostaną pominięte w wynikach. Zaleca się utworzenie listy na kliencie i usunięcie jej po pobraniu pełnej listy.

Status

Wyliczanie

Status

Wartość	Opis
NotStarted	Długotrwała operacja nie została jeszcze uruchomiona.
Running	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	Długotrwała operacja została pomyślnie ukończona.
Failed	Długotrwała operacja nie powiodła się.

Udostępnij za pośrednictwem

Projects - List Endpoints

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Get all endpoints

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status