Endpoints - Update

Referenz

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

Aktualisiert die Metadaten des endpunkts, der durch die angegebene ID identifiziert wird.

PATCH {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Der Bezeichner des Endpunkts.

Anforderungstext

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
description	string	Die Beschreibung des Objekts.
displayName	string	Der Name des Objekts.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

Antworten

Name	Typ	Beschreibung
200 OK	Endpoint	OKAY Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

Endpoint

OKAY

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Stellen Sie hier Ihren kognitiven Leistungskontoschlüssel bereit.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken von JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Update an endpoint

Beispielanforderung

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Definitionen

Name	Beschreibung
DetailedErrorCode	DetailedErrorCode
Endpoint	Endpunkt
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EndpointPropertiesUpdate	EndpointPropertiesUpdate
EndpointUpdate	EndpointUpdate
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	Fehlercode
InnerError	InnerError
Status	Status

DetailedErrorCode

Enumeration

DetailedErrorCode

Wert	Beschreibung
DataImportFailed	Fehler beim Datenimport.
DeleteNotAllowed	Löschen nicht zulässig.
DeployNotAllowed	Bereitstellen nicht zulässig.
DeployingFailedModel	Fehler beim Bereitstellen des Modells.
EmptyRequest	Leere Anforderung.
EndpointCannotBeDefault	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
FailedDataset	Fehler beim Dataset.
Forbidden	Verboten.
InUseViolation	Verletzung des Einsatzes.
InaccessibleCustomerStorage	Nicht zugänglicher Kundenspeicher.
InvalidAdaptationMapping	Ungültige Anpassungszuordnung.
InvalidBaseModel	Ungültiges Basismodell.
InvalidCallbackUri	Ungültiger Rückruf-URI.
InvalidCollection	Ungültige Auflistung.
InvalidDataset	Ungültiges Dataset.
InvalidDocument	Ungültiges Dokument.
InvalidDocumentBatch	Ungültiger Dokumentbatch.
InvalidLocale	Ungültiges Gebietsschema.
InvalidLogDate	Ungültiges Protokolldatum.
InvalidLogEndTime	Ungültige Protokollendzeit.
InvalidLogId	Ungültige Protokoll-ID.
InvalidLogStartTime	Ungültige Startzeit des Protokolls.
InvalidModel	Ungültiges Modell.
InvalidModelUri	Ungültiger Modell-URI.
InvalidParameter	Ungültiger Parameter.
InvalidParameterValue	Ungültiger Parameterwert.
InvalidPayload	Ungültige Nutzlast.
InvalidPermissions	Ungültige Berechtigungen.
InvalidPrerequisite	Ungültige Voraussetzung.
InvalidProductId	Ungültige Produkt-ID.
InvalidProject	Ungültiges Projekt.
InvalidProjectKind	Ungültige Projektart.
InvalidRecordingsUri	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	Ungültige Gültigkeitsdauer für sas.
InvalidSkipTokenForLogs	Ungültiges Skip-Token für Protokolle.
InvalidSourceAzureResourceId	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	Ungültiges Abonnement.
InvalidTest	Ungültiger Test.
InvalidTimeToLive	Ungültige Zeit für live.
InvalidTopForLogs	Ungültiger Anfang für Protokolle.
InvalidTranscription	Ungültige Transkription.
InvalidWebHookEventKind	Ungültiger Web hook-Ereignistyp.
MissingInputRecords	Fehlende Eingabedatensätze.
ModelCopyOperationExists	Der Modellkopievorgang ist vorhanden.
ModelDeploymentNotCompleteState	Der Status der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	Das Modell ist veraltet.
ModelExists	Das Modell ist vorhanden.
ModelMismatch	Modellkonflikt.
ModelNotDeployable	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	Modellversion falsch.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Nur eine url oder ein Container oder Dataset.
ProjectGenderMismatch	Project gender mismatch.
QuotaViolation	Kontingentverletzung.
SingleDefaultEndpoint	Einzelner Standardendpunkt.
SkuLimitsExist	Sku-Grenzwerte sind vorhanden.
SubscriptionNotFound	Das Abonnement wurde nicht gefunden.
UnexpectedError	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	Nicht unterstützter Filter.
UnsupportedLanguageCode	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	Nicht unterstützte Paginierung.
UnsupportedTimeRange	Nicht unterstützter Zeitraum.

Endpoint

Objekt

Endpunkt

Name	Typ	Beschreibung
createdDateTime	string (date-time)	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
description	string	Die Beschreibung des Objekts.
displayName	string minLength: 1	Der Anzeigename des Objekts.
lastActionDateTime	string (date-time)	Der Zeitstempel, zu dem der aktuelle Status eingegeben wurde. Der Zeitstempel wird als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-DDThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	EndpointLinks
locale	string minLength: 1	Das Gebietsschema der enthaltenen Daten.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Status der API
text	string	Der Text, der zum Anpassen eines Sprachmodells für diesen Endpunkt verwendet wird.

EndpointLinks

Objekt

EndpointLinks

Name	Typ	Beschreibung
logs	string (uri)	Die Audio- und Transkriptionsprotokolle für diesen Endpunkt. Weitere Informationen finden Sie unter "Endpoints_ListLogs".
restConversation	string (uri)	Der REST-Endpunkt für Anforderungen bis zu 60 Sekunden.
restDictation	string (uri)	Der REST-Endpunkt für Anforderungen bis zu 60 Sekunden, die das Diktieren von Satzzeichen unterstützen.
restInteractive	string (uri)	Der REST-Endpunkt für kurze Anforderungen bis zu 15 Sekunden.
webSocketConversation	string (uri)	Der Speech SDK-Endpunkt für lange Anforderungen mit mehreren Endergebnissen.
webSocketDictation	string (uri)	Der Speech SDK-Endpunkt für lange Anforderungen mit mehreren Endergebnissen und unterstützt das Diktieren von Satzzeichen.
webSocketInteractive	string (uri)	Der Speech SDK-Endpunkt für kurze Anforderungen bis zu 15 Sekunden mit einem einzigen Endergebnis.

EndpointProperties

Objekt

EndpointProperties

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird nach dem erfolgreichen Senden der E-Mail entfernt.
error	EntityError	EntityError
loggingEnabled	boolean	Ein Wert, der angibt, ob die Inhaltsprotokollierung (Audio & Transkriptionen) für eine Bereitstellung verwendet wird.
timeToLive	string	Wie lange der Endpunkt im System aufbewahrt wird. Sobald der Endpunkt die Zeit erreicht, nach abschluss (erfolgreich oder fehlgeschlagen) zu leben, wird er automatisch gelöscht. Wenn Sie diesen Wert nicht festlegen oder auf 0 festlegen, wird die automatische Löschung deaktiviert. Die längste unterstützte Dauer beträgt 31 Tage. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

Objekt

EndpointPropertiesUpdate

Name	Typ	Beschreibung
contentLoggingEnabled	boolean	Ein Wert, der angibt, ob die Inhaltsprotokollierung (Audio & Transkriptionen) für eine Bereitstellung verwendet wird.

EndpointUpdate

Objekt

EndpointUpdate

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl zulässiger Einträge beträgt 10.
description	string	Die Beschreibung des Objekts.
displayName	string	Der Name des Objekts.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

EntityError

Objekt

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

EntityReference

Objekt

EntityReference

Name	Typ	Beschreibung
self	string (uri)	Der Speicherort der Entität, auf die verwiesen wird.

Error

Objekt

Fehler

Name	Typ	Beschreibung
code	ErrorCode	Fehlercode Fehlercodes auf hoher Ebene.
details	Error[]	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

ErrorCode

Enumeration

Fehlercode

Wert	Beschreibung
Conflict	Stellt den Konfliktfehlercode dar.
Forbidden	Stellt den verbotenen Fehlercode dar.
InternalCommunicationFailed	Fehlercode für die interne Kommunikation.
InternalServerError	Stellt den internen Fehlercode des Servers dar.
InvalidArgument	Stellt den fehlercode für ungültiges Argument dar.
InvalidRequest	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	Stellt den nicht zulässigen Fehlercode dar.
NotFound	Stellt den nicht gefundenen Fehlercode dar.
PipelineError	Stellt den Pipelinefehlerfehlercode dar.
ServiceUnavailable	Stellt den dienst nicht verfügbaren Fehlercode dar.
TooManyRequests	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	Stellt den nicht verarbeiteten Entitätsfehlercode dar.
UnsupportedMediaType	Stellt den Fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Objekt

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercode-Enumeration.
details	object	Zusätzliche unterstützende Details zu den Fehler- und/oder erwarteten Richtlinien.
innerError	InnerError	InnerError Neues inneres Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Dies enthält die erforderlichen Eigenschaften ErrorCode, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler(dies kann geschachtelt werden).
message	string	Fehlermeldung auf hoher Ebene.
target	string	Die Quelle des Fehlers. Bei ungültigen Dokumenten wäre es z. B. "Dokumente" oder "Dokument-ID".

Status

Enumeration

Status

Wert	Beschreibung
Failed	Fehler beim vorgang mit langer Ausführung.
NotStarted	Der lange ausgeführte Vorgang wurde noch nicht gestartet.
Running	Der lange ausgeführte Vorgang wird zurzeit verarbeitet.
Succeeded	Der lange ausgeführte Vorgang wurde erfolgreich abgeschlossen.

Freigeben über

Endpoints - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Update an endpoint

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EndpointPropertiesUpdate

EndpointUpdate

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

Zusätzliche Ressourcen