Udostępnij za pośrednictwem

Endpoints - List

  • Odwołanie
Usługa:
Azure AI Services
Wersja interfejsu API:
3.2

Pobiera listę punktów końcowych dla uwierzytelnionej subskrypcji.

GET {endpoint}/speechtotext/v3.2/endpoints
Z parametrami opcjonalnymi: 
GET {endpoint}/speechtotext/v3.2/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).
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.

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
Get all queued endpoints.

Get all endpoints

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2/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/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

Przykładowe żądanie

GET {endpoint}/speechtotext/v3.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'

Przykładowa odpowiedź

Kod stanu:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
    }
  ]
}

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
DataImportFailed

Importowanie danych nie powiodło się.
DeleteNotAllowed

Usuń niedozwolone.
DeployNotAllowed

Wdrażanie jest niedozwolone.
DeployingFailedModel

Wdrażanie modelu nie powiodło się.
EmptyRequest

Puste żądanie.
EndpointCannotBeDefault

Punkt końcowy nie może być domyślny.
EndpointNotUpdatable

Punkt końcowy nie można aktualizować.
EndpointWithoutLogging

Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris

Przekroczono liczbę nagrań uris.
FailedDataset

Zestaw danych, który zakończył się niepowodzeniem.
Forbidden

Zakazany.
InUseViolation

Naruszenie użycia.
InaccessibleCustomerStorage

Niedostępny magazyn klienta.
InvalidAdaptationMapping

Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel

Nieprawidłowy model podstawowy.
InvalidCallbackUri

Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidChannels

Nieprawidłowe kanały.
InvalidCollection

Nieprawidłowa kolekcja.
InvalidDataset

Nieprawidłowy zestaw danych.
InvalidDocument

Nieprawidłowy dokument.
InvalidDocumentBatch

Nieprawidłowa partia dokumentów.
InvalidLocale

Nieprawidłowe ustawienia regionalne.
InvalidLogDate

Nieprawidłowa data dziennika.
InvalidLogEndTime

Nieprawidłowy czas zakończenia dziennika.
InvalidLogId

Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime

Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel

Nieprawidłowy model.
InvalidModelUri

Nieprawidłowy identyfikator URI modelu.
InvalidParameter

Nieprawidłowy parametr.
InvalidParameterValue

Nieprawidłowa wartość parametru.
InvalidPayload

Nieprawidłowy ładunek.
InvalidPermissions

Nieprawidłowe uprawnienia.
InvalidPrerequisite

Nieprawidłowe wymaganie wstępne.
InvalidProductId

Nieprawidłowy identyfikator produktu.
InvalidProject

Nieprawidłowy projekt.
InvalidProjectKind

Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri

Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat

Nieprawidłowy format treści żądania.
InvalidSasValidityDuration

Nieprawidłowy czas ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs

Nieprawidłowy token pomijania dzienników.
InvalidSourceAzureResourceId

Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.
InvalidSubscription

Nieprawidłowa subskrypcja.
InvalidTest

Nieprawidłowy test.
InvalidTimeToLive

Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs

Nieprawidłowy górny element dla dzienników.
InvalidTranscription

Nieprawidłowa transkrypcja.
InvalidWebHookEventKind

Nieprawidłowy rodzaj zdarzenia elementu webhook.
MissingInputRecords

Brak rekordów wejściowych.
ModelCopyAuthorizationExpired

Wygasła metoda ModelCopyAuthorization.
ModelDeploymentNotCompleteState

Wdrożenie modelu nie zostało ukończone.
ModelDeprecated

Model jest przestarzały.
ModelExists

Model istnieje.
ModelMismatch

Niezgodność modelu.
ModelNotDeployable

Nie można wdrożyć modelu.
ModelVersionIncorrect

Nieprawidłowa wersja modelu.
NoUtf8WithBom

Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset

Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch

Niezgodność płci projektu.
QuotaViolation

Naruszenie limitu przydziału.
SingleDefaultEndpoint

Pojedynczy domyślny punkt końcowy.
SkuLimitsExist

Istnieją limity jednostek SKU.
SubscriptionNotFound

Nie można odnaleźć subskrypcji.
UnexpectedError

Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation

Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta

Nieobsługiwana delta.
UnsupportedDynamicConfiguration

Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter

Nieobsługiwany filtr.
UnsupportedLanguageCode

Nieobsługiwany kod języka.
UnsupportedOrderBy

Nieobsługiwana kolejność według.
UnsupportedPagination

Nieobsługiwane stronicowanie.
UnsupportedTimeRange

Nieobsługiwany zakres czasu.

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
Opisz bieżący stan interfejsu API.
text

string

Tekst używany do dostosowywania modelu językowego dla tego punktu końcowego.
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
Conflict

Reprezentowanie kodu błędu powodującego konflikt.
Forbidden

Reprezentowanie niedozwolonego kodu błędu.
InternalCommunicationFailed

Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się.
InternalServerError

Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument

Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest

Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed

Reprezentowanie niedozwolonego kodu błędu.
NotFound

Reprezentacja kodu błędu, który nie został znaleziony.
PipelineError

Reprezentowanie kodu błędu potoku.
ServiceUnavailable

Reprezentowanie niedostępnego kodu błędu usługi.
TooManyRequests

Reprezentując kod błędu zbyt wielu żądań.
Unauthorized

Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity

Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType

Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

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.

Status

Wyliczanie

Status

Wartość Opis
Failed

Długotrwała operacja nie powiodła się.
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.