Partager via


Endpoints - Update

Mises à jour les métadonnées du point de terminaison identifié par l’ID donné.

PATCH {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.

Corps de la demande

Media Types: "application/json", "application/merge-patch+json"

Nom Type Description
customProperties

object

Propriétés personnalisées de cette entité. La longueur de clé maximale 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 de l'objet.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

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

Update an endpoint

Exemple de requête

PATCH {endpoint}/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/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

Exemple de réponse

{
  "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

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EndpointUpdate

EndpointUpdate

EntityError

EntityError

EntityReference

EntityReference

Error

Erreur

ErrorCode

ErrorCode

InnerError

InnerError

Status

Statut

DetailedErrorCode

DetailedErrorCode

Valeur Description
DataImportFailed

Échec de l’importation des données.

DeleteNotAllowed

Suppression non autorisée.

DeployNotAllowed

Déploiement 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’URI d’enregistrements dépassé.

FailedDataset

Échec du jeu de données.

Forbidden

Interdit.

InUseViolation

Violation en cours 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é sas non valide.

InvalidSkipTokenForLogs

Jeton d’évitement non valide pour les journaux.

InvalidSourceAzureResourceId

ID de ressource Azure source non valide.

InvalidSubscription

Abonnement non valide.

InvalidTest

Test non valide.

InvalidTimeToLive

Durée de vie non valide.

InvalidTopForLogs

Haut non valide pour les journaux.

InvalidTranscription

Transcription non valide.

InvalidWebHookEventKind

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

MissingInputRecords

Enregistrements d’entrée manquants.

ModelCopyOperationExists

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

ModelDeploymentNotCompleteState

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

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 des URL, conteneur ou jeu de données.

ProjectGenderMismatch

Projet d’incompatibilité entre les sexes.

QuotaViolation

Violation de quota.

SingleDefaultEndpoint

Point de terminaison par défaut unique.

SkuLimitsExist

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

SubscriptionNotFound

Abonnement introuvable.

UnexpectedError

Erreur inattendue.

UnsupportedClassBasedAdaptation

Adaptation basée sur la classe 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

Point de terminaison

Nom Type Description
createdDateTime

string (date-time)

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

minLength: 1

Nom complet de l’objet.

lastActionDateTime

string (date-time)

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

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.

EndpointLinks

Nom Type Description
logs

string (uri)

Journaux 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 jusqu’à 60 secondes.

restDictation

string (uri)

Point de terminaison REST pour les requêtes 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 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 (uri)

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

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Nom Type Description
contentLoggingEnabled

boolean

Valeur indiquant si la journalisation du contenu (transcriptions audio &) est utilisée pour un déploiement.

EndpointUpdate

EndpointUpdate

Nom Type Description
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 de l'objet.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EntityError

EntityError

Nom Type Description
code

string

Code de cette erreur.

message

string

Message correspondant à cette erreur.

EntityReference

EntityReference

Nom Type Description
self

string (uri)

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

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 d’échec de la communication interne.

InternalServerError

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

InvalidArgument

Représentant le code d’erreur de l’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 de trop 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 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

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 avec succès.