Endpoints - List

Referens

Tjänst:: Azure AI Services

API-version:: v3.1

Hämtar listan över slutpunkter för den autentiserade prenumerationen.

GET {endpoint}/speechtotext/v3.1/endpoints

Med valfria parametrar:

GET {endpoint}/speechtotext/v3.1/endpoints?skip={skip}&top={top}&filter={filter}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
filter	query		string	Ett filtreringsuttryck för att välja en delmängd av de tillgängliga slutpunkterna. `- 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	Antal datauppsättningar som ska hoppas över.
top	query		integer int32	Antal datauppsättningar som ska tas med när du hoppar över.

Svar

Name	Typ	Description
200 OK	PaginatedEndpoints	OK Sidhuvuden Retry-After: integer
Other Status Codes	Error	Ett fel inträffade.

Name

Typ

Description

200 OK

PaginatedEndpoints

Sidhuvuden

Retry-After: integer

Other Status Codes

Error

Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från den JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Get all endpoints

Get all queued endpoints.

Get all endpoints

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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.1/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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"
    }
  ]
}

Definitioner

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Slutpunkt
EndpointLinks	SlutpunktLänkar
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
PaginatedEndpoints	SidnumreradeSlutpunkter
Status	Status

DetailedErrorCode

Name	Typ	Description
DataImportFailed	string	Dataimporten misslyckades.
DeleteNotAllowed	string	Ta bort tillåts inte.
DeployNotAllowed	string	Distribution tillåts inte.
DeployingFailedModel	string	Det gick inte att distribuera modellen.
EmptyRequest	string	Tom begäran.
EndpointCannotBeDefault	string	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	string	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	string	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	string	Överskred antalet inspelningar.
FailedDataset	string	Datauppsättningen misslyckades.
Forbidden	string	Förbjudet.
InUseViolation	string	Vid användningsöverträdelse.
InaccessibleCustomerStorage	string	Otillgänglig kundlagring.
InvalidAdaptationMapping	string	Ogiltig anpassningsmappning.
InvalidBaseModel	string	Ogiltig basmodell.
InvalidCallbackUri	string	Ogiltig återanrops-URI.
InvalidCollection	string	Ogiltig samling.
InvalidDataset	string	Ogiltig datauppsättning.
InvalidDocument	string	Ogiltigt dokument.
InvalidDocumentBatch	string	Ogiltig dokumentbatch.
InvalidLocale	string	Ogiltigt språk.
InvalidLogDate	string	Ogiltigt loggdatum.
InvalidLogEndTime	string	Ogiltig sluttid för logg.
InvalidLogId	string	Ogiltigt logg-ID.
InvalidLogStartTime	string	Ogiltig starttid för logg.
InvalidModel	string	Ogiltig modell.
InvalidModelUri	string	Ogiltig modell-URI.
InvalidParameter	string	Ogiltig parameter.
InvalidParameterValue	string	Ogiltigt parametervärde.
InvalidPayload	string	Ogiltig nyttolast.
InvalidPermissions	string	Ogiltiga behörigheter.
InvalidPrerequisite	string	Ogiltigt krav.
InvalidProductId	string	Ogiltigt produkt-ID.
InvalidProject	string	Ogiltigt projekt.
InvalidProjectKind	string	Ogiltig projekttyp.
InvalidRecordingsUri	string	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	string	Ogiltigt format för begärandetext.
InvalidSasValidityDuration	string	Ogiltig varaktighet för SAS-giltighet.
InvalidSkipTokenForLogs	string	Ogiltig hopptoken för loggar.
InvalidSubscription	string	Ogiltig prenumeration.
InvalidTest	string	Ogiltigt test.
InvalidTimeToLive	string	Ogiltigt time to live.
InvalidTopForLogs	string	Ogiltig topp för loggar.
InvalidTranscription	string	Ogiltig transkription.
InvalidWebHookEventKind	string	Ogiltig webhookhändelsetyp.
MissingInputRecords	string	Indataposter saknas.
ModelDeploymentNotCompleteState	string	Modelldistributionen är inte fullständigt.
ModelDeprecated	string	Modellen är inaktuell.
ModelExists	string	Modellen finns.
ModelMismatch	string	Modellmatchningsfel.
ModelNotDeployable	string	Modellen kan inte distribueras.
ModelVersionIncorrect	string	Felaktig modellversion.
NoUtf8WithBom	string	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Endast en av URL:erna, containern eller datauppsättningen.
ProjectGenderMismatch	string	Projektets könsmatchningsfel.
QuotaViolation	string	Kvotöverträdelse.
SingleDefaultEndpoint	string	Enskild standardslutpunkt.
SkuLimitsExist	string	Det finns SKU-gränser.
SubscriptionNotFound	string	Det går inte att hitta prenumerationen.
UnexpectedError	string	Oväntat fel.
UnsupportedClassBasedAdaptation	string	Klassbaserad anpassning stöds inte.
UnsupportedDelta	string	Delta stöds inte.
UnsupportedDynamicConfiguration	string	Dynamisk konfiguration som inte stöds.
UnsupportedFilter	string	Filter som inte stöds.
UnsupportedLanguageCode	string	Språkkod som inte stöds.
UnsupportedOrderBy	string	Beställningen stöds inte av.
UnsupportedPagination	string	Sidnumrering stöds inte.
UnsupportedTimeRange	string	Tidsintervallet stöds inte.

Endpoint

Slutpunkt

Name	Typ	Description
createdDateTime	string	Tidsstämpeln när objektet skapades. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description	string	Beskrivningen av objektet.
displayName	string	Objektets visningsnamn.
lastActionDateTime	string	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	SlutpunktLänkar
locale	string	Nationella inställningar för inneslutna data.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string	Platsen för den här entiteten.
status	Status	Status Beskriva API:ets aktuella tillstånd
text	string	Den text som används för att anpassa en språkmodell för den här slutpunkten.

EndpointLinks

SlutpunktLänkar

Name	Typ	Description
logs	string	Ljud- och transkriptionsloggarna för den här slutpunkten. Mer information finns i åtgärden "Endpoints_ListLogs".
restConversation	string	REST-slutpunkten för begäranden upp till 60 sekunder.
restDictation	string	REST-slutpunkten för begäranden upp till 60 sekunder, med stöd för diktering av skiljetecken.
restInteractive	string	REST-slutpunkten för korta begäranden upp till 15 sekunder.
webSocketConversation	string	Speech SDK-slutpunkten för långa begäranden med flera slutliga resultat.
webSocketDictation	string	Speech SDK-slutpunkten för långa begäranden med flera slutliga resultat, med stöd för diktering av skiljetecken.
webSocketInteractive	string	Speech SDK-slutpunkten för korta begäranden upp till 15 sekunder med ett enda slutresultat.

EndpointProperties

Name	Typ	Description
email	string	E-postadressen som e-postaviseringar ska skickas till om åtgärden slutförs. Värdet tas bort när e-postmeddelandet har skickats.
error	EntityError	EntityError
loggingEnabled	boolean	Ett värde som anger om innehållsloggning (ljud & transkriptioner) används för en distribution.
timeToLive	string	Hur länge slutpunkten ska behållas i systemet. När slutpunkten når time to live efter slutförandet (lyckat eller misslyckat) tas den bort automatiskt. Om du inte anger det här värdet eller inställningen till 0 inaktiveras automatisk borttagning. Den längsta varaktigheten som stöds är 31 dagar. Varaktigheten kodas som ISO 8601-varaktighet ("PnYnMnDTnHnMnS", se https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Name	Typ	Description
code	string	Koden för det här felet.
message	string	Meddelandet för det här felet.

EntityReference

Name	Typ	Description
self	string	Platsen för den refererade entiteten.

Error

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder på hög nivå.
details	Error[]	Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error(this can be nested).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name	Typ	Description
Conflict	string	Representerar konfliktfelkoden.
Forbidden	string	Representerar den förbjudna felkoden.
InternalCommunicationFailed	string	Representerar felkoden för den interna kommunikationen misslyckades.
InternalServerError	string	Representerar den interna felkoden för servern.
InvalidArgument	string	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	string	Representerar den ogiltiga felkoden för begäran.
NotAllowed	string	Representerar den felkod som inte tillåts.
NotFound	string	Representerar felkoden hittades inte.
PipelineError	string	Representerar felkoden för pipelinefel.
ServiceUnavailable	string	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	string	Representerar felkoden för för många begäranden.
Unauthorized	string	Representerar den obehöriga felkoden.
UnprocessableEntity	string	Representerar felkoden för entiteten som inte kan bearbetas.
UnsupportedMediaType	string	Representerar felkoden för medietypen som inte stöds.

InnerError

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Detaljerad felkodsuppräkning.
details	object	Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error(this can be nested).
message	string	Felmeddelande på hög nivå.
target	string	Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

PaginatedEndpoints

SidnumreradeSlutpunkter

Name	Typ	Description
@nextLink	string	En länk till nästa uppsättning sidnumrerade resultat om det finns fler tillgängliga entiteter. annars null.
values	Endpoint[]	En lista över entiteter som begränsas av antingen de skickade frågeparametrarna "skip" och "top" eller deras standardvärden. När du itererar genom en lista med sidnumrering och tar bort entiteter parallellt hoppas vissa entiteter över i resultatet. Vi rekommenderar att du skapar en lista på klienten och tar bort efter hämtningen av den fullständiga listan.

Name

Typ

Description

@nextLink

string

En länk till nästa uppsättning sidnumrerade resultat om det finns fler tillgängliga entiteter. annars null.

values

Endpoint[]

En lista över entiteter som begränsas av antingen de skickade frågeparametrarna "skip" och "top" eller deras standardvärden.

När du itererar genom en lista med sidnumrering och tar bort entiteter parallellt hoppas vissa entiteter över i resultatet. Vi rekommenderar att du skapar en lista på klienten och tar bort efter hämtningen av den fullständiga listan.

Status

Name	Typ	Description
Failed	string	Den långvariga åtgärden misslyckades.
NotStarted	string	Den långvariga åtgärden har ännu inte startats.
Running	string	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	string	Den långvariga åtgärden har slutförts.

Dela via

Endpoints - List

URI-parametrar

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Get all endpoints

Exempelbegäran

Exempelsvar

Get all queued endpoints.

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status

Ytterligare resurser