Udostępnij za pośrednictwem


Endpoints - Update

Aktualizacje metadanych punktu końcowego zidentyfikowanego przez dany identyfikator.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

Identyfikator punktu końcowego.

Treść żądania

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

Nazwa Typ Opis
customProperties

object

Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.

description

string

Opis obiektu.

displayName

string

Nazwa obiektu.

model

EntityReference

Odwołanie do jednostki

project

EntityReference

Odwołanie do jednostki

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Odpowiedzi

Nazwa Typ Opis
200 OK

Endpoint

OK

Nagłówki

Retry-After: integer

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z JWT zwrócony przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Update an endpoint

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
DetailedErrorCode

DetailedErrorCode

Endpoint

Punkt końcowy

EndpointLinks

Linki punktu końcowego

EndpointProperties

Właściwości punktu końcowego

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EndpointUpdate

EndpointUpdate

EntityError

EntityError

EntityReference

Odwołanie do jednostki

Error

Błąd

ErrorCode

ErrorCode

InnerError

Błąd wewnętrzny

Status

Stan

DetailedErrorCode

DetailedErrorCode

Nazwa Typ Opis
DataImportFailed

string

Importowanie danych nie powiodło się.

DeleteNotAllowed

string

Usuń niedozwolone.

DeployNotAllowed

string

Wdrażanie jest niedozwolone.

DeployingFailedModel

string

Wdrażanie modelu, który zakończył się niepowodzeniem.

EmptyRequest

string

Puste żądanie.

EndpointCannotBeDefault

string

Punkt końcowy nie może być domyślny.

EndpointNotUpdatable

string

Punkt końcowy nie można zaktualizować.

EndpointWithoutLogging

string

Punkt końcowy bez rejestrowania.

ExceededNumberOfRecordingsUris

string

Przekroczono liczbę nagrań uris.

FailedDataset

string

Zestaw danych, który zakończył się niepowodzeniem.

Forbidden

string

Zakazane.

InUseViolation

string

Naruszenie użycia.

InaccessibleCustomerStorage

string

Niedostępny magazyn klienta.

InvalidAdaptationMapping

string

Nieprawidłowe mapowanie adaptacji.

InvalidBaseModel

string

Nieprawidłowy model podstawowy.

InvalidCallbackUri

string

Nieprawidłowy identyfikator URI wywołania zwrotnego.

InvalidCollection

string

Nieprawidłowa kolekcja.

InvalidDataset

string

Nieprawidłowy zestaw danych.

InvalidDocument

string

Nieprawidłowy dokument.

InvalidDocumentBatch

string

Nieprawidłowa partia dokumentów.

InvalidLocale

string

Nieprawidłowe ustawienia regionalne.

InvalidLogDate

string

Nieprawidłowa data dziennika.

InvalidLogEndTime

string

Nieprawidłowy czas zakończenia dziennika.

InvalidLogId

string

Nieprawidłowy identyfikator dziennika.

InvalidLogStartTime

string

Nieprawidłowy czas rozpoczęcia dziennika.

InvalidModel

string

Nieprawidłowy model.

InvalidModelUri

string

Nieprawidłowy identyfikator URI modelu.

InvalidParameter

string

Nieprawidłowy parametr.

InvalidParameterValue

string

Nieprawidłowa wartość parametru.

InvalidPayload

string

Nieprawidłowy ładunek.

InvalidPermissions

string

Nieprawidłowe uprawnienia.

InvalidPrerequisite

string

Nieprawidłowe wymaganie wstępne.

InvalidProductId

string

Nieprawidłowy identyfikator produktu.

InvalidProject

string

Nieprawidłowy projekt.

InvalidProjectKind

string

Nieprawidłowy rodzaj projektu.

InvalidRecordingsUri

string

Nieprawidłowy identyfikator URI nagrań.

InvalidRequestBodyFormat

string

Nieprawidłowy format treści żądania.

InvalidSasValidityDuration

string

Nieprawidłowy czas trwania ważności sygnatury dostępu współdzielonego.

InvalidSkipTokenForLogs

string

Nieprawidłowy token pomijania dzienników.

InvalidSourceAzureResourceId

string

Nieprawidłowy źródłowy identyfikator zasobu platformy Azure.

InvalidSubscription

string

Nieprawidłowa subskrypcja.

InvalidTest

string

Nieprawidłowy test.

InvalidTimeToLive

string

Nieprawidłowy czas wygaśnięcia.

InvalidTopForLogs

string

Nieprawidłowa górna wierzchołka dzienników.

InvalidTranscription

string

Nieprawidłowa transkrypcja.

InvalidWebHookEventKind

string

Nieprawidłowy rodzaj zdarzenia haka internetowego.

MissingInputRecords

string

Brak rekordów wejściowych.

ModelCopyOperationExists

string

Operacja kopiowania modelu istnieje.

ModelDeploymentNotCompleteState

string

Wdrożenie modelu nie zostało ukończone.

ModelDeprecated

string

Model przestarzały.

ModelExists

string

Model istnieje.

ModelMismatch

string

Niezgodność modelu.

ModelNotDeployable

string

Model nie można wdrożyć.

ModelVersionIncorrect

string

Nieprawidłowa wersja modelu.

NoUtf8WithBom

string

Brak utf8 z bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Tylko jeden z adresów URL lub kontenera lub zestawu danych.

ProjectGenderMismatch

string

Niezgodność płci projektu.

QuotaViolation

string

Naruszenie limitu przydziału.

SingleDefaultEndpoint

string

Pojedynczy domyślny punkt końcowy.

SkuLimitsExist

string

Istnieją limity jednostek SKU.

SubscriptionNotFound

string

Nie można odnaleźć subskrypcji.

UnexpectedError

string

Nieoczekiwany błąd.

UnsupportedClassBasedAdaptation

string

Nieobsługiwana adaptacja oparta na klasach.

UnsupportedDelta

string

Nieobsługiwana delta.

UnsupportedDynamicConfiguration

string

Nieobsługiwana konfiguracja dynamiczna.

UnsupportedFilter

string

Nieobsługiwany filtr.

UnsupportedLanguageCode

string

Nieobsługiwany kod języka.

UnsupportedOrderBy

string

Nieobsługiwane zamówienie według.

UnsupportedPagination

string

Nieobsługiwane stronicowanie.

UnsupportedTimeRange

string

Nieobsługiwany zakres czasu.

Endpoint

Punkt końcowy

Nazwa Typ Opis
createdDateTime

string

Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów to 10.

description

string

Opis obiektu.

displayName

string

Nazwa wyświetlana obiektu.

lastActionDateTime

string

Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

EndpointLinks

Linki punktu końcowego

locale

string

Ustawienia regionalne zawartych danych.

model

EntityReference

Odwołanie do jednostki

project

EntityReference

Odwołanie do jednostki

properties

EndpointProperties

Właściwości punktu końcowego

self

string

Lokalizacja tej jednostki.

status

Status

Stan
Opis bieżącego stanu interfejsu API

text

string

Tekst używany do dostosowywania modelu językowego dla tego punktu końcowego.

Linki punktu końcowego

Nazwa Typ Opis
logs

string

Dzienniki audio i transkrypcji dla tego punktu końcowego. Aby uzyskać więcej informacji, zobacz operację "Endpoints_ListLogs".

restConversation

string

Punkt końcowy REST dla żądań do 60 sekund.

restDictation

string

Punkt końcowy REST dla żądań do 60 sekund, obsługujący dyktowanie znaków interpunkcyjnych.

restInteractive

string

Punkt końcowy REST dla krótkich żądań do 15 sekund.

webSocketConversation

string

Punkt końcowy zestawu SPEECH SDK dla długich żądań z wieloma końcowymi wynikami.

webSocketDictation

string

Punkt końcowy zestawu SPEECH SDK dla długich żądań z wieloma końcowymi wynikami, obsługujący dyktowanie znaków interpunkcyjnych.

webSocketInteractive

string

Punkt końcowy zestawu SPEECH SDK dla krótkich żądań do 15 sekund z pojedynczym wynikiem końcowym.

EndpointProperties

Właściwości punktu końcowego

Nazwa Typ Opis
email

string

Adres e-mail do wysyłania powiadomień e-mail na wypadek zakończenia operacji. Wartość zostanie usunięta po pomyślnym wysłaniu wiadomości e-mail.

error

EntityError

EntityError

loggingEnabled

boolean

Wartość wskazująca, czy rejestrowanie zawartości (transkrypcje audio &) jest używane na potrzeby wdrożenia.

timeToLive

string

Jak długo punkt końcowy będzie przechowywany w systemie. Gdy punkt końcowy osiągnie czas wygaśnięcia po zakończeniu (zakończony powodzeniem lub niepowodzeniem), zostanie automatycznie usunięty. Ustawienie tej wartości lub wartości 0 nie spowoduje wyłączenia automatycznego usuwania. Najdłuższy obsługiwany czas trwania to 31 dni. Czas trwania jest zakodowany jako czas trwania ISO 8601 ("PnYnMnDTnHnMnS", zobacz https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Nazwa Typ Opis
contentLoggingEnabled

boolean

Wartość wskazująca, czy rejestrowanie zawartości (transkrypcje audio &) jest używane na potrzeby wdrożenia.

EndpointUpdate

EndpointUpdate

Nazwa Typ Opis
customProperties

object

Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów to 10.

description

string

Opis obiektu.

displayName

string

Nazwa obiektu.

model

EntityReference

Odwołanie do jednostki

project

EntityReference

Odwołanie do jednostki

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EntityError

EntityError

Nazwa Typ Opis
code

string

Kod tego błędu.

message

string

Komunikat o tym błędzie.

EntityReference

Odwołanie do jednostki

Nazwa Typ Opis
self

string

Lokalizacja odwoływania się do jednostki.

Error

Błąd

Nazwa Typ Opis
code

ErrorCode

ErrorCode
Kody błędów wysokiego poziomu.

details

Error[]

Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.

innerError

InnerError

Błąd wewnętrzny
Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), błąd wewnętrzny (można to zagnieżdżać).

message

string

Komunikat o błędzie wysokiego poziomu.

target

string

Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

ErrorCode

Nazwa Typ Opis
Conflict

string

Reprezentowanie kodu błędu powodującego konflikt.

Forbidden

string

Reprezentowanie niedozwolonego kodu błędu.

InternalCommunicationFailed

string

Reprezentowanie kodu błędu komunikacji wewnętrznej nie powiodło się.

InternalServerError

string

Reprezentowanie wewnętrznego kodu błędu serwera.

InvalidArgument

string

Reprezentowanie nieprawidłowego kodu błędu argumentu.

InvalidRequest

string

Reprezentowanie nieprawidłowego kodu błędu żądania.

NotAllowed

string

Reprezentowanie niedozwolonego kodu błędu.

NotFound

string

Reprezentowanie kodu błędu, który nie został znaleziony.

PipelineError

string

Reprezentowanie kodu błędu potoku.

ServiceUnavailable

string

Reprezentuje kod błędu niedostępności usługi.

TooManyRequests

string

Reprezentacja kodu błędu zbyt wielu żądań.

Unauthorized

string

Reprezentowanie nieautoryzowanego kodu błędu.

UnprocessableEntity

string

Reprezentowanie nieprzetworzonego kodu błędu jednostki.

UnsupportedMediaType

string

Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

InnerError

Błąd wewnętrzny

Nazwa Typ Opis
code

DetailedErrorCode

DetailedErrorCode
Szczegółowe wyliczenie kodu błędu.

details

object

Dodatkowe szczegóły dotyczące błędów i/lub oczekiwanych zasad.

innerError

InnerError

Błąd wewnętrzny
Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera on wymagane właściwości ErrorCode, komunikat i opcjonalne właściwości obiektu docelowego, szczegóły (para klucz-wartość), błąd wewnętrzny (można to zagnieżdżać).

message

string

Komunikat o błędzie wysokiego poziomu.

target

string

Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

Status

Stan

Nazwa Typ Opis
Failed

string

Długotrwała operacja nie powiodła się.

NotStarted

string

Długotrwała operacja nie została jeszcze uruchomiona.

Running

string

Długotrwała operacja jest obecnie przetwarzana.

Succeeded

string

Długotrwała operacja została pomyślnie ukończona.