Endpoints - List

Référence

Service:: Azure AI Services

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

Obtient une liste de points de terminaison pour la ressource de service Speech authentifiée.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://eastus.api.cognitive.microsoft.com).
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
filter	query		string	Condition de filtre. Propriétés prises en charge : projectId, createdDateTime, paramètres régionaux, type opérateurs : eq, ne sont pris en charge pour toutes les propriétés. gt, ge, lt, le sont pris en charge pour createdDateTime. exemple : `filter=projectId eq 'Jessica'` (filtrer par ID de projet) `filter=kind eq 'ProfessionalVoice'` (filtrer le projet par type) `filter=locale eq 'en-US'` (jeu d’entraînement de filtre et modèle par paramètres régionaux) `filter=createdDateTime gt 2022-12-30T23:59:59.99Z` (temps de création de ressource de filtre après 2023-11-01)
maxpagesize	query		integer (int32)	Nombre maximal d’éléments à inclure dans une seule réponse.
skip	query		integer (int32)	Nombre d’éléments de résultat à ignorer.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Fournissez votre clé de ressource Speech ici.

Réponses

Nom	Type	Description
200 OK	PaginatedEndpoints	Succès
Other Status Codes	ErrorResponse	Une erreur s’est produite. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

PaginatedEndpoints

Succès

Other Status Codes

ErrorResponse

Une erreur s’est produite.

En-têtes

x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de ressource Speech ici.

Type: apiKey
Dans: header

Exemples

Get all endpoints

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
Endpoint	Objet Endpoint
EndpointKind	Type de point de terminaison
EndpointProperties	Propriétés du point de terminaison
Error	L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.
ErrorCode	Code d’erreur de niveau supérieur
ErrorResponse	La réponse d’erreur suit les instructions de l’API REST Microsoft Azure qui sont disponibles sur https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient le code d’erreur des propriétés requises, le message et la cible de propriétés facultatives, erreur interne (cela peut être imbriqué).
PaginatedEndpoints	Liste de points de terminaison paginés
Status	État d’une ressource.

Endpoint

Object

Objet Endpoint

Nom	Type	Description
createdDateTime	string (date-time)	Horodatage lors de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Description du point de terminaison
displayName	string minLength: 1	Nom du point de terminaison
id	string (uuid)	ID de point de terminaison
lastActionDateTime	string (date-time)	Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir 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]$	ID de ressource
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID de ressource
properties	EndpointProperties	Propriétés du point de terminaison
status	Status	État d’une ressource.

EndpointKind

Énumération

Type de point de terminaison

Valeur	Description
FastResume
HighPerformance

EndpointProperties

Object

Propriétés du point de terminaison

Nom	Type	Description
kind	EndpointKind	Type de point de terminaison

Error

Object

L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

Nom	Type	Description
code	ErrorCode	Code d’erreur de niveau supérieur
details	Error[]	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innererror	InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient le code d’erreur des propriétés requises, le message et la cible de propriétés facultatives, erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de niveau supérieur.
target	string	Source de l’erreur. Par exemple, il s’agirait de « modèle » ou d'« ID de modèle » en cas de modèle non valide.

ErrorCode

Énumération

Code d’erreur de niveau supérieur

Valeur	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

La réponse d’erreur suit les instructions de l’API REST Microsoft Azure qui sont disponibles sur https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nom	Type	Description
error	Error	L’erreur de niveau supérieur suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient une erreur de niveau supérieur avec le code d’erreur, le message, les détails, la cible et une erreur interne avec des détails plus descriptifs.

InnerError

Object

L’erreur interne suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient le code d’erreur des propriétés requises, le message et la cible de propriétés facultatives, erreur interne (cela peut être imbriqué).

Nom	Type	Description
code	string	Code d’erreur détaillé pour faciliter le diagnostic.
innererror	InnerError	L’erreur interne suit les instructions de l’API REST Microsoft Azure qui est disponible à https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Cela contient le code d’erreur des propriétés requises, le message et la cible de propriétés facultatives, erreur interne (cela peut être imbriqué).
message	string	Message d’erreur détaillé.
target	string	Source de l’erreur. Par exemple, il s’agirait de « modèle » ou d'« ID de modèle » en cas de modèle non valide.

PaginatedEndpoints

Object

Liste de points de terminaison paginés

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante.
value	Endpoint[]	Liste des points de terminaison

Status

Énumération

État d’une ressource.

Valeur	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Partager via

Endpoints - List

Paramètres URI

En-tête de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Get all endpoints

Exemple de requête

Exemple de réponse

Définitions

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

PaginatedEndpoints

Status