Endpoints - Create

Dienst:

Azure AI Services

API-Version:

2024-02-01-preview

Erstellt einen neuen Endpunkt.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://eastus.api.cognitive.microsoft.com
id	path	True	string uuid	Die Ressourcen-ID, die UUID sein sollte.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string	Geben Sie hier Ihren Speech-Ressourcenschlüssel an.
Operation-Id		string	ID des Statusmonitors für den Vorgang. Wenn der Operation-Id-Header mit einem vorhandenen Vorgang übereinstimmt und die Anforderung nicht mit der vorherigen Anforderung identisch ist, schlägt er mit einer ungültigen 400-Anforderung fehl. RegEx-Muster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
modelId	True	string	Ressourcen-ID
projectId	True	string	Ressourcen-ID
description		string	Endpunktbeschreibung
displayName		string	Endpunktname
id		string	Endpunkt-ID
properties		EndpointProperties	Endpunkteigenschaften
status		Status	Status einer Ressource.

Antworten

Name	Typ	Beschreibung
201 Created	Endpoint	Erstellt Header Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ein Fehler ist aufgetreten. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Speech-Ressourcenschlüssel an.

Typ: apiKey
In: header

Beispiele

Create an endpoint

Beispielanforderung

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"
}

Beispiel für eine Antwort

Statuscode:

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"
}

Definitionen

Name	Beschreibung
Endpoint	Endpunktobjekt
EndpointKind	Endpunktart
EndpointProperties	Endpunkteigenschaften
Error	Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.
ErrorCode	Fehlercode der obersten Ebene
ErrorResponse	Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.
InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
Status	Status einer Ressource.

Endpoint

Endpunktobjekt

Name	Typ	Beschreibung
createdDateTime	string	Der Zeitstempel, bei dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("YYYY-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	Endpunktbeschreibung
displayName	string	Endpunktname
id	string	Endpunkt-ID
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle Status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("YYYY-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
modelId	string	Ressourcen-ID
projectId	string	Ressourcen-ID
properties	EndpointProperties	Endpunkteigenschaften
status	Status	Status einer Ressource.

EndpointKind

Endpunktart

Name	Typ	Beschreibung
FastResume	string
HighPerformance	string

EndpointProperties

Endpunkteigenschaften

Name	Typ	Beschreibung
kind	EndpointKind	Endpunktart

Error

Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode der obersten Ebene
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innererror	InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
message	string	Fehlermeldung der obersten Ebene.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

ErrorCode

Fehlercode der obersten Ebene

Name	Typ	Beschreibung
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Die Fehlerantwort folgt den Richtlinien der Microsoft Azure-REST-API, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind.

Name	Typ	Beschreibung
error	Error	Fehler der obersten Ebene folgen den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält einen Fehler auf oberster Ebene mit Fehlercode, Meldung, Details, Ziel und einem inneren Fehler mit aussagekräftigeren Details.

InnerError

Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).

Name	Typ	Beschreibung
code	string	Detaillierter Fehlercode zur Unterstützung der Diagnose.
innererror	InnerError	Der innere Fehler folgt den Microsoft Azure-REST-API-Richtlinien, die unter https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errorsverfügbar sind. Dies enthält den erforderlichen Eigenschaftenfehlercode, die Meldung und das optionale Eigenschaftenziel, den inneren Fehler (dieser kann geschachtelt werden).
message	string	Ausführliche Fehlermeldung.
target	string	Die Ursache des Fehlers. Im Falle eines ungültigen Modells wäre es z. B. "Model" oder "Model ID".

Status

Status einer Ressource.

Name	Typ	Beschreibung
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string