共用方式為


Endpoints - List

取得已驗證訂用帳戶的端點清單。

GET {endpoint}/speechtotext/v3.2/endpoints
GET {endpoint}/speechtotext/v3.2/endpoints?skip={skip}&top={top}&filter={filter}

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

支援的認知服務端點 (通訊協定和主機名,例如: https://westus.api.cognitive.microsoft.com) 。

filter
query

string

用於選取可用端點子集的篩選表達式。

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=locale eq 'en-US'
skip
query

integer

int32

將會略過的數據集數目。

top
query

integer

int32

略過之後將包含的數據集數目。

回應

名稱 類型 Description
200 OK

PaginatedEndpoints

確定

標題

Retry-After: integer

Other Status Codes

Error

發生錯誤。

安全性

Ocp-Apim-Subscription-Key

請在這裡提供您的認知服務帳戶金鑰。

類型: apiKey
位於: header

Authorization

從此區域的 STS 傳回的 JWT 提供存取令牌。 請務必將下列查詢字串新增至 STS URL,將管理範圍新增至令牌:?scope=speechservicesmanagement

類型: apiKey
位於: header

範例

Get all endpoints
Get all queued endpoints.

Get all endpoints

範例要求

GET {endpoint}/speechtotext/v3.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

範例回覆

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

範例要求

GET {endpoint}/speechtotext/v3.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'

範例回覆

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
    }
  ]
}

定義

名稱 Description
DetailedErrorCode

DetailedErrorCode

Endpoint

端點

EndpointLinks

EndpointLinks

EndpointProperties

EndpointProperties

EntityError

EntityError

EntityReference

EntityReference

Error

錯誤

ErrorCode

ErrorCode

InnerError

InnerError

PaginatedEndpoints

PaginatedEndpoints

Status

狀態

DetailedErrorCode

DetailedErrorCode

名稱 類型 Description
DataImportFailed

string

數據匯入失敗。

DeleteNotAllowed

string

不允許刪除。

DeployNotAllowed

string

不允許部署。

DeployingFailedModel

string

部署失敗的模型。

EmptyRequest

string

空白要求。

EndpointCannotBeDefault

string

端點不可為預設值。

EndpointNotUpdatable

string

端點無法更新。

EndpointWithoutLogging

string

沒有記錄的端點。

ExceededNumberOfRecordingsUris

string

已超過錄製 URI 的數目。

FailedDataset

string

失敗的數據集。

Forbidden

string

禁止。

InUseViolation

string

在使用違規中。

InaccessibleCustomerStorage

string

無法存取的客戶記憶體。

InvalidAdaptationMapping

string

調整對應無效。

InvalidBaseModel

string

基底模型無效。

InvalidCallbackUri

string

無效的回呼 URI。

InvalidChannels

string

通道無效。

InvalidCollection

string

無效的集合。

InvalidDataset

string

無效的數據集。

InvalidDocument

string

無效的檔。

InvalidDocumentBatch

string

檔批次無效。

InvalidLocale

string

無效的地區設定。

InvalidLogDate

string

無效的記錄日期。

InvalidLogEndTime

string

記錄結束時間無效。

InvalidLogId

string

無效的記錄標識碼。

InvalidLogStartTime

string

記錄開始時間無效。

InvalidModel

string

無效的模型。

InvalidModelUri

string

無效的模型 URI。

InvalidParameter

string

無效的參數。

InvalidParameterValue

string

無效的參數值。

InvalidPayload

string

承載無效。

InvalidPermissions

string

許可權無效。

InvalidPrerequisite

string

無效的必要條件。

InvalidProductId

string

無效的產品標識碼。

InvalidProject

string

無效的專案。

InvalidProjectKind

string

無效的項目種類。

InvalidRecordingsUri

string

無效的錄製 URI。

InvalidRequestBodyFormat

string

要求本文格式無效。

InvalidSasValidityDuration

string

無效的 sas 有效期間。

InvalidSkipTokenForLogs

string

記錄的略過令牌無效。

InvalidSourceAzureResourceId

string

來源 Azure 資源標識碼無效。

InvalidSubscription

string

無效的訂用帳戶。

InvalidTest

string

無效的測試。

InvalidTimeToLive

string

存留時間無效。

InvalidTopForLogs

string

記錄的頂端無效。

InvalidTranscription

string

無效的轉譯。

InvalidWebHookEventKind

string

無效的 Web 攔截事件種類。

MissingInputRecords

string

遺漏輸入記錄。

ModelCopyAuthorizationExpired

string

過期的 ModelCopyAuthorization。

ModelDeploymentNotCompleteState

string

模型部署未完成狀態。

ModelDeprecated

string

模型已被取代。

ModelExists

string

模型存在。

ModelMismatch

string

模型不符。

ModelNotDeployable

string

模型無法部署。

ModelVersionIncorrect

string

模型版本不正確。

NoUtf8WithBom

string

沒有 bom 的 utf8。

OnlyOneOfUrlsOrContainerOrDataset

string

只有其中一個 URL 或容器或數據集。

ProjectGenderMismatch

string

專案性別不符。

QuotaViolation

string

配額違規。

SingleDefaultEndpoint

string

單一預設端點。

SkuLimitsExist

string

Sku 限制存在。

SubscriptionNotFound

string

找不到訂用帳戶。

UnexpectedError

string

非預期的錯誤。

UnsupportedClassBasedAdaptation

string

不支援的類別型調適。

UnsupportedDelta

string

不支持的差異。

UnsupportedDynamicConfiguration

string

不支援的動態設定。

UnsupportedFilter

string

不支援的篩選。

UnsupportedLanguageCode

string

不支援的語言代碼。

UnsupportedOrderBy

string

不支援的順序依據。

UnsupportedPagination

string

不支援的分頁。

UnsupportedTimeRange

string

不支援的時間範圍。

Endpoint

端點

名稱 類型 Description
createdDateTime

string

建立物件時的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。

customProperties

object

此實體的自定義屬性。 允許的金鑰長度上限為 64 個字元,允許的最大值長度為 256 個字元,允許的項目計數為 10。

description

string

物件的描述。

displayName

string

對象的顯示名稱。

lastActionDateTime

string

輸入目前狀態時的時間戳。 時間戳會編碼為 ISO 8601 日期和時間格式, (“YYYY-MM-DDThh:mm:ssZ”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。

links

EndpointLinks

EndpointLinks

locale

string

自主數據的地區設定。

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointProperties

EndpointProperties

self

string

此實體的位置。

status

Status

狀態
描述 API 的目前狀態。

text

string

用來調整此端點語言模型的文字。

EndpointLinks

名稱 類型 Description
logs

string

此端點的音訊和轉譯記錄。 如需詳細資訊,請參閱作業「Endpoints_ListLogs」。

restConversation

string

要求最多 60 秒的 REST 端點。

restDictation

string

最多 60 秒要求的 REST 端點,支持標點符號的聽寫。

restInteractive

string

最多 15 秒的簡短要求的 REST 端點。

webSocketConversation

string

具有多個最終結果之長時間要求的語音 SDK 端點。

webSocketDictation

string

具有多個最終結果之長時間要求的語音 SDK 端點,支援標點符號的聽寫。

webSocketInteractive

string

最多 15 秒的簡短要求的語音 SDK 端點,具有單一最終結果。

EndpointProperties

EndpointProperties

名稱 類型 Description
email

string

在作業完成時,傳送電子郵件通知的電子郵件位址。 成功傳送電子郵件之後,將會移除此值。

error

EntityError

EntityError

loggingEnabled

boolean

值,指出是否將內容記錄 (音訊 & 轉譯) 用於部署。

timeToLive

string

端點會保留在系統中的時間長度。 一旦端點到達完成之後 (成功或失敗的時間,就會自動刪除它) 。 未將此值或設定為 0 將會停用自動刪除。 最長支持的持續時間是31天。 持續時間會編碼為 ISO 8601 持續時間 (“PnYnMnDTnHnMnS”,請參閱 https://en.wikipedia.org/wiki/ISO_8601#Durations) 。

EntityError

EntityError

名稱 類型 Description
code

string

此錯誤的程序代碼。

message

string

此錯誤的訊息。

EntityReference

EntityReference

名稱 類型 Description
self

string

參考實體的位置。

Error

錯誤

名稱 類型 Description
code

ErrorCode

ErrorCode
高階錯誤碼。

details

Error[]

關於錯誤和/或預期原則的其他支持詳細數據。

innerError

InnerError

InnerError
符合認知服務 API 指導方針的新內部錯誤格式,可在 取得 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow。 這包含必要屬性 ErrorCode、訊息和選用屬性目標、詳細資訊 (機碼值組)、內部錯誤 (可為巢狀)。

message

string

高階錯誤訊息。

target

string

錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。

ErrorCode

ErrorCode

名稱 類型 Description
Conflict

string

表示衝突錯誤碼。

Forbidden

string

表示禁止的錯誤碼。

InternalCommunicationFailed

string

表示內部通訊失敗的錯誤碼。

InternalServerError

string

表示內部伺服器錯誤碼。

InvalidArgument

string

表示無效的自變數錯誤碼。

InvalidRequest

string

表示無效的要求錯誤碼。

NotAllowed

string

表示不允許的錯誤碼。

NotFound

string

表示找不到的錯誤碼。

PipelineError

string

表示管線錯誤碼。

ServiceUnavailable

string

表示服務無法使用的錯誤碼。

TooManyRequests

string

表示太多要求錯誤碼。

Unauthorized

string

表示未經授權的錯誤碼。

UnprocessableEntity

string

表示無法處理的實體錯誤碼。

UnsupportedMediaType

string

表示不支援的媒體類型錯誤碼。

InnerError

InnerError

名稱 類型 Description
code

DetailedErrorCode

DetailedErrorCode
詳細的錯誤碼列舉。

details

object

關於錯誤和/或預期原則的其他支持詳細數據。

innerError

InnerError

InnerError
符合認知服務 API 指導方針的新內部錯誤格式,可在 取得 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow。 這包含必要屬性 ErrorCode、訊息和選用屬性目標、詳細資訊 (機碼值組)、內部錯誤 (可為巢狀)。

message

string

高階錯誤訊息。

target

string

錯誤的來源。 例如,如果文件無效,則會是「documents」或「document id」。

PaginatedEndpoints

PaginatedEndpoints

名稱 類型 Description
@nextLink

string

如果有更多實體可用,則為下一組編頁結果的連結;否則為 null。

values

Endpoint[]

受限於傳遞查詢參數 『skip』 和 『top』 或其預設值的實體清單。

使用分頁和平行刪除實體逐一查看清單時,會在結果中略過某些實體。 建議在用戶端上建置清單,並在擷取完整清單之後刪除。

Status

狀態

名稱 類型 Description
Failed

string

長時間執行的作業失敗。

NotStarted

string

長時間執行的作業尚未啟動。

Running

string

長時間執行的作業目前正在處理。

Succeeded

string

長時間執行的作業已順利完成。