Delen via

Endpoints - List

  • Referentie
Service:
Azure AI Services
API-versie:
v3.2-preview.2

Hiermee haalt u de lijst met eindpunten voor het geverifieerde abonnement op.

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints
Met optionele parameters: 
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip={skip}&top={top}&filter={filter}

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).
filter
 query

string

Een filterexpressie voor het selecteren van een subset van de beschikbare eindpunten.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=locale eq 'en-US'
skip
 query

integer (int32)

Aantal gegevenssets dat wordt overgeslagen.
top
 query

integer (int32)

Het aantal gegevenssets dat wordt opgenomen na het overslaan.

Antwoorden

Name Type Description
200 OK

PaginatedEndpoints

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 aan het token toevoegt door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get all endpoints
Get all queued endpoints.

Get all endpoints

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Voorbeeldrespons

Statuscode:
200 
{
  "values": [
    {
      "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"
    },
    {
      "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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "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": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'

Voorbeeldrespons

Statuscode:
200 
{
  "values": [
    {
      "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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "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": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "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
EntityError

EntityError
EntityReference

EntityReference
Error

Fout
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedEndpoints

PaginatedEndpoints
Status

Toestand

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde Description
DataImportFailed

Het importeren van gegevens is mislukt.
DeleteNotAllowed

Verwijderen is niet toegestaan.
DeployNotAllowed

Implementeren is niet toegestaan.
DeployingFailedModel

Het implementeren van een mislukt model.
EmptyRequest

Lege aanvraag.
EndpointCannotBeDefault

Eindpunt kan niet standaard zijn.
EndpointNotUpdatable

Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging

Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris

Het aantal opnamen is overschreden.
FailedDataset

Mislukte gegevensset.
Forbidden

Verboden.
InUseViolation

Schending van gebruik.
InaccessibleCustomerStorage

Niet-toegankelijke opslag van klanten.
InvalidAdaptationMapping

Ongeldige aanpassingstoewijzing.
InvalidBaseModel

Ongeldig basismodel.
InvalidCallbackUri

Ongeldige callback-URI.
InvalidCollection

Ongeldige verzameling.
InvalidDataset

Ongeldige gegevensset.
InvalidDocument

Ongeldig document.
InvalidDocumentBatch

Ongeldige documentbatch.
InvalidLocale

Ongeldige landinstelling.
InvalidLogDate

Ongeldige logboekdatum.
InvalidLogEndTime

Ongeldige eindtijd van logboek.
InvalidLogId

Ongeldige logboek-id.
InvalidLogStartTime

Ongeldige begintijd voor logboeken.
InvalidModel

Ongeldig model.
InvalidModelUri

Ongeldige model-URI.
InvalidParameter

Ongeldige parameter.
InvalidParameterValue

Ongeldige parameterwaarde.
InvalidPayload

Ongeldige nettolading.
InvalidPermissions

Ongeldige machtigingen.
InvalidPrerequisite

Ongeldige vereiste.
InvalidProductId

Ongeldige product-id.
InvalidProject

Ongeldig project.
InvalidProjectKind

Ongeldig projecttype.
InvalidRecordingsUri

Ongeldige opnamen-URI.
InvalidRequestBodyFormat

Ongeldige indeling voor de hoofdtekst van de aanvraag.
InvalidSasValidityDuration

Ongeldige geldigheidsduur van SAS.
InvalidSkipTokenForLogs

Ongeldig skip-token voor logboeken.
InvalidSourceAzureResourceId

Ongeldige azure-bronresource-id.
InvalidSubscription

Ongeldig abonnement.
InvalidTest

Ongeldige test.
InvalidTimeToLive

Ongeldige time to live.
InvalidTopForLogs

Ongeldig bovenaan voor logboeken.
InvalidTranscription

Ongeldige transcriptie.
InvalidWebHookEventKind

Ongeldig gebeurtenistype webhook.
MissingInputRecords

Ontbrekende invoerrecords.
ModelCopyOperationExists

Er bestaat een modelkopiebewerking.
ModelDeploymentNotCompleteState

Modelimplementatie is niet voltooid.
ModelDeprecated

Model afgeschaft.
ModelExists

Het model bestaat.
ModelMismatch

Model komt niet overeen.
ModelNotDeployable

Model kan niet worden geïmplementeerd.
ModelVersionIncorrect

Modelversie onjuist.
NoUtf8WithBom

Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset

Slechts één van url's of containers of gegevenssets.
ProjectGenderMismatch

Project geslacht komt niet overeen.
QuotaViolation

Quotumschending.
SingleDefaultEndpoint

Eén standaardeindpunt.
SkuLimitsExist

Er bestaan SKU-limieten.
SubscriptionNotFound

Abonnement is niet gevonden.
UnexpectedError

Onverwachte fout.
UnsupportedClassBasedAdaptation

Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta

Niet-ondersteunde delta.
UnsupportedDynamicConfiguration

Niet-ondersteunde dynamische configuratie.
UnsupportedFilter

Niet-ondersteund filter.
UnsupportedLanguageCode

Niet-ondersteunde taalcode.
UnsupportedOrderBy

Niet-ondersteunde volgorde door.
UnsupportedPagination

Niet-ondersteunde paginering.
UnsupportedTimeRange

Niet-ondersteund tijdsbereik.

Endpoint

Object

Eindpunt

Name Type Description
createdDateTime

string (date-time)

Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt 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 maximale toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description

string

De beschrijving van het object.
displayName

string

minLength: 1

De weergavenaam van het object.
lastActionDateTime

string (date-time)

Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt 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

minLength: 1

De landinstelling van de ingesloten gegevens.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string (uri)

De locatie van deze entiteit.
status

Status

Toestand
De huidige status van de API beschrijven
text

string

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

EndpointLinks

Name Type Description
logs

string (uri)

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

string (uri)

Het REST-eindpunt voor aanvragen tot 60 seconden.
restDictation

string (uri)

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

string (uri)

Het REST-eindpunt voor korte aanvragen tot 15 seconden.
webSocketConversation

string (uri)

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

string (uri)

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

string (uri)

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

EndpointProperties

Object

EndpointProperties

Name Type Description
email

string

Het e-mailadres waarnaar e-mailmeldingen moeten worden verzonden 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 de 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 heeft bereikt na voltooiing (geslaagd of mislukt), wordt het automatisch verwijderd. Als u deze waarde 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).

EntityError

Object

EntityError

Name Type Description
code

string

De code van deze fout.
message

string

Het bericht voor deze fout.

EntityReference

Object

EntityReference

Name Type Description
self

string (uri)

De locatie van de entiteit waarnaar wordt verwezen.

Error

Object

Fout

Name Type Description
code

ErrorCode

ErrorCode
Foutcodes op hoog niveau.
details

Error[]

Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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

Inventarisatie

ErrorCode

Waarde Description
Conflict

Vertegenwoordiging van de conflictfoutcode.
Forbidden

Vertegenwoordiging van de verboden foutcode.
InternalCommunicationFailed

De foutcode voor de interne communicatie is mislukt.
InternalServerError

De foutcode van de interne server vertegenwoordigt.
InvalidArgument

De foutcode van het ongeldige argument vertegenwoordigt.
InvalidRequest

De foutcode van de ongeldige aanvraag vertegenwoordigt.
NotAllowed

Vertegenwoordiging van de niet-toegestane foutcode.
NotFound

De foutcode wordt niet gevonden.
PipelineError

De foutcode van de pijplijnfout weergeven.
ServiceUnavailable

Vertegenwoordiging van de service niet-beschikbare foutcode.
TooManyRequests

De foutcode voor te veel aanvragen vertegenwoordigt.
Unauthorized

Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnprocessableEntity

De foutcode van de niet-verwerkte entiteit vertegenwoordigt.
UnsupportedMediaType

De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.

InnerError

Object

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde opsomming van foutcodes.
details

object

Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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.

PaginatedEndpoints

Object

PaginatedEndpoints

Name Type Description
@nextLink

string (uri)

Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.
values

Endpoint[]

Een lijst met entiteiten die worden beperkt door de doorgegeven queryparameters 'skip' en 'top' of de bijbehorende standaardwaarden.

Wanneer u een lijst doorloopt met behulp van paginering en het parallel verwijderen van entiteiten, worden sommige entiteiten overgeslagen in de resultaten. Het is raadzaam om een lijst op de client te maken en te verwijderen na het ophalen van de volledige lijst.

Status

Inventarisatie

Toestand

Waarde Description
Failed

De langdurige bewerking is mislukt.
NotStarted

De langdurige bewerking is nog niet gestart.
Running

De langdurige bewerking wordt momenteel verwerkt.
Succeeded

De langdurige bewerking is voltooid.