Endpoints - Resume

  • 參考
服務:
Azure AI Services
API 版本:
2024-02-01-preview

繼續由指定標識碼識別的端點。

POST {endpoint}/customvoice/endpoints/{id}:resume?api-version=2024-02-01-preview

URI 參數

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

string

支援的認知服務端點 (通訊協定和主機名，例如： https://eastus.api.cognitive.microsoft.com) 。
id
 path True

string

uuid

應為 UUID 的資源識別碼。
api-version
 query True

string

用於此作業的 API 版本。

要求標頭

名稱 必要 類型 Description
Ocp-Apim-Subscription-Key True

string

在這裡提供您的語音資源金鑰。
Operation-Id

string

作業的狀態監視器標識碼。 如果 Operation-Id 標頭符合現有的作業，且要求與先前的要求不相同，則會失敗並出現 400 錯誤的要求。

Regex 模式: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

回應

名稱 類型 Description
202 Accepted

Endpoint

已接受

標題

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

發生錯誤。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

在這裡提供您的語音資源金鑰。

類型: apiKey
位於: header

範例

Resume an endpoint

範例要求

POST {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb:resume?api-version=2024-02-01-preview

範例回覆

狀態碼:
202 
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/15cc4e23-3cc7-4811-adcc-75e5804765cc?api-version=2024-02-01-preview
Operation-Id: 15cc4e23-3cc7-4811-adcc-75e5804765cc
{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "Running",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

定義

名稱 Description
Endpoint

端點物件
EndpointKind

端點種類
EndpointProperties

端點屬性
Error

最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。
ErrorCode

最上層錯誤碼
ErrorResponse

錯誤回應遵循 azure REST API 指導方針Microsoft，可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
Status

資源的狀態。

Endpoint

端點物件

名稱 類型 Description
createdDateTime

string

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

string

端點描述
displayName

string

端點名稱
id

string

端點標識碼
lastActionDateTime

string

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

string

資源識別碼
projectId

string

資源識別碼
properties

EndpointProperties

端點屬性
status

Status

資源的狀態。

EndpointKind

端點種類

名稱 類型 Description
FastResume

string

HighPerformance

string

EndpointProperties

端點屬性

名稱 類型 Description
kind

EndpointKind

端點種類

Error

最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

名稱 類型 Description
code

ErrorCode

最上層錯誤碼
details

Error[]

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

InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message

string

最上層錯誤訊息。
target

string

錯誤的來源。 例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

ErrorCode

最上層錯誤碼

名稱 類型 Description
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

錯誤回應遵循 azure REST API 指導方針Microsoft，可在 取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名稱 類型 Description
error

Error

最上層錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含具有錯誤碼、訊息、詳細數據、目標和內部錯誤的最上層錯誤，其中包含更具描述性的詳細數據。

InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。

名稱 類型 Description
code

string

詳細的錯誤碼可協助診斷。
innererror

InnerError

內部錯誤遵循 Microsoft Azure REST API 指導方針，可在取得 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。 這包含必要的屬性錯誤碼、訊息和選擇性屬性目標、內部錯誤 (這可以是巢狀) 。
message

string

詳細的錯誤訊息。
target

string

錯誤的來源。 例如，如果是無效的模型，它會是「模型」或「模型標識碼」。

Status

資源的狀態。

名稱 類型 Description
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string