Projects - List

Referensi

Service:: Azure AI Services

API Version:: v3.2-preview.2

Mendapatkan daftar proyek untuk langganan yang diautentikasi.

GET {endpoint}/speechtotext/v3.2-preview.2/projects

With optional parameters:

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip={skip}&top={top}&filter={filter}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus.api.cognitive.microsoft.com).
filter	query		string	Ekspresi pemfilteran untuk memilih subset proyek yang tersedia. `- Supported properties: displayName, description, createdDateTime, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My test'`
skip	query		integer int32	Jumlah himpunan data yang akan dilewati.
top	query		integer int32	Jumlah himpunan data yang akan disertakan setelah dilewati.

Respons

Nama	Jenis	Deskripsi
200 OK	PaginatedProjects	OK
Other Status Codes	Error	Terjadi kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci akun layanan kognitif Anda di sini.

Type: apiKey
In: header

Authorization

Berikan token akses dari JWT yang dikembalikan oleh STS wilayah ini. Pastikan untuk menambahkan cakupan manajemen ke token dengan menambahkan string kueri berikut ke URL STS: ?scope=speechservicesmanagement

Type: apiKey
In: header

Contoh

Get all projects

Get all projects created in 2018 or 2019

Get all projects

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

Sample Response

Status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}

Get all projects created in 2018 or 2019

Sample Request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z

Sample Response

Status code:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-03-03T12:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-12-19T17:54:57Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-02-01T00:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}

Definisi

Nama	Deskripsi
DetailedErrorCode	DetailErrorCode
Error	Kesalahan
ErrorCode	ErrorCode
InnerError	InnerError
PaginatedProjects	PaginatedProjects
Project	Project
ProjectLinks	ProjectLinks
ProjectProperties	ProjectProperties

DetailedErrorCode

DetailErrorCode

Nama	Jenis	Deskripsi
DataImportFailed	string	Impor data gagal.
DeleteNotAllowed	string	Hapus tidak diperbolehkan.
DeployNotAllowed	string	Penyebaran tidak diperbolehkan.
DeployingFailedModel	string	Menyebarkan model yang gagal.
EmptyRequest	string	Permintaan Kosong.
EndpointCannotBeDefault	string	Titik akhir tidak boleh default.
EndpointNotUpdatable	string	Titik akhir tidak dapat diperbarui.
EndpointWithoutLogging	string	Titik akhir tanpa pengelogan.
ExceededNumberOfRecordingsUris	string	Melebihi jumlah uri rekaman.
FailedDataset	string	Himpunan data yang gagal.
Forbidden	string	Terlarang.
InUseViolation	string	Dalam pelanggaran penggunaan.
InaccessibleCustomerStorage	string	Penyimpanan pelanggan yang tidak dapat diakses.
InvalidAdaptationMapping	string	Pemetaan adaptasi tidak valid.
InvalidBaseModel	string	Model dasar tidak valid.
InvalidCallbackUri	string	Uri panggilan balik tidak valid.
InvalidCollection	string	Koleksi tidak valid.
InvalidDataset	string	Himpunan data tidak valid.
InvalidDocument	string	Dokumen Tidak Valid.
InvalidDocumentBatch	string	Batch Dokumen Tidak Valid.
InvalidLocale	string	Lokal tidak valid.
InvalidLogDate	string	Tanggal log tidak valid.
InvalidLogEndTime	string	Waktu akhir log tidak valid.
InvalidLogId	string	Id log tidak valid.
InvalidLogStartTime	string	Waktu mulai log tidak valid.
InvalidModel	string	Model tidak valid.
InvalidModelUri	string	Uri model tidak valid.
InvalidParameter	string	Parameter tidak valid.
InvalidParameterValue	string	Nilai parameter tidak valid.
InvalidPayload	string	Payload tidak valid.
InvalidPermissions	string	Izin tidak valid.
InvalidPrerequisite	string	Prasyarat tidak valid.
InvalidProductId	string	Id produk tidak valid.
InvalidProject	string	Proyek tidak valid.
InvalidProjectKind	string	Jenis proyek tidak valid.
InvalidRecordingsUri	string	uri rekaman tidak valid.
InvalidRequestBodyFormat	string	Format isi permintaan tidak valid.
InvalidSasValidityDuration	string	Durasi validitas sas tidak valid.
InvalidSkipTokenForLogs	string	Tidak valid melewati token untuk log.
InvalidSourceAzureResourceId	string	ID sumber daya Azure sumber tidak valid.
InvalidSubscription	string	Langganan tidak valid.
InvalidTest	string	Tes tidak valid.
InvalidTimeToLive	string	Waktu hidup tidak valid.
InvalidTopForLogs	string	Bagian atas untuk log tidak valid.
InvalidTranscription	string	Transkripsi tidak valid.
InvalidWebHookEventKind	string	Jenis peristiwa webhook tidak valid.
MissingInputRecords	string	Rekaman Input Hilang.
ModelCopyOperationExists	string	Operasi penyalinan model ada.
ModelDeploymentNotCompleteState	string	Penyebaran model tidak selesai.
ModelDeprecated	string	Model tidak digunakan lagi.
ModelExists	string	Model ada.
ModelMismatch	string	Model tidak cocok.
ModelNotDeployable	string	Model tidak dapat disebarkan.
ModelVersionIncorrect	string	Versi Model Salah.
NoUtf8WithBom	string	Tidak ada utf8 dengan bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Hanya salah satu url atau kontainer atau himpunan data.
ProjectGenderMismatch	string	Ketidakcocokan jenis kelamin proyek.
QuotaViolation	string	Pelanggaran kuota.
SingleDefaultEndpoint	string	Titik akhir default tunggal.
SkuLimitsExist	string	Batas Sku ada.
SubscriptionNotFound	string	Langganan tidak ditemukan.
UnexpectedError	string	Kesalahan tak terduga.
UnsupportedClassBasedAdaptation	string	Adaptasi berbasis kelas yang tidak didukung.
UnsupportedDelta	string	Delta yang tidak didukung.
UnsupportedDynamicConfiguration	string	Konfigurasi dinamis yang tidak didukung.
UnsupportedFilter	string	Filter yang tidak didukung.
UnsupportedLanguageCode	string	Kode bahasa yang tidak didukung.
UnsupportedOrderBy	string	Urutan yang tidak didukung oleh.
UnsupportedPagination	string	Penomoran halaman yang tidak didukung.
UnsupportedTimeRange	string	Rentang waktu yang tidak didukung.

Error

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	ErrorCode Kode kesalahan tingkat tinggi.
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid.

ErrorCode

Nama	Jenis	Deskripsi
Conflict	string	Mewakili kode kesalahan konflik.
Forbidden	string	Mewakili kode kesalahan terlarang.
InternalCommunicationFailed	string	Mewakili kode kesalahan komunikasi internal yang gagal.
InternalServerError	string	Mewakili kode kesalahan server internal.
InvalidArgument	string	Mewakili kode kesalahan argumen yang tidak valid.
InvalidRequest	string	Mewakili kode kesalahan permintaan yang tidak valid.
NotAllowed	string	Mewakili kode kesalahan yang tidak diizinkan.
NotFound	string	Mewakili kode kesalahan yang tidak ditemukan.
PipelineError	string	Mewakili kode kesalahan kesalahan alur.
ServiceUnavailable	string	Mewakili kode kesalahan layanan yang tidak tersedia.
TooManyRequests	string	Mewakili terlalu banyak kode kesalahan permintaan.
Unauthorized	string	Mewakili kode kesalahan yang tidak sah.
UnprocessableEntity	string	Mewakili kode kesalahan entitas yang tidak dapat diolah.
UnsupportedMediaType	string	Mewakili kode kesalahan jenis media yang tidak didukung.

InnerError

Nama	Jenis	Deskripsi
code	DetailedErrorCode	DetailErrorCode Enum kode kesalahan terperinci.
details	object	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innerError	InnerError	InnerError Format Kesalahan Dalam Baru yang sesuai dengan Pedoman API Cognitive Services yang tersedia di https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Hal ini berisi properti yang diperlukan ErrorCode, pesan dan target properti opsional, detail (pasangan nilai kunci), inner error (ini dapat berlapis).
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan. Misalnya "dokumen" atau "id dokumen" jika dokumen tidak valid.

PaginatedProjects

Nama	Jenis	Deskripsi
@nextLink	string	Tautan ke kumpulan hasil paginasi berikutnya jika ada lebih banyak entitas yang tersedia; jika tidak null.
values	Project[]	Daftar entitas yang dibatasi oleh parameter kueri yang diteruskan 'lewati' dan 'atas' atau nilai defaultnya. Saat melakukan iterasi melalui daftar menggunakan pagination dan menghapus entitas secara paralel, beberapa entitas akan dilewati dalam hasil. Disarankan untuk membuat daftar pada klien dan menghapus setelah pengambilan daftar lengkap.

Nama

Jenis

Deskripsi

@nextLink

string

Tautan ke kumpulan hasil paginasi berikutnya jika ada lebih banyak entitas yang tersedia; jika tidak null.

values

Project[]

Daftar entitas yang dibatasi oleh parameter kueri yang diteruskan 'lewati' dan 'atas' atau nilai defaultnya.

Saat melakukan iterasi melalui daftar menggunakan pagination dan menghapus entitas secara paralel, beberapa entitas akan dilewati dalam hasil. Disarankan untuk membuat daftar pada klien dan menghapus setelah pengambilan daftar lengkap.

Project

Nama	Jenis	Deskripsi
createdDateTime	string	Stempel waktu saat objek dibuat. Stempel waktu dikodekan sebagai format tanggal dan waktu ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", lihat https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Properti kustom entitas ini. Panjang kunci maksimum yang diizinkan adalah 64 karakter, panjang nilai maksimum yang diizinkan adalah 256 karakter dan jumlah entri yang diizinkan adalah 10.
description	string	Deskripsi objek .
displayName	string	Nama tampilan objek.
links	ProjectLinks	ProjectLinks
locale	string	Lokal data yang terkandung.
properties	ProjectProperties	ProjectProperties
self	string	Lokasi entitas ini.

ProjectLinks

Nama	Jenis	Deskripsi
datasets	string	Lokasi untuk mendapatkan daftar semua himpunan data proyek ini. Lihat operasi "Projects_ListDatasets" untuk detail selengkapnya.
endpoints	string	Lokasi untuk mendapatkan daftar semua titik akhir proyek ini. Lihat operasi "Projects_ListEndpoints" untuk detail selengkapnya.
evaluations	string	Lokasi untuk mendapatkan daftar semua evaluasi proyek ini. Lihat operasi "Projects_ListEvaluations" untuk detail selengkapnya.
models	string	Lokasi untuk mendapatkan daftar semua model proyek ini. Lihat operasi "Projects_ListModels" untuk detail selengkapnya.
transcriptions	string	Lokasi untuk mendapatkan daftar semua transkripsi proyek ini. Lihat operasi "Projects_ListTranscriptions" untuk detail selengkapnya.

ProjectProperties

Nama	Jenis	Deskripsi
datasetCount	integer	Jumlah himpunan data yang terkait dengan proyek ini.
endpointCount	integer	Jumlah titik akhir yang terkait dengan proyek ini.
evaluationCount	integer	Jumlah evaluasi yang terkait dengan proyek ini.
modelCount	integer	Jumlah model yang terkait dengan proyek ini.
transcriptionCount	integer	Jumlah transkripsi yang terkait dengan proyek ini.

Projects - List

Parameter URI

Respons

Keamanan

Ocp-Apim-Subscription-Key

Authorization

Contoh

Get all projects

Sample Request

Sample Response

Get all projects created in 2018 or 2019

Sample Request

Sample Response

Definisi

DetailedErrorCode

Error

ErrorCode

InnerError

PaginatedProjects

Project

ProjectLinks

ProjectProperties

Sumber Daya Tambahan: