Endpoints - List

Referenz

Dienst:: Azure AI Services

API-Version:: 2024-02-01-preview

Ruft eine Liste der Endpunkte für die authentifizierte Sprachdienstressource ab.

GET {endpoint}/customvoice/endpoints?api-version=2024-02-01-preview

Mit optionalen Parametern:

GET {endpoint}/customvoice/endpoints?skip={skip}&maxpagesize={maxpagesize}&filter={filter}&api-version=2024-02-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://eastus.api.cognitive.microsoft.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
filter	query		string	Filterbedingung. Unterstützte Eigenschaften: projectId, createdDateTime, Gebietsschema, Art Operatoren: eq, ne werden für alle Eigenschaften unterstützt. gt, ge, lt, le werden für createdDateTime unterstützt. Beispiel: `filter=projectId eq 'Jessica'` (Nach Projekt-ID filtern) `filter=kind eq 'ProfessionalVoice'` (Projekt nach Art filtern) `filter=locale eq 'en-US'` (Filterschulungssatz und -modell nach Gebietsschema) `filter=createdDateTime gt 2022-12-30T23:59:59.99Z` (filterressource created time after 2023-11-01)
maxpagesize	query		integer (int32)	Die maximale Anzahl von Elementen, die in eine einzelne Antwort eingeschlossen werden sollen.
skip	query		integer (int32)	Die Anzahl der zu überspringenden Ergebniselemente.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Sprachressourcenschlüssel an.

Antworten

Name	Typ	Beschreibung
200 OK	PaginatedEndpoints	Erfolg
Other Status Codes	ErrorResponse	Fehler. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

PaginatedEndpoints

Erfolg

Other Status Codes

ErrorResponse

Fehler.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Sprachressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Get all endpoints

Beispielanforderung

HTTP

GET {endpoint}/customvoice/endpoints?api-version=2024-02-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
      "description": "Endpoint for Jessica voice",
      "projectId": "Jessica",
      "modelId": "Jessica",
      "properties": {
        "kind": "HighPerformance"
      },
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    },
    {
      "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
      "description": "Endpoint for Jessica voice",
      "projectId": "Jessica",
      "modelId": "Jessica",
      "properties": {
        "kind": "HighPerformance"
      },
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/customvoice/endpoints?skip=2&maxpagesize=2&api-version=2024-02-01-preview"
}

Definitionen

Name	Beschreibung
Endpoint	Endpoint-Objekt
EndpointKind	Endpunktart
EndpointProperties	Endpunkteigenschaften
Error	Fehler der obersten Ebene folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.
ErrorCode	Fehlercode der obersten Ebene
ErrorResponse	Die Fehlerantwort folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.
InnerError	Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
PaginatedEndpoints	Paginierte Endpunktliste
Status	Status einer Ressource.

Endpoint

Objekt

Endpoint-Objekt

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Endpunktbeschreibung
displayName	string minLength: 1	Endpunktname
id	string (uuid)	Endpunkt-ID
lastActionDateTime	string (date-time)	Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Ressourcen-ID
properties	EndpointProperties	Endpunkteigenschaften
status	Status	Status einer Ressource.

EndpointKind

Enumeration

Endpunktart

Wert	Beschreibung
FastResume
HighPerformance

EndpointProperties

Objekt

Endpunkteigenschaften

Name	Typ	Beschreibung
kind	EndpointKind	Endpunktart

Error

Objekt

Fehler der obersten Ebene folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode der obersten Ebene
details	Error[]	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innererror	InnerError	Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf oberster Ebene.
target	string	Die Quelle des Fehlers. Dies wäre z. B. "Modell" oder "Modell-ID" im Falle eines ungültigen Modells.

ErrorCode

Enumeration

Fehlercode der obersten Ebene

Wert	Beschreibung
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Die Fehlerantwort folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.

Name	Typ	Beschreibung
error	Error	Fehler der obersten Ebene folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit ausführlicheren Details.

InnerError

Objekt

Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Diagnose.
innererror	InnerError	Interner Fehler folgt den Microsoft Azure REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält erforderliche Eigenschaftenfehlercode, Meldung und optionale Eigenschaftenziel, innerer Fehler(dies kann geschachtelt werden).
message	string	Detaillierte Fehlermeldung.
target	string	Die Quelle des Fehlers. Dies wäre z. B. "Modell" oder "Modell-ID" im Falle eines ungültigen Modells.

PaginatedEndpoints

Objekt

Paginierte Endpunktliste

Name	Typ	Beschreibung
nextLink	string (uri)	Link zur nächsten Seite.
value	Endpoint[]	Endpunktliste

Status

Enumeration

Status einer Ressource.

Wert	Beschreibung
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Freigeben über

Endpoints - List

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Get all endpoints

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

PaginatedEndpoints

Status