Endpoints - Create

서비스:

Azure AI Services

API 버전:

2024-02-01-preview

새 엔드포인트를 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	UUID여야 하는 리소스 ID입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	여기에서 Speech 리소스 키를 제공합니다.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	작업에 대한 상태 모니터의 ID입니다. Operation-Id 헤더가 기존 작업과 일치하고 요청이 이전 요청과 동일하지 않으면 400 잘못된 요청으로 실패합니다.

요청 본문

Name	필수	형식	Description
modelId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	리소스 ID
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	리소스 ID
description		string	엔드포인트 설명
displayName		string minLength: 1	엔드포인트 이름
id		string (uuid)	엔드포인트 ID
properties		EndpointProperties	엔드포인트 속성
status		Status	리소스의 상태입니다.

응답

Name	형식	Description
201 Created	Endpoint	만든 헤더 Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	오류가 발생했습니다. 헤더 x-ms-error-code: string

보안

Ocp-Apim-Subscription-Key

여기에서 Speech 리소스 키를 제공합니다.

형식: apiKey
In(다음 안에): header

예제

Create an endpoint

샘플 요청

HTTP

PUT {
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb?api-version=2024-02-01-preview



{
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}

샘플 응답

상태 코드:

201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?api-version=2024-02-01-preview
Operation-Id: 2595b58d-40d6-4032-a618-482dcce1c130

{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

정의

Name	Description
Endpoint	엔드포인트 개체
EndpointKind	엔드포인트 종류
EndpointProperties	엔드포인트 속성
Error	최상위 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 오류 코드, 메시지, 세부 정보, 대상 및 보다 설명적인 세부 정보가 포함된 내부 오류가 포함된 최상위 오류가 포함됩니다.
ErrorCode	최상위 오류 코드
ErrorResponse	오류 응답은 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다.
InnerError	내부 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.
Status	리소스의 상태입니다.

Endpoint

Object

엔드포인트 개체

Name	형식	Description
createdDateTime	string (date-time)	개체를 만든 타임스탬프입니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations참조).
description	string	엔드포인트 설명
displayName	string minLength: 1	엔드포인트 이름
id	string (uuid)	엔드포인트 ID
lastActionDateTime	string (date-time)	현재 상태가 입력된 타임스탬프입니다. 타임스탬프는 ISO 8601 날짜 및 시간 형식으로 인코딩됩니다("YYYY-MM-DDThh:mm:ssZ", https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations참조).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	리소스 ID
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	리소스 ID
properties	EndpointProperties	엔드포인트 속성
status	Status	리소스의 상태입니다.

EndpointKind

열거형

엔드포인트 종류

값	Description
FastResume
HighPerformance

EndpointProperties

Object

엔드포인트 속성

Name	형식	Description
kind	EndpointKind	엔드포인트 종류

Error

Object

최상위 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 오류 코드, 메시지, 세부 정보, 대상 및 보다 설명적인 세부 정보가 포함된 내부 오류가 포함된 최상위 오류가 포함됩니다.

Name	형식	Description
code	ErrorCode	최상위 오류 코드
details	Error[]	오류 및/또는 예상 정책에 대한 추가 지원 세부 정보입니다.
innererror	InnerError	내부 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	최상위 오류 메시지입니다.
target	string	오류의 소스입니다. 예를 들어 잘못된 모델의 경우 "모델" 또는 "모델 ID"가 됩니다.

ErrorCode

열거형

최상위 오류 코드

값	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

오류 응답은 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다.

Name	형식	Description
error	Error	최상위 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 오류 코드, 메시지, 세부 정보, 대상 및 보다 설명적인 세부 정보가 포함된 내부 오류가 포함된 최상위 오류가 포함됩니다.

InnerError

Object

내부 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.

Name	형식	Description
code	string	진단에 도움이 되는 자세한 오류 코드입니다.
innererror	InnerError	내부 오류는 https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors사용할 수 있는 Microsoft Azure REST API 지침을 따릅니다. 여기에는 필수 속성 오류 코드, 메시지 및 선택적 속성 대상, 내부 오류(중첩될 수 있음)가 포함됩니다.
message	string	자세한 오류 메시지입니다.
target	string	오류의 소스입니다. 예를 들어 잘못된 모델의 경우 "모델" 또는 "모델 ID"가 됩니다.

Status

열거형

리소스의 상태입니다.

값	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded