Endpoints - Update

Referencia

Service:: Azure AI Services

API Version:: v3.2-preview.2

Frissítések az adott azonosító által azonosított végpont metaadatait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	A végpont azonosítója.

Kérelem törzse

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

Name	Típus	Description
customProperties	object	Az entitás egyéni tulajdonságai. A maximális megengedett kulcshossz 64 karakter, a megengedett érték maximális hossza 256 karakter, az engedélyezett bejegyzések száma pedig 10.
description	string	Az objektum leírása.
displayName	string	Az objektum neve.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

Válaszok

Name	Típus	Description
200 OK	Endpoint	OK Headers Retry-After: integer
Other Status Codes	Error	Hiba történt.

Name

Típus

Description

200 OK

Endpoint

Headers

Retry-After: integer

Other Status Codes

Error

Hiba történt.

Biztonság

Ocp-Apim-Subscription-Key

Itt adja meg a Cognitive Services-fiókkulcsot.

Type: apiKey
In: header

Authorization

Adjon meg egy hozzáférési jogkivonatot a régió STS által visszaadott JWT-ből. Győződjön meg arról, hogy hozzáadja a felügyeleti hatókört a jogkivonathoz, ha hozzáadja a következő lekérdezési sztringet az STS URL-címéhez: ?scope=speechservicesmanagement

Type: apiKey
In: header

Példák

Update an endpoint

Sample Request

HTTP

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

Sample Response

Status code:: 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"
}

Definíciók

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Végpont
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EndpointPropertiesUpdate	EndpointPropertiesUpdate
EndpointUpdate	EndpointUpdate
EntityError	EntityError
EntityReference	EntityReference
Error	Hiba
ErrorCode	ErrorCode
InnerError	InnerError
Status	Állapot

DetailedErrorCode

Name	Típus	Description
DataImportFailed	string	Az adatimportálás sikertelen volt.
DeleteNotAllowed	string	A törlés nem engedélyezett.
DeployNotAllowed	string	Az üzembe helyezés nem engedélyezett.
DeployingFailedModel	string	Sikertelen modell üzembe helyezése.
EmptyRequest	string	Üres kérelem.
EndpointCannotBeDefault	string	A végpont nem lehet alapértelmezett.
EndpointNotUpdatable	string	A végpont nem frissíthető.
EndpointWithoutLogging	string	Végpont naplózás nélkül.
ExceededNumberOfRecordingsUris	string	Túllépte a felvételek URI-jainak számát.
FailedDataset	string	Nem sikerült az adathalmaz.
Forbidden	string	Tiltott.
InUseViolation	string	Használaton belüli szabálysértés.
InaccessibleCustomerStorage	string	Elérhetetlen ügyféltároló.
InvalidAdaptationMapping	string	Érvénytelen adaptációs leképezés.
InvalidBaseModel	string	Érvénytelen alapmodell.
InvalidCallbackUri	string	Érvénytelen visszahívási URI.
InvalidCollection	string	Érvénytelen gyűjtemény.
InvalidDataset	string	Érvénytelen adatkészlet.
InvalidDocument	string	Érvénytelen dokumentum.
InvalidDocumentBatch	string	Érvénytelen dokumentumköteg.
InvalidLocale	string	Érvénytelen területi beállítás.
InvalidLogDate	string	Érvénytelen naplódátum.
InvalidLogEndTime	string	Érvénytelen a napló befejezési ideje.
InvalidLogId	string	Érvénytelen naplóazonosító.
InvalidLogStartTime	string	Érvénytelen a napló kezdési időpontja.
InvalidModel	string	Érvénytelen modell.
InvalidModelUri	string	Érvénytelen modell URI-ja.
InvalidParameter	string	Érvénytelen paraméter.
InvalidParameterValue	string	Érvénytelen paraméterérték.
InvalidPayload	string	Érvénytelen hasznos adat.
InvalidPermissions	string	Érvénytelen engedélyek.
InvalidPrerequisite	string	Érvénytelen előfeltétel.
InvalidProductId	string	Érvénytelen termékazonosító.
InvalidProject	string	Érvénytelen projekt.
InvalidProjectKind	string	Érvénytelen projekttípus.
InvalidRecordingsUri	string	Érvénytelen felvételek URI-ja.
InvalidRequestBodyFormat	string	Érvénytelen kérelemtörzs-formátum.
InvalidSasValidityDuration	string	Érvénytelen sas-érvényességi időtartam.
InvalidSkipTokenForLogs	string	Érvénytelen kihagyó jogkivonat a naplókhoz.
InvalidSourceAzureResourceId	string	Érvénytelen forrás Azure-erőforrás-azonosító.
InvalidSubscription	string	Érvénytelen előfizetés.
InvalidTest	string	Érvénytelen teszt.
InvalidTimeToLive	string	Érvénytelen élettartam.
InvalidTopForLogs	string	A naplók felső része érvénytelen.
InvalidTranscription	string	Érvénytelen átírás.
InvalidWebHookEventKind	string	Érvénytelen webhookesemény-típus.
MissingInputRecords	string	Hiányzó bemeneti rekordok.
ModelCopyOperationExists	string	Létezik modellmásolási művelet.
ModelDeploymentNotCompleteState	string	A modell üzembe helyezése nem fejeződött be.
ModelDeprecated	string	A modell elavult.
ModelExists	string	A modell létezik.
ModelMismatch	string	Modelleltérés.
ModelNotDeployable	string	A modell nem helyezhető üzembe.
ModelVersionIncorrect	string	A modell verziója helytelen.
NoUtf8WithBom	string	Nincs utf8 a bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Csak egy URL-cím, tároló vagy adatkészlet.
ProjectGenderMismatch	string	A projekt neme nem egyezik.
QuotaViolation	string	Kvóta megsértése.
SingleDefaultEndpoint	string	Egyetlen alapértelmezett végpont.
SkuLimitsExist	string	A termékváltozatra vonatkozó korlátozások léteznek.
SubscriptionNotFound	string	Az előfizetés nem található.
UnexpectedError	string	Váratlan hiba.
UnsupportedClassBasedAdaptation	string	Nem támogatott osztályalapú adaptáció.
UnsupportedDelta	string	Nem támogatott változás.
UnsupportedDynamicConfiguration	string	Nem támogatott dinamikus konfiguráció.
UnsupportedFilter	string	Nem támogatott szűrő.
UnsupportedLanguageCode	string	Nem támogatott nyelvi kód.
UnsupportedOrderBy	string	Nem támogatott sorrend szerint.
UnsupportedPagination	string	Nem támogatott lapozás.
UnsupportedTimeRange	string	Nem támogatott időtartomány.

Endpoint

Végpont

Name	Típus	Description
createdDateTime	string	Az objektum létrehozásának időbélyege. Az időbélyeg iso 8601-es dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, a maximális megengedett értékhossz 256 karakter, az engedélyezett bejegyzések száma pedig 10.
description	string	Az objektum leírása.
displayName	string	Az objektum megjelenítendő neve.
lastActionDateTime	string	Az aktuális állapot megadásának időbélyege. Az időbélyeg iso 8601-es dátum- és időformátumként van kódolva ("ÉÉÉÉ-HH-NNH:mm:ssZ", lásd: https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	EndpointLinks
locale	string	A tartalmazott adatok területi beállítása.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string	Az entitás helye.
status	Status	Állapot Az API aktuális állapotának leírása
text	string	A végpont nyelvi modelljének adaptálásához használt szöveg.

EndpointLinks

Name	Típus	Description
logs	string	A végpont hang- és átiratnaplói. További részletekért lásd a "Endpoints_ListLogs" műveletet.
restConversation	string	A kérések REST-végpontja legfeljebb 60 másodpercig.
restDictation	string	A kérések LEGFELJEBB 60 másodperces REST-végpontja, amely támogatja az írásjelek diktálását.
restInteractive	string	A REST-végpont legfeljebb 15 másodperces rövid kérésekhez.
webSocketConversation	string	A Speech SDK végpontja több végső eredménnyel rendelkező hosszú kérésekhez.
webSocketDictation	string	A Speech SDK végpontja több végső eredménnyel rendelkező hosszú kérésekhez, amelyek támogatják az írásjelek diktálását.
webSocketInteractive	string	A Speech SDK-végpont legfeljebb 15 másodperces rövid kérésekhez egyetlen végső eredménnyel.

EndpointProperties

Name	Típus	Description
email	string	Az e-mail-értesítések küldéséhez használt e-mail-cím, ha a művelet befejeződik. Az érték az e-mail sikeres elküldése után törlődik.
error	EntityError	EntityError
loggingEnabled	boolean	Egy érték, amely azt jelzi, hogy a rendszer tartalomnaplózást (hang & átiratokat) használ-e az üzembe helyezéshez.
timeToLive	string	Mennyi ideig marad a végpont a rendszerben. Ha a végpont eléri a befejezés utáni élettartamot (sikeres vagy sikertelen), a végpont automatikusan törlődik. Ha ezt az értéket nem állítja be, vagy 0-ra állítja, az letiltja az automatikus törlést. A leghosszabb támogatott időtartam 31 nap. Az időtartam ISO 8601-es időtartamként van kódolva ("PnYnMnDTnHnMnS", lásd: https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

Name	Típus	Description
contentLoggingEnabled	boolean	Egy érték, amely azt jelzi, hogy a rendszer tartalomnaplózást (hang & átiratokat) használ-e az üzembe helyezéshez.

EndpointUpdate

Name	Típus	Description
customProperties	object	Az entitás egyéni tulajdonságai. A maximálisan megengedett kulcshossz 64 karakter, a maximális megengedett értékhossz 256 karakter, az engedélyezett bejegyzések száma pedig 10.
description	string	Az objektum leírása.
displayName	string	Az objektum neve.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

EntityError

Name	Típus	Description
code	string	A hiba kódja.
message	string	A hiba üzenete.

EntityReference

Name	Típus	Description
self	string	A hivatkozott entitás helye.

Error

Hiba

Name	Típus	Description
code	ErrorCode	ErrorCode Magas szintű hibakódok.
details	Error[]	További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innerError	InnerError	InnerError Új belső hibaformátum, amely megfelel a Cognitive Services API-irányelveknek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célhelye, részletek (kulcsértékpár), belső hiba (ez beágyazható).
message	string	Magas szintű hibaüzenet.
target	string	A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

ErrorCode

Name	Típus	Description
Conflict	string	Az ütközési hibakód jelölője.
Forbidden	string	A tiltott hibakódot jelöli.
InternalCommunicationFailed	string	A belső kommunikáció meghiúsult hibakódját jelképező hibakód.
InternalServerError	string	A belső kiszolgáló hibakódját jelöli.
InvalidArgument	string	Az érvénytelen argumentum hibakódját jelöli.
InvalidRequest	string	Az érvénytelen kérelem hibakódját jelöli.
NotAllowed	string	A nem engedélyezett hibakódot jelöli.
NotFound	string	A nem található hibakódot jelöli.
PipelineError	string	A folyamat hibakódjának jelölője.
ServiceUnavailable	string	A szolgáltatás nem érhető el hibakódját jelöli.
TooManyRequests	string	A túl sok kérelem hibakódját jelöli.
Unauthorized	string	A jogosulatlan hibakódot jelöli.
UnprocessableEntity	string	A feldolgozhatatlan entitás hibakódját jelöli.
UnsupportedMediaType	string	A nem támogatott médiatípus hibakódját jelöli.

InnerError

Name	Típus	Description
code	DetailedErrorCode	DetailedErrorCode Részletes hibakód enumerálás.
details	object	További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban.
innerError	InnerError	InnerError Új belső hibaformátum, amely megfelel a Cognitive Services API-irányelveknek, amely a címen https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owérhető el. Ez tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és választható tulajdonságok célhelye, részletek (kulcsértékpár), belső hiba (ez beágyazható).
message	string	Magas szintű hibaüzenet.
target	string	A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító".

Status

Állapot

Name	Típus	Description
Failed	string	A hosszú ideig futó művelet nem sikerült.
NotStarted	string	A hosszú ideig futó művelet még nem indult el.
Running	string	A hosszú ideig futó művelet jelenleg feldolgozásra kerül.
Succeeded	string	A hosszú ideig futó művelet sikeresen befejeződött.

Megosztás a következőn keresztül:

Endpoints - Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

Ocp-Apim-Subscription-Key

Authorization

Példák

Update an endpoint

Sample Request

Sample Response

Definíciók

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EndpointPropertiesUpdate

EndpointUpdate

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

További források