Dela via


Projects - Create

Skapar ett nytt projekt.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).

id
path True

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Resursens ID.

api-version
query True

string

minLength: 1

DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
Ocp-Apim-Subscription-Key True

string

Ange din Speech-resursnyckel här.

Begärandetext

Name Obligatorisk Typ Description
kind True

ProjectKind

Projekttyp

description

string

Projektbeskrivning

displayName

string

minLength: 1

Projektnamn

id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Resurs-ID

Svar

Name Typ Description
201 Created

Project

Skapad

Other Status Codes

ErrorResponse

Ett fel uppstod.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

Create a project

Exempelbegäran

PUT {endpoint}/customvoice/projects/Jessica?api-version=2024-02-01-preview


{
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice"
}

Exempelsvar

{
  "id": "Jessica",
  "description": "Project for Jessica Voice",
  "kind": "ProfessionalVoice",
  "createdDateTime": "2023-04-01T05:30:00.000Z"
}

Definitioner

Name Description
Error

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

ErrorCode

Felkod på toppnivå

ErrorResponse

Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

InnerError

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Project

Projektobjekt. Medgivanden, träningsuppsättningar, modeller och slutpunkter organiseras i ett projekt.

ProjectKind

Projekttyp

Error

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name Typ Description
code

ErrorCode

Felkod på toppnivå

details

Error[]

Ytterligare stödjande information om fel och/eller förväntade principer.

innererror

InnerError

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

message

string

Felmeddelande på den översta nivån.

target

string

Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

ErrorCode

Felkod på toppnivå

Värde Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name Typ Description
error

Error

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name Typ Description
code

string

Detaljerad felkod för diagnostik.

innererror

InnerError

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

message

string

Detaljerat felmeddelande.

target

string

Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

Project

Projektobjekt. Medgivanden, träningsuppsättningar, modeller och slutpunkter organiseras i ett projekt.

Name Typ Description
createdDateTime

string (date-time)

Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

Projektbeskrivning

displayName

string

minLength: 1

Projektnamn

id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Resurs-ID

kind

ProjectKind

Projekttyp

ProjectKind

Projekttyp

Värde Description
PersonalVoice
ProfessionalVoice