Endpoints - List
Lekéri a hitelesített előfizetés végpontjainak listáját.
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip={skip}&top={top}&filter={filter}
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). |
filter
|
query |
string |
Szűrőkifejezés az elérhető végpontok egy részhalmazának kiválasztásához.
|
|
skip
|
query |
integer int32 |
Kihagyandó adathalmazok száma. |
|
top
|
query |
integer int32 |
A kihagyás után belefoglalt adathalmazok száma. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
OK Headers Retry-After: integer |
|
Other Status Codes |
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
Get all endpoints |
Get all queued endpoints. |
Get all endpoints
Sample Request
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z
Sample Response
{
"values": [
{
"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"
},
{
"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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
},
"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": 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.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}
Get all queued endpoints.
Sample Request
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'
Sample Response
{
"values": [
{
"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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
},
"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": 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"
}
]
}
Definíciók
Name | Description |
---|---|
Detailed |
DetailedErrorCode |
Endpoint |
Végpont |
Endpoint |
EndpointLinks |
Endpoint |
EndpointProperties |
Entity |
EntityError |
Entity |
EntityReference |
Error |
Hiba |
Error |
ErrorCode |
Inner |
InnerError |
Paginated |
Lapszámozott pontok |
Status |
Állapot |
DetailedErrorCode
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 a kérelem törzsének formátuma. |
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 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á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 megjelenítendő neve. |
lastActionDateTime |
string |
Az aktuális állapot megadásának időbélyege. Az időbélyeg ISO 8601 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 |
|
locale |
string |
A tartalmazott adatok területi beállítása. |
model |
EntityReference |
|
project |
EntityReference |
|
properties |
EndpointProperties |
|
self |
string |
Az entitás helye. |
status |
Állapot |
|
text |
string |
A végpont nyelvmodelljének adaptálásához használt szöveg. |
EndpointLinks
EndpointLinks
Name | Típus | Description |
---|---|---|
logs |
string |
A végpont hang- és átírási napló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ÉRELEM REST-végpontja legfeljebb 60 másodpercig, és 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
EndpointProperties
Name | Típus | Description |
---|---|---|
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 |
|
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 rendszer automatikusan törli. Ha nem állítja be ezt az értéket, vagy 0 értékre á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). |
EntityError
EntityError
Name | Típus | Description |
---|---|---|
code |
string |
A hiba kódja. |
message |
string |
A hiba üzenete. |
EntityReference
EntityReference
Name | Típus | Description |
---|---|---|
self |
string |
A hivatkozott entitás helye. |
Error
Hiba
Name | Típus | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban. |
innerError |
InnerError |
|
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
ErrorCode
Name | Típus | Description |
---|---|---|
Conflict |
string |
Az ütközési hibakódnak megfelelő. |
Forbidden |
string |
A tiltott hibakódot jelöli. |
InternalCommunicationFailed |
string |
A belső kommunikáció 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át jelöli. |
ServiceUnavailable |
string |
A szolgáltatás nem érhető el hibakódját jelöli. |
TooManyRequests |
string |
A túl sok kérés 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
InnerError
Name | Típus | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
További támogató részletek a hibával és/vagy a várt szabályzatokkal kapcsolatban. |
innerError |
InnerError |
|
message |
string |
Magas szintű hibaüzenet. |
target |
string |
A hiba forrása. Érvénytelen dokumentum esetén például "dokumentumok" vagy "dokumentumazonosító". |
PaginatedEndpoints
Lapszámozott pontok
Name | Típus | Description |
---|---|---|
@nextLink |
string |
Hivatkozás a lapszámozott eredmények következő készletére, ha több entitás érhető el; egyébként null értékű. |
values |
Endpoint[] |
A "skip" és a "top" átadott lekérdezési paraméterek vagy az alapértelmezett értékek által korlátozott entitások listája. Ha egy listát lapszámozással és entitások párhuzamos törlésével iterál, egyes entitások kimaradnak az eredményekből. Javasoljuk, hogy hozzon létre egy listát az ügyfélen, és törölje a teljes lista lekérése után. |
Status
Állapot
Name | Típus | Description |
---|---|---|
Failed |
string |
A hosszú ideig futó művelet meghiúsult. |
NotStarted |
string |
A hosszú ideig futó művelet még nem indult el. |
Running |
string |
A hosszú ideig futó művelet feldolgozása folyamatban van. |
Succeeded |
string |
A hosszú ideig futó művelet sikeresen befejeződött. |