Get Endpoints - Get Endpoints

Référence

Service:: Azure AI Services

Version d'API:: v3.0

Obtient la liste des points de terminaison de l’abonnement authentifié.

GET {Endpoint}/speechtotext/v3.0/endpoints

Avec des paramètres facultatifs:

GET {Endpoint}/speechtotext/v3.0/endpoints?skip={skip}&top={top}

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://westus.api.cognitive.microsoft.com).
skip	query		integer (int32)	Nombre de jeux de données ignorés.
top	query		integer (int32)	Nombre de jeux de données qui seront inclus après l’ignorer.

Réponses

Nom	Type	Description
200 OK	PaginatedEndpoints	D’ACCORD En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur s’est produite.

Nom

Type

Description

200 OK

PaginatedEndpoints

D’ACCORD

En-têtes

Retry-After: integer

Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

Type: apiKey
Dans: header

Authorization

Fournissez un jeton d’accès à partir du JWT retourné par le STS de cette région. Veillez à ajouter l’étendue de gestion au jeton en ajoutant la chaîne de requête suivante à l’URL STS : ?scope=speechservicesmanagement

Type: apiKey
Dans: header

Exemples

Get all endpoints

Exemple de requête

HTTP

GET https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/endpoints?skip=0&top=3

Exemple de réponse

Code d’état:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/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.0/endpoints?skip=3&top=3"
}

Définitions

Nom	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Point de terminaison
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Erreur
ErrorCode	Code d'erreur
InnerError	InnerError
PaginatedEndpoints	PaginédEndpoints
Status	Statut

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur	Description
DataImportFailed	Échec de l’importation de données.
DeleteNotAllowed	Supprimer non autorisé.
DeployNotAllowed	Déployer non autorisé.
DeployingFailedModel	Déploiement d’un modèle ayant échoué.
EmptyRequest	Requête vide.
EndpointCannotBeDefault	Le point de terminaison ne peut pas être par défaut.
EndpointNotUpdatable	Point de terminaison non modifiable.
EndpointWithoutLogging	Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris	Nombre dépassé d’uris d’enregistrement.
FailedDataset	Jeu de données ayant échoué.
Forbidden	Interdit.
InUseViolation	En cas de violation d’utilisation.
InaccessibleCustomerStorage	Stockage client inaccessible.
InvalidAdaptationMapping	Mappage d’adaptation non valide.
InvalidBaseModel	Modèle de base non valide.
InvalidCallbackUri	URI de rappel non valide.
InvalidCollection	Collection non valide.
InvalidDataset	Jeu de données non valide.
InvalidDocument	Document non valide.
InvalidDocumentBatch	Lot de documents non valide.
InvalidLocale	Paramètres régionaux non valides.
InvalidLogDate	Date de journal non valide.
InvalidLogEndTime	Heure de fin du journal non valide.
InvalidLogId	ID de journal non valide.
InvalidLogStartTime	Heure de début du journal non valide.
InvalidModel	Modèle non valide.
InvalidModelUri	URI de modèle non valide.
InvalidParameter	Paramètre non valide.
InvalidParameterValue	Valeur de paramètre non valide.
InvalidPayload	Charge utile non valide.
InvalidPermissions	Autorisations non valides.
InvalidPrerequisite	Prérequis non valides.
InvalidProductId	ID de produit non valide.
InvalidProject	Projet non valide.
InvalidProjectKind	Type de projet non valide.
InvalidRecordingsUri	Uri des enregistrements non valides.
InvalidRequestBodyFormat	Format du corps de la demande non valide.
InvalidSasValidityDuration	Durée de validité de sas non valide.
InvalidSkipTokenForLogs	Jeton d’ignorer non valide pour les journaux d’activité.
InvalidSubscription	Abonnement non valide.
InvalidTest	Test non valide.
InvalidTimeToLive	Heure de vie non valide.
InvalidTopForLogs	Top non valide pour les journaux d’activité.
InvalidTranscription	Transcription non valide.
InvalidWebHookEventKind	Type d’événement web hook non valide.
MissingInputRecords	Enregistrements d’entrée manquants.
ModelDeploymentNotCompleteState	Le déploiement du modèle n’est pas terminé.
ModelDeprecated	Modèle déconseillé.
ModelExists	Le modèle existe.
ModelMismatch	Incompatibilité du modèle.
ModelNotDeployable	Modèle non déployable.
ModelVersionIncorrect	Version du modèle incorrecte.
NoUtf8WithBom	Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset	Une seule URL ou conteneur ou jeu de données.
ProjectGenderMismatch	Incompatibilité entre les sexes du projet.
QuotaViolation	Violation de quota.
SingleDefaultEndpoint	Point de terminaison par défaut unique.
SkuLimitsExist	Les limites de référence SKU existent.
SubscriptionNotFound	Abonnement introuvable.
UnexpectedError	Erreur inattendue.
UnsupportedClassBasedAdaptation	Adaptation basée sur des classes non prise en charge.
UnsupportedDelta	Delta non pris en charge.
UnsupportedDynamicConfiguration	Configuration dynamique non prise en charge.
UnsupportedFilter	Filtre non pris en charge.
UnsupportedLanguageCode	Code de langue non pris en charge.
UnsupportedOrderBy	Commande non prise en charge par.
UnsupportedPagination	Pagination non prise en charge.
UnsupportedTimeRange	Intervalle de temps non pris en charge.

Endpoint

Object

Point de terminaison

Nom	Type	Description
createdDateTime	string (date-time)	Horodatage 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).
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom complet de l’objet.
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).
links	EndpointLinks	EndpointLinks
locale	string	Paramètres régionaux des données contenues.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API
text	string	Texte utilisé pour adapter un modèle de langage pour ce point de terminaison.

EndpointLinks

Object

EndpointLinks

Nom	Type	Description
logs	string (uri)	Journaux d’activité audio et de transcription pour ce point de terminaison.
restConversation	string (uri)	Point de terminaison REST pour les requêtes allant jusqu’à 60 secondes.
restDictation	string (uri)	Point de terminaison REST pour les requêtes allant jusqu’à 60 secondes, prenant en charge la dictée des marques de ponctuation.
restInteractive	string (uri)	Point de terminaison REST pour les requêtes courtes jusqu’à 15 secondes.
webSocketConversation	string (uri)	Point de terminaison du Kit de développement logiciel (SDK) Speech pour les demandes longues avec plusieurs résultats finaux.
webSocketDictation	string (uri)	Point de terminaison du SDK Speech pour les demandes longues avec plusieurs résultats finaux, prenant en charge la dictée de marques de ponctuation.
webSocketInteractive	string (uri)	Point de terminaison du Kit de développement logiciel (SDK) Speech pour les requêtes courtes jusqu’à 15 secondes avec un résultat final unique.

EndpointProperties

Object

EndpointProperties

Nom	Type	Description
email	string	Adresse e-mail à laquelle envoyer des notifications par e-mail au cas où l’opération se termine. La valeur est supprimée après l’envoi de l’e-mail.
error	EntityError	EntityError
loggingEnabled	boolean	Valeur indiquant si la journalisation du contenu (transcriptions audio &) est utilisée pour un déploiement.
timeToLive	string	Durée pendant laquelle le point de terminaison sera conservé dans le système. Une fois que le point de terminaison atteint le temps de vie après l’achèvement (réussi ou ayant échoué), il est automatiquement supprimé. Le fait de ne pas définir cette valeur ou ce paramètre sur 0 désactive la suppression automatique. La durée la plus longue prise en charge est de 31 jours. La durée est encodée en tant que durée ISO 8601 (« PnYnMnDTnHnMnS », voir https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Object

EntityError

Nom	Type	Description
code	string	Code de cette erreur.
message	string	Message de cette erreur.

EntityReference

Object

EntityReference

Nom	Type	Description
self	string (uri)	Emplacement de l’entité référencée.

Error

Object

Erreur

Nom	Type	Description
code	ErrorCode	Code d'erreur Codes d’erreur de haut niveau.
details	Error[]	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

Énumération

Code d'erreur

Valeur	Description
Conflict	Représentant le code d’erreur de conflit.
Forbidden	Représentant le code d’erreur interdit.
InternalCommunicationFailed	Représentant le code d’erreur de communication interne ayant échoué.
InternalServerError	Représentant le code d’erreur du serveur interne.
InvalidArgument	Représentant le code d’erreur d’argument non valide.
InvalidRequest	Représentant le code d’erreur de requête non valide.
NotAllowed	Représentant le code d’erreur non autorisé.
NotFound	Représentant le code d’erreur introuvable.
PipelineError	Représentant le code d’erreur du pipeline.
ServiceUnavailable	Représentant le code d’erreur indisponible du service.
TooManyRequests	Représentant le code d’erreur trop grand nombre de requêtes.
Unauthorized	Représentant le code d’erreur non autorisé.
UnprocessableEntity	Représentant le code d’erreur d’entité non traité.
UnsupportedMediaType	Représentant le code d’erreur du type de média non pris en charge.

InnerError

Object

InnerError

Nom	Type	Description
code	DetailedErrorCode	DetailedErrorCode Énumération détaillée du code d’erreur.
details	object	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

PaginatedEndpoints

Object

PaginédEndpoints

Nom	Type	Description
@nextLink	string (uri)	Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.
values	Endpoint[]	Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut. Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

Nom

Type

Description

@nextLink

string (uri)

Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.

values

Endpoint[]

Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut.

Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

Status

Énumération

Statut

Valeur	Description
Failed	L’opération de longue durée a échoué.
NotStarted	L’opération de longue durée n’a pas encore démarré.
Running	L’opération de longue durée est en cours de traitement.
Succeeded	L’opération de longue durée s’est terminée.

Partager via

Get Endpoints - Get Endpoints

Paramètres URI

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Authorization

Exemples

Get all endpoints

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status