Endpoints - List

Başvuru

Hizmet:: Azure AI Services

API Sürümü:: 3.2

Kimliği doğrulanmış abonelik için uç noktaların listesini alır.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve konak adı, örneğin: https://westus.api.cognitive.microsoft.com).
filter	query		string	Kullanılabilir uç noktaların bir alt kümesini seçmek için bir filtreleme ifadesi. `- 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	Atlanacak veri kümesi sayısı.
top	query		integer int32	Atladıktan sonra eklenecek veri kümesi sayısı.

Yanıtlar

Name	Tür	Description
200 OK	PaginatedEndpoints	Tamam Üst Bilgiler Retry-After: integer
Other Status Codes	Error	Bir hata oluşmuştur.

Name

Tür

Description

200 OK

PaginatedEndpoints

Tamam

Üst Bilgiler

Retry-After: integer

Other Status Codes

Error

Bir hata oluşmuştur.

Güvenlik

Ocp-Apim-Subscription-Key

Bilişsel hizmetler hesap anahtarınızı burada sağlayın.

Tür: apiKey
İçinde: header

Authorization

Bu bölgenin STS tarafından döndürülen JWT'den bir erişim belirteci sağlayın. STS URL'sine aşağıdaki sorgu dizesini ekleyerek yönetim kapsamını belirteci eklediğinizden emin olun: ?scope=speechservicesmanagement

Tür: apiKey
İçinde: header

Örnekler

Get all endpoints

Get all queued endpoints.

Get all endpoints

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

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

Get all queued endpoints.

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 200

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

Tanımlar

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Uç Nokta
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Hata
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedEndpoints	PaginatedEndpoints
Status	Durum

DetailedErrorCode

Name	Tür	Description
DataImportFailed	string	Veri içeri aktarılamadı.
DeleteNotAllowed	string	Silmeye izin verilmiyor.
DeployNotAllowed	string	Dağıtıma izin verilmiyor.
DeployingFailedModel	string	Başarısız modeli dağıtma.
EmptyRequest	string	Boş İstek.
EndpointCannotBeDefault	string	Uç nokta varsayılan olamaz.
EndpointNotUpdatable	string	Uç nokta güncelleştirilebilir değil.
EndpointWithoutLogging	string	Günlüğe kaydetmeden uç nokta.
ExceededNumberOfRecordingsUris	string	Kayıt sayısı aşıldı uris.
FailedDataset	string	Başarısız veri kümesi.
Forbidden	string	Yasak.
InUseViolation	string	Kullanım ihlali.
InaccessibleCustomerStorage	string	Erişilemez müşteri depolama alanı.
InvalidAdaptationMapping	string	Geçersiz uyarlama eşlemesi.
InvalidBaseModel	string	Geçersiz temel model.
InvalidCallbackUri	string	Geçersiz geri çağırma uri'si.
InvalidChannels	string	Geçersiz kanallar.
InvalidCollection	string	Geçersiz koleksiyon.
InvalidDataset	string	Geçersiz veri kümesi.
InvalidDocument	string	Geçersiz Belge.
InvalidDocumentBatch	string	Geçersiz Belge Toplu İşlemi.
InvalidLocale	string	Geçersiz yerel ayar.
InvalidLogDate	string	Geçersiz günlük tarihi.
InvalidLogEndTime	string	Geçersiz günlük bitiş saati.
InvalidLogId	string	Geçersiz günlük kimliği.
InvalidLogStartTime	string	Geçersiz günlük başlangıç saati.
InvalidModel	string	Geçersiz model.
InvalidModelUri	string	Geçersiz model uri'si.
InvalidParameter	string	Geçersiz parametre.
InvalidParameterValue	string	Geçersiz parametre değeri.
InvalidPayload	string	Geçersiz yük.
InvalidPermissions	string	Geçersiz izinler.
InvalidPrerequisite	string	Geçersiz önkoşul.
InvalidProductId	string	Geçersiz ürün kimliği.
InvalidProject	string	Geçersiz proje.
InvalidProjectKind	string	Geçersiz proje türü.
InvalidRecordingsUri	string	Geçersiz kayıt uri'si.
InvalidRequestBodyFormat	string	Geçersiz istek gövdesi biçimi.
InvalidSasValidityDuration	string	Geçersiz sas geçerlilik süresi.
InvalidSkipTokenForLogs	string	Günlükler için geçersiz atlama belirteci.
InvalidSourceAzureResourceId	string	Geçersiz kaynak Azure kaynak kimliği.
InvalidSubscription	string	Geçersiz abonelik.
InvalidTest	string	Geçersiz test.
InvalidTimeToLive	string	Geçersiz yaşam süresi.
InvalidTopForLogs	string	Günlükler için geçersiz üst.
InvalidTranscription	string	Geçersiz transkripsiyon.
InvalidWebHookEventKind	string	Geçersiz web kancası olay türü.
MissingInputRecords	string	Eksik Giriş Kayıtları.
ModelCopyAuthorizationExpired	string	Süresi Dolan ModelCopyAuthorization.
ModelDeploymentNotCompleteState	string	Model dağıtımı tamamlanamadı durumu.
ModelDeprecated	string	Model kullanım dışı bırakıldı.
ModelExists	string	Model var.
ModelMismatch	string	Model uyuşmazlığı.
ModelNotDeployable	string	Model dağıtılamaz.
ModelVersionIncorrect	string	Model Sürümü Yanlış.
NoUtf8WithBom	string	Bom ile utf8 yok.
OnlyOneOfUrlsOrContainerOrDataset	string	Url'lerden, kapsayıcılardan veya veri kümelerinden yalnızca biri.
ProjectGenderMismatch	string	Proje cinsiyet uyuşmazlığı.
QuotaViolation	string	Kota ihlali.
SingleDefaultEndpoint	string	Tek varsayılan uç nokta.
SkuLimitsExist	string	Sku sınırları vardır.
SubscriptionNotFound	string	Abonelik bulunamadı.
UnexpectedError	string	Beklenmeyen hata.
UnsupportedClassBasedAdaptation	string	Desteklenmeyen sınıf tabanlı uyarlama.
UnsupportedDelta	string	Desteklenmeyen delta.
UnsupportedDynamicConfiguration	string	Desteklenmeyen dinamik yapılandırma.
UnsupportedFilter	string	Desteklenmeyen filtre.
UnsupportedLanguageCode	string	Desteklenmeyen dil kodu.
UnsupportedOrderBy	string	Desteklenmeyen sipariş ölçütü.
UnsupportedPagination	string	Desteklenmeyen sayfalandırma.
UnsupportedTimeRange	string	Desteklenmeyen zaman aralığı.

Endpoint

Uç Nokta

Name	Tür	Description
createdDateTime	string	Nesnenin oluşturulduğu zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-AA-GGThh:mm:ssZ", bkz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
customProperties	object	Bu varlığın özel özellikleri. İzin verilen anahtar uzunluğu üst sınırı 64 karakter, izin verilen değer uzunluğu üst sınırı 256 karakter ve izin verilen girdi sayısı 10'dur.
description	string	Nesnenin açıklaması.
displayName	string	Nesnenin görünen adı.
lastActionDateTime	string	Geçerli durumun girildiği zaman damgası. Zaman damgası ISO 8601 tarih ve saat biçimi olarak kodlanmıştır ("YYYY-AA-GGThh:mm:ssZ", bkz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations. ).
links	EndpointLinks	EndpointLinks
locale	string	Kapsanan verilerin yerel ayarı.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string	Bu varlığın konumu.
status	Status	Durum API'nin geçerli durumunu açıklama.
text	string	Bu uç nokta için dil modelini uyarlamak için kullanılan metin.

EndpointLinks

Name	Tür	Description
logs	string	Bu uç nokta için ses ve transkripsiyon günlükleri. Diğer ayrıntılar için bkz. "Endpoints_ListLogs" işlemi.
restConversation	string	60 saniyeye kadar olan istekler için REST uç noktası.
restDictation	string	Noktalama işaretlerinin diktesini destekleyen 60 saniyeye kadar istekler için REST uç noktası.
restInteractive	string	15 saniyeye kadar kısa istekler için REST uç noktası.
webSocketConversation	string	Birden çok nihai sonuç içeren uzun istekler için Konuşma SDK'sı uç noktası.
webSocketDictation	string	Noktalama işaretlerinin diktesini destekleyen, birden çok nihai sonucu olan uzun istekler için Konuşma SDK'sı uç noktası.
webSocketInteractive	string	Tek bir nihai sonuçla 15 saniyeye kadar kısa istekler için Konuşma SDK'sı uç noktası.

EndpointProperties

Name	Tür	Description
email	string	İşlemin tamamlanması durumunda e-posta bildirimlerinin gönderilmesi için e-posta adresi. Değer, e-posta başarıyla gönderildikten sonra kaldırılır.
error	EntityError	EntityError
loggingEnabled	boolean	Dağıtım için içerik günlüğünün (ses & transkripsiyonlar) kullanılıp kullanılmadığını gösteren değer.
timeToLive	string	Uç noktanın sistemde ne kadar süre tutulacağı. Bitiş noktası tamamlandıktan (başarılı veya başarısız) sonra yaşam süresine ulaştığında otomatik olarak silinir. Bu değerin veya ayarın 0 olarak ayarlanmaması otomatik silmeyi devre dışı bırakır. Desteklenen en uzun süre 31 gündür. Süre ISO 8601 süresi olarak kodlanmıştır ("PnYnMnDTnHnMnS", bkz https://en.wikipedia.org/wiki/ISO_8601#Durations. ).

EntityError

Name	Tür	Description
code	string	Bu hatanın kodu.
message	string	Bu hatanın iletisi.

EntityReference

Name	Tür	Description
self	string	Başvuruda bulunılan varlığın konumu.

Error

Hata

Name	Tür	Description
code	ErrorCode	ErrorCode Üst düzey hata kodları.
details	Error[]	Hata ve/veya beklenen ilkelerle ilgili ek destekleyici ayrıntılar.
innerError	InnerError	InnerError adresinde https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owbulunan Bilişsel Hizmetler API Yönergelerine uygun yeni İç Hata biçimi. Bu, ErrorCode, ileti ve isteğe bağlı özellik hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe olabilir) özelliklerini içerir.
message	string	Üst düzey hata iletisi.
target	string	Hatanın kaynağı. Örneğin, geçersiz belge olması durumunda "belgeler" veya "belge kimliği" olabilir.

ErrorCode

Name	Tür	Description
Conflict	string	Çakışma hata kodunu temsil ediyor.
Forbidden	string	Yasak hata kodunu temsil etme.
InternalCommunicationFailed	string	İç iletişim başarısız hata kodunu temsil ediyor.
InternalServerError	string	İç sunucu hata kodunu temsil ediyor.
InvalidArgument	string	Geçersiz bağımsız değişken hata kodunu temsil ediyor.
InvalidRequest	string	Geçersiz istek hata kodunu temsil ediyor.
NotAllowed	string	İzin verilmeyen hata kodunu temsil etme.
NotFound	string	Bulunamadı hata kodunu temsil ediyor.
PipelineError	string	İşlem hattı hata kodunu temsil eder.
ServiceUnavailable	string	Hizmet kullanılamıyor hata kodunu temsil etme.
TooManyRequests	string	Çok fazla istek hata kodunu temsil eder.
Unauthorized	string	Yetkisiz hata kodunu temsil etme.
UnprocessableEntity	string	İşlenemeyen varlık hata kodunu temsil eder.
UnsupportedMediaType	string	Desteklenmeyen medya türü hata kodunu temsil eder.

InnerError

Name	Tür	Description
code	DetailedErrorCode	DetailedErrorCode Ayrıntılı hata kodu sabit listesi.
details	object	Hata ve/veya beklenen ilkelerle ilgili ek destekleyici ayrıntılar.
innerError	InnerError	InnerError adresinde https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owbulunan Bilişsel Hizmetler API Yönergelerine uygun yeni İç Hata biçimi. Bu, ErrorCode, ileti ve isteğe bağlı özellik hedefi, ayrıntılar (anahtar değer çifti), iç hata (iç içe olabilir) özelliklerini içerir.
message	string	Üst düzey hata iletisi.
target	string	Hatanın kaynağı. Örneğin, geçersiz belge olması durumunda "belgeler" veya "belge kimliği" olabilir.

PaginatedEndpoints

Name	Tür	Description
@nextLink	string	Kullanılabilir daha fazla varlık varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi takdirde null.
values	Endpoint[]	Geçirilen 'skip' ve 'top' sorgu parametreleriyle veya varsayılan değerleriyle sınırlı varlıkların listesi. Sayfalandırma kullanarak bir listede yineleme yaparken ve varlıkları paralel olarak silerken, sonuçlarda bazı varlıklar atlanır. İstemcide bir liste oluşturmanız ve listenin tamamı getirildikten sonra silmeniz önerilir.

Name

Tür

Description

@nextLink

string

Kullanılabilir daha fazla varlık varsa sonraki sayfalandırılmış sonuç kümesinin bağlantısı; aksi takdirde null.

values

Endpoint[]

Geçirilen 'skip' ve 'top' sorgu parametreleriyle veya varsayılan değerleriyle sınırlı varlıkların listesi.

Sayfalandırma kullanarak bir listede yineleme yaparken ve varlıkları paralel olarak silerken, sonuçlarda bazı varlıklar atlanır. İstemcide bir liste oluşturmanız ve listenin tamamı getirildikten sonra silmeniz önerilir.

Status

Durum

Name	Tür	Description
Failed	string	Uzun süre çalışan işlem başarısız oldu.
NotStarted	string	Uzun süre çalışan işlem henüz başlatılmadı.
Running	string	Uzun süre çalışan işlem şu anda işleniyor.
Succeeded	string	Uzun süre çalışan işlem başarıyla tamamlandı.

Aracılığıyla paylaş

Endpoints - List

URI Parametreleri

Yanıtlar

Güvenlik

Ocp-Apim-Subscription-Key

Authorization

Örnekler

Get all endpoints

Örnek isteği

Örnek yanıt

Get all queued endpoints.

Örnek isteği

Örnek yanıt

Tanımlar

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status

Ek kaynaklar