Freigeben über

Migrieren zur Custom Voice-REST-API (Vorschau)

Hinweis

Dieses Feature ist zurzeit als öffentliche Preview verfügbar. Diese Vorschau wird ohne Vereinbarung zum Servicelevel bereitgestellt und nicht für Produktionsworkloads empfohlen. Manche Features werden möglicherweise nicht unterstützt oder sind nur eingeschränkt verwendbar. Weitere Informationen finden Sie unter Zusätzliche Nutzungsbestimmungen für Microsoft Azure-Vorschauen.

Die benutzerdefinierte VoIP-REST-API ist eine neue Version des Texts der REST-API für Spracherkennung. Sie können benutzerdefinierte VoIP-Modelle mit der API bereitstellen und verwenden.

In diesem Artikel erfahren Sie, wie Sie Code aus der v3-Text-to-Speech-REST-API zur Custom Voice-REST-API migrieren.

In diesem Artikel werden Informationen über den v3-Text zur REST-API für die Spracherkennung aufbewahrt, um referenziert zu werden. Sie sollten jedoch die benutzerdefinierte VoIP-REST-API für die neue Entwicklung verwenden.

Erforderliche Änderungen

Endpunkt anhalten: Verwenden Sie den benutzerdefinierten Endpunkt-Vorgang der VoIP-API zum Anhalten eines Endpunkts. Der v3-Text für die REST-API-Anhalte-Endpunktoperation wird eingestellt.

Endpunkt fortsetzen: Verwenden Sie den Endpunktvorgang der benutzerdefinierten VoIP-API , um einen Endpunkt anzusetzen. Der Endpunktvorgang der v3-Text-zu-Sprach-REST-API wird eingestellt.

Referenzdokumentation für v3-Text-zu-Sprach-REST-API (Einstellung)

Anhalten und Fortsetzen eines Endpunkts per REST-API

In diesem Abschnitt erfahren Sie, wie Sie einen benutzerdefinierten Sprachendpunkt über die REST-API abrufen, anhalten oder fortsetzen .

Abrufen des Endpunkts

Rufen Sie den Endpunkt anhand der Endpunkt-ID ab. Der Vorgang gibt Details zu einem Endpunkt zurück, z. B. Modell-ID, Projekt-ID und Status.

Sie können beispielsweise den Fortschritt für die Vorgänge zum Anhalten oder Fortsetzen nachverfolgen. Verwenden Sie die Eigenschaft status in den Antwortnutzdaten, um den Status des Endpunkts zu bestimmen.

Die Eigenschaft status kann folgende Werte aufweisen:

Der Status Beschreibung
NotStarted Der Endpunkt wurde nicht bereitgestellt und steht nicht für die Sprachsynthese zur Verfügung.
Running Der Endpunkt wird momentan bereitgestellt oder wurde angehalten und steht nicht für die Sprachsynthese zur Verfügung.
Succeeded Der Endpunkt ist aktiv und steht für die Sprachsynthese zur Verfügung. Der Endpunkt wurde bereitgestellt oder erfolgreich fortgesetzt.
Failed Beim Vorgang zum Bereitstellen oder Anhalten des Endpunkts ist ein Fehler aufgetreten. Der Endpunkt kann nur in Speech Studio angezeigt oder gelöscht werden.
Disabling Der Endpunkt wird momentan angehalten und steht nicht für die Sprachsynthese zur Verfügung.
Disabled Der Endpunkt ist inaktiv und steht nicht für die Sprachsynthese zur Verfügung. Der Vorgang zum Fortsetzen war erfolgreich, oder beim Vorgang zum Fortsetzen ist ein Fehler aufgetreten.

Tipp

Wenn der Status Failed oder Disabled lautet, überprüfen Sie properties.error, um eine detaillierte Fehlermeldung zu erhalten. Allerdings werden keine Fehlerdetails angezeigt, wenn der Status aufgrund eines erfolgreichen Vorgangs zum Anhalten Disabled lautet.

Beispiel zum Abrufen eines Endpunkts

Informationen zu Endpunkt-ID, Region und Speech-Ressourcenschlüsselparametern finden Sie unter Anforderungsparameter.

HTTP-Beispiel:

GET api/texttospeech/v3.0/endpoints/<YourEndpointId> HTTP/1.1
Ocp-Apim-Subscription-Key: YourResourceKey
Host: <YourResourceRegion>.customvoice.api.speech.microsoft.com

cURL-Beispiel:

curl -v -X GET "https://<YourResourceRegion>.customvoice.api.speech.microsoft.com/api/texttospeech/v3.0/endpoints/<YourEndpointId>" -H "Ocp-Apim-Subscription-Key: <YourResourceKey >"

Beispiel für Antwortheader:

Status code: 200 OK

Beispiel für einen Antworttext:

{
  "model": {
    "id": "a92aa4b5-30f5-40db-820c-d2d57353de44"
  },
  "project": {
    "id": "ffc87aba-9f5f-4bfa-9923-b98186591a79"
  },
  "properties": {},
  "status": "Succeeded",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "id": "e7ffdf12-17c7-4421-9428-a7235931a653",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "name": "Voice endpoint",
  "description": "Example for voice endpoint"
}

Anhalten eines Endpunkts

Sie können einen Endpunkt anhalten, um die Kosten zu begrenzen und nicht genutzte Ressourcen freizugeben. Während der Endpunkt angehalten ist, werden Ihnen keine Gebühren berechnet. Wenn Sie einen Endpunkt fortsetzen, können Sie in Ihrer Anwendung weiterhin dieselbe Endpunkt-URL für die Sprachsynthese verwenden.

Sie halten einen Endpunkt mithilfe seiner eindeutigen Bereitstellungs-ID an. Der Status des Endpunkts muss Succeeded lauten, damit er angehalten werden kann.

Verwenden Sie den Vorgang Endpunkt abrufen, um den Statusverlauf von Succeeded über Disabling zu Disabled abzufragen und zu verfolgen.

Beispiel zum Anhalten eines Endpunkts

Informationen zu Endpunkt-ID, Region und Speech-Ressourcenschlüsselparametern finden Sie unter Anforderungsparameter.

HTTP-Beispiel:

POST api/texttospeech/v3.0/endpoints/<YourEndpointId>/suspend HTTP/1.1
Ocp-Apim-Subscription-Key: YourResourceKey
Host: <YourResourceRegion>.customvoice.api.speech.microsoft.com
Content-Type: application/json
Content-Length: 0

cURL-Beispiel:

curl -v -X POST "https://<YourResourceRegion>.customvoice.api.speech.microsoft.com/api/texttospeech/v3.0/endpoints/<YourEndpointId>/suspend" -H "Ocp-Apim-Subscription-Key: <YourResourceKey >" -H "content-type: application/json" -H "content-length: 0"

Beispiel für Antwortheader:

Status code: 202 Accepted

Weitere Informationen finden Sie unter Antwortheader.

Fortsetzen des Endpunkts

Wenn Sie einen Endpunkt fortsetzen, können Sie dieselbe Endpunkt-URL verwenden, die Sie vor dem Anhalten verwendet haben.

Sie setzen einen Endpunkt mithilfe seiner eindeutigen Bereitstellungs-ID fort. Der Status des Endpunkts muss Disabled lauten, damit er fortgesetzt werden kann.

Verwenden Sie den Vorgang Endpunkt abrufen, um den Statusverlauf von Disabled über Running zu Succeeded abzufragen und zu verfolgen. Wenn der Vorgang zum Fortsetzen nicht erfolgreich ist, weist der Endpunkt den Status Disabled auf.

Beispiel zum Fortsetzen eines Endpunkts

Informationen zu Endpunkt-ID, Region und Speech-Ressourcenschlüsselparametern finden Sie unter Anforderungsparameter.

HTTP-Beispiel:

POST api/texttospeech/v3.0/endpoints/<YourEndpointId>/resume HTTP/1.1
Ocp-Apim-Subscription-Key: YourResourceKey
Host: <YourResourceRegion>.customvoice.api.speech.microsoft.com
Content-Type: application/json
Content-Length: 0

cURL-Beispiel:

curl -v -X POST "https://<YourResourceRegion>.customvoice.api.speech.microsoft.com/api/texttospeech/v3.0/endpoints/<YourEndpointId>/resume" -H "Ocp-Apim-Subscription-Key: <YourResourceKey >" -H "content-type: application/json" -H "content-length: 0"

Beispiel für Antwortheader:

Status code: 202 Accepted

Weitere Informationen finden Sie unter Antwortheader.

Parameter und Antwortcodes

Anforderungsparameter

Sie verwenden diese Anforderungsparameter mit Aufrufen der REST-API.

Name Standort Erforderlich Typ Beschreibung
YourResourceRegion `Path` True Zeichenfolge Die Azure-Region, der der Endpunkt zugeordnet ist.
YourEndpointId `Path` True Zeichenfolge Der Bezeichner des Endpunkts.
Ocp-Apim-Subscription-Key Kopfzeile True Zeichenfolge Der Speech-Ressourcenschlüssel, dem der Endpunkt zugeordnet ist.
Antwortheader

Statuscode: 202 (Akzeptiert)

Name Typ Beschreibung
Location Zeichenfolge Der Standort des Endpunkts, der als vollständige URL zum Abrufen des Endpunkts verwendet werden kann.
Retry-After Zeichenfolge Das empfohlene Intervall bis zur erneuten Abfrage des Endpunktstatus, angegeben in Sekunden.
HTTP-Statuscodes

Der HTTP-Statuscode jeder Antwort zeigt den Erfolg oder allgemeine Fehler an.

HTTP-Statuscode Beschreibung Mögliche Ursache
200 OKAY Die Anforderung wurde erfolgreich gesendet.
202 Akzeptiert Die Anforderung wurde akzeptiert und wird verarbeitet.
400 Ungültige Anforderung Der Wert eines Parameters ist ungültig, oder ein erforderlicher Parameter fehlt, ist leer oder NULL. Ein häufiges Problem sind zu lange Header.
401 Nicht autorisiert Die Anforderung ist nicht autorisiert.
429 Zu viele Anforderungen Sie haben das Kontingent oder die zulässige Anforderungsrate für die Speech-Ressource überschritten.
502 Ungültiges Gateway Netzwerk- oder serverseitiges Problem. Dieser Statuscode kann auf ungültige Header hinweisen.

Nächste Schritte