Delen via


Endpoints - Update

Updates de metagegevens van het eindpunt dat wordt geïdentificeerd door de opgegeven id.

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

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

De id van het eindpunt.

Aanvraagbody

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

Name Type Description
customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.

description

string

De beschrijving van het object.

displayName

string

De naam van het object.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Antwoorden

Name Type Description
200 OK

Endpoint

OK

Kopteksten

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik toevoegt aan het token door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Update an endpoint

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
DetailedErrorCode

DetailedErrorCode

Endpoint

Eindpunt

EndpointLinks

EndpointLinks

EndpointProperties

EndpointProperties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EndpointUpdate

EndpointUpdate

EntityError

EntityError

EntityReference

EntityReference

Error

Fout

ErrorCode

ErrorCode

InnerError

InnerError

Status

Status

DetailedErrorCode

DetailedErrorCode

Name Type Description
DataImportFailed

string

Het importeren van gegevens is mislukt.

DeleteNotAllowed

string

Verwijderen is niet toegestaan.

DeployNotAllowed

string

Implementeren is niet toegestaan.

DeployingFailedModel

string

Het implementeren van een mislukt model.

EmptyRequest

string

Lege aanvraag.

EndpointCannotBeDefault

string

Eindpunt kan niet standaard zijn.

EndpointNotUpdatable

string

Eindpunt kan niet worden bijgewerkt.

EndpointWithoutLogging

string

Eindpunt zonder logboekregistratie.

ExceededNumberOfRecordingsUris

string

Het aantal opnamen is overschreden.

FailedDataset

string

Mislukte gegevensset.

Forbidden

string

Verboden.

InUseViolation

string

In gebruiksovertreding.

InaccessibleCustomerStorage

string

Niet-toegankelijke klantopslag.

InvalidAdaptationMapping

string

Ongeldige aanpassingstoewijzing.

InvalidBaseModel

string

Ongeldig basismodel.

InvalidCallbackUri

string

Ongeldige callback-URI.

InvalidCollection

string

Ongeldige verzameling.

InvalidDataset

string

Ongeldige gegevensset.

InvalidDocument

string

Ongeldig document.

InvalidDocumentBatch

string

Ongeldige documentbatch.

InvalidLocale

string

Ongeldige landinstelling.

InvalidLogDate

string

Ongeldige logboekdatum.

InvalidLogEndTime

string

Ongeldige eindtijd van logboek.

InvalidLogId

string

Ongeldige logboek-id.

InvalidLogStartTime

string

Ongeldige begintijd van logboek.

InvalidModel

string

Ongeldig model.

InvalidModelUri

string

Ongeldige model-URI.

InvalidParameter

string

Ongeldige parameter.

InvalidParameterValue

string

Ongeldige parameterwaarde.

InvalidPayload

string

Ongeldige nettolading.

InvalidPermissions

string

Ongeldige machtigingen.

InvalidPrerequisite

string

Ongeldige vereiste.

InvalidProductId

string

Ongeldige product-id.

InvalidProject

string

Ongeldig project.

InvalidProjectKind

string

Ongeldige projectsoort.

InvalidRecordingsUri

string

Ongeldige URI voor opnamen.

InvalidRequestBodyFormat

string

Ongeldige indeling van aanvraagbody.

InvalidSasValidityDuration

string

Ongeldige geldigheidsduur sas.

InvalidSkipTokenForLogs

string

Ongeldig token voor overslaan voor logboeken.

InvalidSourceAzureResourceId

string

Ongeldige bron-id van Azure-resource.

InvalidSubscription

string

Ongeldig abonnement.

InvalidTest

string

Ongeldige test.

InvalidTimeToLive

string

Ongeldige time to live.

InvalidTopForLogs

string

Ongeldige bovenkant voor logboeken.

InvalidTranscription

string

Ongeldige transcriptie.

InvalidWebHookEventKind

string

Ongeldig soort webhook gebeurtenis.

MissingInputRecords

string

Ontbrekende invoerrecords.

ModelCopyOperationExists

string

De kopieerbewerking van het model bestaat.

ModelDeploymentNotCompleteState

string

De status modelimplementatie is niet voltooid.

ModelDeprecated

string

Het model is afgeschaft.

ModelExists

string

Het model bestaat.

ModelMismatch

string

Model komt niet overeen.

ModelNotDeployable

string

Het model kan niet worden geïmplementeerd.

ModelVersionIncorrect

string

Modelversie onjuist.

NoUtf8WithBom

string

Geen utf8 met bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Slechts één van de URL's of container of gegevensset.

ProjectGenderMismatch

string

Het geslacht van het project komt niet overeen.

QuotaViolation

string

Quotumschending.

SingleDefaultEndpoint

string

Eén standaardeindpunt.

SkuLimitsExist

string

Er bestaan SKU-limieten.

SubscriptionNotFound

string

Kan het abonnement niet vinden.

UnexpectedError

string

Onverwachte fout.

UnsupportedClassBasedAdaptation

string

Niet-ondersteunde aanpassing op basis van klassen.

UnsupportedDelta

string

Niet-ondersteunde delta.

UnsupportedDynamicConfiguration

string

Niet-ondersteunde dynamische configuratie.

UnsupportedFilter

string

Niet-ondersteund filter.

UnsupportedLanguageCode

string

Niet-ondersteunde taalcode.

UnsupportedOrderBy

string

Niet-ondersteunde bestelling door.

UnsupportedPagination

string

Niet-ondersteunde paginering.

UnsupportedTimeRange

string

Niet-ondersteund tijdsbereik.

Endpoint

Eindpunt

Name Type Description
createdDateTime

string

De tijdstempel waarop het object is gemaakt. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.

description

string

De beschrijving van het object.

displayName

string

De weergavenaam van het object.

lastActionDateTime

string

Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

EndpointLinks

EndpointLinks

locale

string

De landinstelling van de opgenomen gegevens.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointProperties

EndpointProperties

self

string

De locatie van deze entiteit.

status

Status

Status
De huidige status van de API beschrijven

text

string

De tekst die wordt gebruikt om een taalmodel voor dit eindpunt aan te passen.

EndpointLinks

Name Type Description
logs

string

De audio- en transcriptielogboeken voor dit eindpunt. Zie bewerking 'Endpoints_ListLogs' voor meer informatie.

restConversation

string

Het REST-eindpunt voor aanvragen tot 60 seconden.

restDictation

string

Het REST-eindpunt voor aanvragen tot 60 seconden, ter ondersteuning van het dicteren van leestekens.

restInteractive

string

Het REST-eindpunt voor korte aanvragen tot 15 seconden.

webSocketConversation

string

Het Speech SDK-eindpunt voor lange aanvragen met meerdere eindresultaten.

webSocketDictation

string

Het Speech SDK-eindpunt voor lange aanvragen met meerdere eindresultaten, ter ondersteuning van het dicteren van leestekens.

webSocketInteractive

string

Het Speech SDK-eindpunt voor korte aanvragen tot 15 seconden met één eindresultaat.

EndpointProperties

EndpointProperties

Name Type Description
email

string

Het e-mailadres waarnaar u e-mailmeldingen wilt verzenden voor het geval de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.

error

EntityError

EntityError

loggingEnabled

boolean

Een waarde die aangeeft of logboekregistratie van inhoud (audio & transcripties) wordt gebruikt voor een implementatie.

timeToLive

string

Hoe lang het eindpunt in het systeem wordt bewaard. Zodra het eindpunt de time-to-live bereikt na voltooiing (geslaagd of mislukt), wordt het automatisch verwijderd. Als u deze waarde of instelling niet instelt op 0, wordt automatisch verwijderen uitgeschakeld. De langste ondersteunde duur is 31 dagen. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

EndpointPropertiesUpdate

Name Type Description
contentLoggingEnabled

boolean

Een waarde die aangeeft of logboekregistratie van inhoud (audio & transcripties) wordt gebruikt voor een implementatie.

EndpointUpdate

EndpointUpdate

Name Type Description
customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.

description

string

De beschrijving van het object.

displayName

string

De naam van het object.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

EndpointPropertiesUpdate

EndpointPropertiesUpdate

EntityError

EntityError

Name Type Description
code

string

De code van deze fout.

message

string

Het bericht voor deze fout.

EntityReference

EntityReference

Name Type Description
self

string

De locatie van de entiteit waarnaar wordt verwezen.

Error

Fout

Name Type Description
code

ErrorCode

ErrorCode
Foutcodes op hoog niveau.

details

Error[]

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).

message

string

Foutbericht op hoog niveau.

target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

ErrorCode

Name Type Description
Conflict

string

Vertegenwoordigt de conflictfoutcode.

Forbidden

string

Vertegenwoordigt de verboden foutcode.

InternalCommunicationFailed

string

De foutcode voor de interne communicatie mislukt.

InternalServerError

string

Vertegenwoordigt de foutcode van de interne serverfout.

InvalidArgument

string

Vertegenwoordigt de foutcode van het ongeldige argument.

InvalidRequest

string

Vertegenwoordigt de ongeldige aanvraagfoutcode.

NotAllowed

string

Vertegenwoordigt de niet-toegestane foutcode.

NotFound

string

Vertegenwoordigt de foutcode die niet is gevonden.

PipelineError

string

Vertegenwoordigt de foutcode van de pijplijnfout.

ServiceUnavailable

string

Vertegenwoordigt de foutcode die niet beschikbaar is voor de service.

TooManyRequests

string

Vertegenwoordigt de foutcode voor te veel aanvragen.

Unauthorized

string

Vertegenwoordigt de foutcode voor onbevoegden.

UnprocessableEntity

string

Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.

UnsupportedMediaType

string

Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

InnerError

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde foutcode- enum.

details

object

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de API-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen Foutcode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).

message

string

Foutbericht op hoog niveau.

target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

Status

Status

Name Type Description
Failed

string

De langdurige bewerking is mislukt.

NotStarted

string

De langdurige bewerking is nog niet gestart.

Running

string

De langdurige bewerking wordt momenteel verwerkt.

Succeeded

string

De langdurige bewerking is voltooid.