Partager via


Endpoints - Get

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

GET {endpoint}/speechtotext/v3.1/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

Ok

En-têtes

Retry-After: integer

Other Status Codes

Error

Une erreur est survenue.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez votre clé de compte Cognitive Services ici.

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.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

Exemple de réponse

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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

ErrorCode

InnerError

InnerError

Status

Statut

DetailedErrorCode

DetailedErrorCode

Nom Type Description
DataImportFailed

string

Échec de l’importation des données.

DeleteNotAllowed

string

Suppression non autorisée.

DeployNotAllowed

string

Déploiement non autorisé.

DeployingFailedModel

string

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

EmptyRequest

string

Requête vide.

EndpointCannotBeDefault

string

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

EndpointNotUpdatable

string

Point de terminaison non modifiable.

EndpointWithoutLogging

string

Point de terminaison sans journalisation.

ExceededNumberOfRecordingsUris

string

Nombre d’URI d’enregistrements dépassé.

FailedDataset

string

Échec du jeu de données.

Forbidden

string

Interdit.

InUseViolation

string

Violation en cours d’utilisation.

InaccessibleCustomerStorage

string

Stockage client inaccessible.

InvalidAdaptationMapping

string

Mappage d’adaptation non valide.

InvalidBaseModel

string

Modèle de base non valide.

InvalidCallbackUri

string

URI de rappel non valide.

InvalidCollection

string

Collection non valide.

InvalidDataset

string

Jeu de données non valide.

InvalidDocument

string

Document non valide.

InvalidDocumentBatch

string

Lot de documents non valide.

InvalidLocale

string

Paramètres régionaux non valides.

InvalidLogDate

string

Date de journal non valide.

InvalidLogEndTime

string

Heure de fin du journal non valide.

InvalidLogId

string

ID de journal non valide.

InvalidLogStartTime

string

Heure de début du journal non valide.

InvalidModel

string

Modèle non valide.

InvalidModelUri

string

URI de modèle non valide.

InvalidParameter

string

Paramètre non valide.

InvalidParameterValue

string

Valeur de paramètre non valide.

InvalidPayload

string

Charge utile non valide.

InvalidPermissions

string

Autorisations non valides.

InvalidPrerequisite

string

Prérequis non valides.

InvalidProductId

string

ID de produit non valide.

InvalidProject

string

Projet non valide.

InvalidProjectKind

string

Type de projet non valide.

InvalidRecordingsUri

string

URI des enregistrements non valides.

InvalidRequestBodyFormat

string

Format du corps de la demande non valide.

InvalidSasValidityDuration

string

Durée de validité sas non valide.

InvalidSkipTokenForLogs

string

Jeton d’évitement non valide pour les journaux.

InvalidSubscription

string

Abonnement non valide.

InvalidTest

string

Test non valide.

InvalidTimeToLive

string

Durée de vie non valide.

InvalidTopForLogs

string

Haut non valide pour les journaux.

InvalidTranscription

string

Transcription non valide.

InvalidWebHookEventKind

string

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

MissingInputRecords

string

Enregistrements d’entrée manquants.

ModelDeploymentNotCompleteState

string

État non terminé du déploiement du modèle.

ModelDeprecated

string

Modèle déconseillé.

ModelExists

string

Le modèle existe.

ModelMismatch

string

Incompatibilité du modèle.

ModelNotDeployable

string

Modèle non déployable.

ModelVersionIncorrect

string

Version du modèle incorrecte.

NoUtf8WithBom

string

Pas d’utf8 avec bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Une seule des URL, conteneur ou jeu de données.

ProjectGenderMismatch

string

Projet d’incompatibilité entre les sexes.

QuotaViolation

string

Violation de quota.

SingleDefaultEndpoint

string

Point de terminaison par défaut unique.

SkuLimitsExist

string

Il existe des limites de référence SKU.

SubscriptionNotFound

string

Abonnement introuvable.

UnexpectedError

string

Erreur inattendue.

UnsupportedClassBasedAdaptation

string

Adaptation basée sur la classe non prise en charge.

UnsupportedDelta

string

Delta non pris en charge.

UnsupportedDynamicConfiguration

string

Configuration dynamique non prise en charge.

UnsupportedFilter

string

Filtre non pris en charge.

UnsupportedLanguageCode

string

Code de langue non pris en charge.

UnsupportedOrderBy

string

Commande non prise en charge par.

UnsupportedPagination

string

Pagination non prise en charge.

UnsupportedTimeRange

string

Intervalle de temps non pris en charge.

Endpoint

Point de terminaison

Nom Type Description
createdDateTime

string

Horodatage de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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 autorisée de la clé 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

Horodatage lorsque le status actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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

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

Nom Type Description
logs

string

Journaux audio et de transcription pour ce point de terminaison. Pour plus d’informations, consultez l’opération « Endpoints_ListLogs ».

restConversation

string

Point de terminaison REST pour les requêtes jusqu’à 60 secondes.

restDictation

string

Point de terminaison REST pour les requêtes jusqu’à 60 secondes, prenant en charge la dictée des marques de ponctuation.

restInteractive

string

Point de terminaison REST pour les requêtes courtes jusqu’à 15 secondes.

webSocketConversation

string

Point de terminaison du KIT de développement logiciel (SDK) Speech pour les demandes longues avec plusieurs résultats finaux.

webSocketDictation

string

Point de terminaison du KIT de développement logiciel (SDK) Speech pour les demandes longues avec plusieurs résultats finaux, prenant en charge la dictée des marques de ponctuation.

webSocketInteractive

string

Point de terminaison du KIT de développement logiciel (SDK) Speech pour les requêtes courtes jusqu’à 15 secondes avec un seul résultat final.

EndpointProperties

EndpointProperties

Nom Type Description
email

string

Adresse e-mail à laquelle envoyer Notifications par e-mail au cas où l’opération se termine. La valeur sera 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 de conservation du point de terminaison dans le système. Une fois que le point de terminaison atteint le temps de vie après l’achèvement (réussite ou échec), 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 plus longue durée 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

EntityError

Nom Type Description
code

string

Code de cette erreur.

message

string

Message correspondant à cette erreur.

EntityReference

EntityReference

Nom Type Description
self

string

Emplacement de l’entité référencée.

Error

Erreur

Nom Type Description
code

ErrorCode

ErrorCode
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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).

message

string

Message d’erreur de haut niveau.

target

string

Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide.

ErrorCode

ErrorCode

Nom Type Description
Conflict

string

Représentant le code d’erreur de conflit.

Forbidden

string

Représentant le code d’erreur interdit.

InternalCommunicationFailed

string

Représentant le code d’erreur d’échec de la communication interne.

InternalServerError

string

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

InvalidArgument

string

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

InvalidRequest

string

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

NotAllowed

string

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

NotFound

string

Représentant le code d’erreur introuvable.

PipelineError

string

Représentant le code d’erreur du pipeline.

ServiceUnavailable

string

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

TooManyRequests

string

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

Unauthorized

string

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

UnprocessableEntity

string

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

UnsupportedMediaType

string

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

InnerError

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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).

message

string

Message d’erreur de haut niveau.

target

string

Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide.

Status

Statut

Nom Type Description
Failed

string

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

NotStarted

string

L’opération de longue durée n’a pas encore démarré.

Running

string

L’opération de longue durée est en cours de traitement.

Succeeded

string

L’opération de longue durée s’est terminée avec succès.