Endpoints - Get

Service:
Azure AI Services
Version d'API:
v3.2-preview.2

Obtient le point de terminaison identifié par l’ID donné.

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

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).
id
 path True

string (uuid)

Identificateur du point de terminaison.

Réponses

Nom Type Description
200 OK

Endpoint

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 an endpoint

Exemple de requête

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

Exemple de réponse

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

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
Status

Statut

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur Description
InvalidParameterValue

Valeur de paramètre non valide.
InvalidRequestBodyFormat

Format du corps de la demande non valide.
EmptyRequest

Requête vide.
MissingInputRecords

Enregistrements d’entrée manquants.
InvalidDocument

Document non valide.
ModelVersionIncorrect

Version du modèle incorrecte.
InvalidDocumentBatch

Lot de documents non valide.
UnsupportedLanguageCode

Code de langue non pris en charge.
DataImportFailed

Échec de l’importation de données.
InUseViolation

En cas de violation d’utilisation.
InvalidLocale

Paramètres régionaux non valides.
InvalidBaseModel

Modèle de base non valide.
InvalidAdaptationMapping

Mappage d’adaptation non valide.
InvalidDataset

Jeu de données non valide.
InvalidTest

Test non valide.
FailedDataset

Jeu de données ayant échoué.
InvalidModel

Modèle non valide.
InvalidTranscription

Transcription non valide.
InvalidPayload

Charge utile non valide.
InvalidParameter

Paramètre non valide.
EndpointWithoutLogging

Point de terminaison sans journalisation.
InvalidPermissions

Autorisations non valides.
InvalidPrerequisite

Prérequis non valides.
InvalidProductId

ID de produit non valide.
InvalidSubscription

Abonnement non valide.
InvalidProject

Projet non valide.
InvalidProjectKind

Type de projet non valide.
InvalidRecordingsUri

Uri des enregistrements non valides.
OnlyOneOfUrlsOrContainerOrDataset

Une seule URL ou conteneur ou jeu de données.
ExceededNumberOfRecordingsUris

Nombre dépassé d’uris d’enregistrement.
ModelMismatch

Incompatibilité du modèle.
ProjectGenderMismatch

Incompatibilité entre les sexes du projet.
ModelDeprecated

Modèle déconseillé.
ModelExists

Le modèle existe.
ModelNotDeployable

Modèle non déployable.
EndpointNotUpdatable

Point de terminaison non modifiable.
SingleDefaultEndpoint

Point de terminaison par défaut unique.
EndpointCannotBeDefault

Le point de terminaison ne peut pas être par défaut.
InvalidModelUri

URI de modèle non valide.
SubscriptionNotFound

Abonnement introuvable.
QuotaViolation

Violation de quota.
UnsupportedDelta

Delta non pris en charge.
UnsupportedFilter

Filtre non pris en charge.
UnsupportedPagination

Pagination non prise en charge.
UnsupportedDynamicConfiguration

Configuration dynamique non prise en charge.
UnsupportedOrderBy

Commande non prise en charge par.
NoUtf8WithBom

Pas d’utf8 avec bom.
ModelDeploymentNotCompleteState

Le déploiement du modèle n’est pas terminé.
SkuLimitsExist

Les limites de référence SKU existent.
DeployingFailedModel

Déploiement d’un modèle ayant échoué.
UnsupportedTimeRange

Intervalle de temps non pris en charge.
InvalidLogDate

Date de journal non valide.
InvalidLogId

ID de journal non valide.
InvalidLogStartTime

Heure de début du journal non valide.
InvalidLogEndTime

Heure de fin du journal non valide.
InvalidTopForLogs

Top non valide pour les journaux d’activité.
InvalidSkipTokenForLogs

Jeton d’ignorer non valide pour les journaux d’activité.
DeleteNotAllowed

Supprimer non autorisé.
Forbidden

Interdit.
DeployNotAllowed

Déployer non autorisé.
UnexpectedError

Erreur inattendue.
InvalidCollection

Collection non valide.
InvalidCallbackUri

URI de rappel non valide.
InvalidSasValidityDuration

Durée de validité de sas non valide.
InaccessibleCustomerStorage

Stockage client inaccessible.
UnsupportedClassBasedAdaptation

Adaptation basée sur des classes non prise en charge.
InvalidWebHookEventKind

Type d’événement web hook non valide.
InvalidTimeToLive

Heure de vie non valide.
InvalidSourceAzureResourceId

ID de ressource Azure source non valide.
ModelCopyOperationExists

L’opération de copie de modèle existe.

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

minLength: 1

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

minLength: 1

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.
Object

EndpointLinks

Nom Type Description
logs

string (uri)

Journaux d’activité audio et de transcription pour ce point de terminaison. Pour plus d’informations, consultez l’opération « Endpoints_ListLogs ».
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
InvalidRequest

Représentant le code d’erreur de requête non valide.
InvalidArgument

Représentant le code d’erreur d’argument non valide.
InternalServerError

Représentant le code d’erreur du serveur interne.
ServiceUnavailable

Représentant le code d’erreur indisponible du service.
NotFound

Représentant le code d’erreur introuvable.
PipelineError

Représentant le code d’erreur du pipeline.
Conflict

Représentant le code d’erreur de conflit.
InternalCommunicationFailed

Représentant le code d’erreur de communication interne ayant échoué.
Forbidden

Représentant le code d’erreur interdit.
NotAllowed

Représentant le code d’erreur non autorisé.
Unauthorized

Représentant le code d’erreur non autorisé.
UnsupportedMediaType

Représentant le code d’erreur du type de média non pris en charge.
TooManyRequests

Représentant le code d’erreur trop grand nombre de requêtes.
UnprocessableEntity

Représentant le code d’erreur d’entité non traité.

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.

Status

Énumération

Statut

Valeur Description
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.
Failed

L’opération de longue durée a échoué.