Endpoints - List

Referenz

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

Ruft die Liste der Endpunkte für das authentifizierte Abonnement ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com
filter	query		string	Ein Filterausdruck zum Auswählen einer Teilmenge der verfügbaren Endpunkte. `- 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	Anzahl der Datasets, die übersprungen werden.
top	query		integer int32	Anzahl der Datasets, die nach dem Überspringen eingeschlossen werden.

Antworten

Name	Typ	Beschreibung
200 OK	PaginatedEndpoints	OK Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

PaginatedEndpoints

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem JWT bereit, das vom STS dieser Region zurückgegeben wird. Fügen Sie dem Token den Verwaltungsbereich hinzu, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Get all endpoints

Get all queued endpoints.

Get all endpoints

Beispielanforderung

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Beispiel für eine Antwort

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

Get all queued endpoints.

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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/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"
    }
  ]
}

Definitionen

Name	Beschreibung
DetailedErrorCode	DetailedErrorCode
Endpoint	Endpunkt
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedEndpoints	PaginatedEndpoints
Status	Status

DetailedErrorCode

Name	Typ	Beschreibung
DataImportFailed	string	Fehler beim Datenimport.
DeleteNotAllowed	string	Löschen nicht zulässig.
DeployNotAllowed	string	Bereitstellen ist nicht zulässig.
DeployingFailedModel	string	Bereitstellen eines fehlerhaften Modells.
EmptyRequest	string	Leere Anforderung.
EndpointCannotBeDefault	string	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	string	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	string	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	string	Die Anzahl der Aufzeichnungsuris wurde überschritten.
FailedDataset	string	Fehlgeschlagenes Dataset.
Forbidden	string	Unzulässig.
InUseViolation	string	Bei verwendungsverstößen.
InaccessibleCustomerStorage	string	Nicht zugänglicher Kundenspeicher.
InvalidAdaptationMapping	string	Ungültige Anpassungszuordnung.
InvalidBaseModel	string	Ungültiges Basismodell.
InvalidCallbackUri	string	Ungültiger Rückruf-URI.
InvalidCollection	string	Ungültige Auflistung.
InvalidDataset	string	Ungültiges Dataset.
InvalidDocument	string	Ungültiges Dokument.
InvalidDocumentBatch	string	Ungültiger Dokumentbatch.
InvalidLocale	string	Ungültiges Gebietsschema.
InvalidLogDate	string	Ungültiges Protokolldatum.
InvalidLogEndTime	string	Ungültige Protokollendzeit.
InvalidLogId	string	Ungültige Protokoll-ID.
InvalidLogStartTime	string	Ungültige Protokollstartzeit.
InvalidModel	string	Ungültiges Modell.
InvalidModelUri	string	Ungültiger Modell-URI.
InvalidParameter	string	Ungültiger Parameter.
InvalidParameterValue	string	Ungültiger Parameterwert.
InvalidPayload	string	Ungültige Nutzlast.
InvalidPermissions	string	Ungültige Berechtigungen.
InvalidPrerequisite	string	Ungültige Voraussetzung.
InvalidProductId	string	Ungültige Produkt-ID.
InvalidProject	string	Ungültiges Projekt.
InvalidProjectKind	string	Ungültige Projektart.
InvalidRecordingsUri	string	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	string	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	string	Ungültige sas-Gültigkeitsdauer.
InvalidSkipTokenForLogs	string	Ungültiges Überspringen von Token für Protokolle.
InvalidSourceAzureResourceId	string	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	string	Ungültiges Abonnement.
InvalidTest	string	Ungültiger Test.
InvalidTimeToLive	string	Ungültige Gültigkeitsdauer.
InvalidTopForLogs	string	Ungültiger Oberteil für Protokolle.
InvalidTranscription	string	Ungültige Transkription.
InvalidWebHookEventKind	string	Ungültige Web hook-Ereignisart.
MissingInputRecords	string	Fehlende Eingabedatensätze.
ModelCopyOperationExists	string	Der Modellkopiervorgang ist vorhanden.
ModelDeploymentNotCompleteState	string	Der Zustand der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	string	Das Modell ist veraltet.
ModelExists	string	Das Modell ist vorhanden.
ModelMismatch	string	Modellkonflikt.
ModelNotDeployable	string	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	string	Modellversion falsch.
NoUtf8WithBom	string	Kein utf8 mit Bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Nur eine der URLs, container oder datasets.
ProjectGenderMismatch	string	Projekt gender mismatch.
QuotaViolation	string	Kontingentverletzung.
SingleDefaultEndpoint	string	Einzelner Standardendpunkt.
SkuLimitsExist	string	Sku-Grenzwerte sind vorhanden.
SubscriptionNotFound	string	Abonnement wurde nicht gefunden.
UnexpectedError	string	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	string	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	string	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	string	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	string	Nicht unterstützter Filter.
UnsupportedLanguageCode	string	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	string	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	string	Nicht unterstützte Paginierung.
UnsupportedTimeRange	string	Nicht unterstützte Zeitbereiche.

Endpoint

Endpunkt

Name	Typ	Beschreibung
createdDateTime	string	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Anzeigename des Objekts.
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	EndpointLinks
locale	string	Das Gebietsschema der enthaltenen Daten.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Zustands der API
text	string	Der Text, der zum Anpassen eines Sprachmodells für diesen Endpunkt verwendet wird.

EndpointLinks

Name	Typ	Beschreibung
logs	string	Die Audio- und Transkriptionsprotokolle für diesen Endpunkt. Weitere Informationen finden Sie unter Operation "Endpoints_ListLogs".
restConversation	string	Der REST-Endpunkt für Anforderungen bis zu 60 Sekunden.
restDictation	string	Der REST-Endpunkt für Anforderungen von bis zu 60 Sekunden, der das Diktieren von Satzzeichen unterstützt.
restInteractive	string	Der REST-Endpunkt für kurze Anforderungen bis zu 15 Sekunden.
webSocketConversation	string	Der Speech SDK-Endpunkt für lange Anforderungen mit mehreren Endergebnissen.
webSocketDictation	string	Der Speech SDK-Endpunkt für lange Anforderungen mit mehreren Endergebnissen, der das Diktieren von Satzzeichen unterstützt.
webSocketInteractive	string	Der Speech SDK-Endpunkt für kurze Anforderungen bis zu 15 Sekunden mit einem einzelnen Endergebnis.

EndpointProperties

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird entfernt, nachdem die E-Mail erfolgreich gesendet wurde.
error	EntityError	EntityError
loggingEnabled	boolean	Ein Wert, der angibt, ob die Inhaltsprotokollierung (Audio- & Transkriptionen) für eine Bereitstellung verwendet wird.
timeToLive	string	Wie lange der Endpunkt im System aufbewahrt wird. Sobald der Endpunkt die Gültigkeitsdauer nach abschluss erreicht hat (erfolgreich oder fehlgeschlagen), wird er automatisch gelöscht. Wenn Sie diesen Wert oder die Einstellung nicht auf 0 festlegen, wird das automatische Löschen deaktiviert. Die längste unterstützte Dauer beträgt 31 Tage. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

EntityReference

Name	Typ	Beschreibung
self	string	Der Speicherort der Entität, auf die verwiesen wird.

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Allgemeine Fehlercodes.
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

Name	Typ	Beschreibung
Conflict	string	Stellt den Konfliktfehlercode dar.
Forbidden	string	Stellt den unzulässigen Fehlercode dar.
InternalCommunicationFailed	string	Stellt den Fehlercode für interne Kommunikationsfehler dar.
InternalServerError	string	Stellt den Fehlercode des internen Servers dar.
InvalidArgument	string	Stellt den Fehlercode des ungültigen Arguments dar.
InvalidRequest	string	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	string	Stellt den nicht zulässigen Fehlercode dar.
NotFound	string	Stellt den Fehlercode nicht gefunden dar.
PipelineError	string	Stellt den Fehlercode für die Pipeline dar.
ServiceUnavailable	string	Stellt den Nicht verfügbaren Fehlercode des Diensts dar.
TooManyRequests	string	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	string	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	string	Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.
UnsupportedMediaType	string	Stellt den fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercodeenume.
details	object	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

PaginatedEndpoints

Name	Typ	Beschreibung
@nextLink	string	Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Entitäten verfügbar sind; andernfalls NULL.
values	Endpoint[]	Eine Liste von Entitäten, die entweder durch die übergebenen Abfrageparameter "skip" und "top" oder deren Standardwerte beschränkt sind. Beim Durchlaufen einer Liste mit Paginierung und parallelem Löschen von Entitäten werden einige Entitäten in den Ergebnissen übersprungen. Es wird empfohlen, eine Liste auf dem Client zu erstellen und nach dem Abrufen der vollständigen Liste zu löschen.

Name

Typ

Beschreibung

@nextLink

string

Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Entitäten verfügbar sind; andernfalls NULL.

values

Endpoint[]

Eine Liste von Entitäten, die entweder durch die übergebenen Abfrageparameter "skip" und "top" oder deren Standardwerte beschränkt sind.

Beim Durchlaufen einer Liste mit Paginierung und parallelem Löschen von Entitäten werden einige Entitäten in den Ergebnissen übersprungen. Es wird empfohlen, eine Liste auf dem Client zu erstellen und nach dem Abrufen der vollständigen Liste zu löschen.

Status

Name	Typ	Beschreibung
Failed	string	Der Vorgang mit langer Ausführungsdauer ist fehlgeschlagen.
NotStarted	string	Der lang andauernde Vorgang wurde noch nicht gestartet.
Running	string	Der Vorgang mit langer Ausführungszeit wird derzeit verarbeitet.
Succeeded	string	Der lang andauernde Vorgang wurde erfolgreich abgeschlossen.

Freigeben über

Endpoints - List

URI-Parameter

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Get all endpoints

Beispielanforderung

Beispiel für eine Antwort

Get all queued endpoints.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status

Zusätzliche Ressourcen