Projects - List

Reference

Service:: Azure AI Services

API Version:: v3.2-preview.2

Získá seznam projektů pro ověřené předplatné.

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}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus.api.cognitive.microsoft.com).
filter	query		string	Filtrovací výraz pro výběr podmnožině dostupných projektů. `- 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	Počet datových sad, které budou vynechány
top	query		integer int32	Počet datových sad, které budou zahrnuty po přeskočení

Odpovědi

Name	Typ	Description
200 OK	PaginatedProjects	OK
Other Status Codes	Error	Došlo k chybě.

Zabezpečení

Ocp-Apim-Subscription-Key

Sem zadejte klíč účtu služeb Cognitive Services.

Type: apiKey
In: header

Authorization

Zadejte přístupový token z JWT vrácený službou STS této oblasti. Nezapomeňte do tokenu přidat obor správy přidáním následujícího řetězce dotazu na adresu URL služby STS: ?scope=speechservicesmanagement.

Type: apiKey
In: header

Příklady

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

Definice

Name	Description
DetailedErrorCode	Podrobný kód chyby
Error	Chyba
ErrorCode	ErrorCode
InnerError	Vnitřní chyba
PaginatedProjects	PaginatedProjects
Project	Project
ProjectLinks	Odkazy na projekt
ProjectProperties	ProjectVlastnosti

DetailedErrorCode

Podrobný kód chyby

Name	Typ	Description
DataImportFailed	string	Import dat se nezdařil.
DeleteNotAllowed	string	Odstranění není povoleno.
DeployNotAllowed	string	Nasazení není povoleno.
DeployingFailedModel	string	Nasazení modelu, který selhal
EmptyRequest	string	Prázdný požadavek.
EndpointCannotBeDefault	string	Koncový bod nemůže být výchozí.
EndpointNotUpdatable	string	Koncový bod není aktualizovatelný.
EndpointWithoutLogging	string	Koncový bod bez protokolování.
ExceededNumberOfRecordingsUris	string	Překročili jsme počet nahrávek uris.
FailedDataset	string	Datová sada se nezdařila.
Forbidden	string	Zakázáno.
InUseViolation	string	Porušením používání.
InaccessibleCustomerStorage	string	Nepřístupné úložiště zákazníka
InvalidAdaptationMapping	string	Neplatné mapování adaptace
InvalidBaseModel	string	Neplatný základní model.
InvalidCallbackUri	string	Neplatný identifikátor URI zpětného volání
InvalidCollection	string	Neplatná kolekce.
InvalidDataset	string	Neplatná datová sada
InvalidDocument	string	Neplatný dokument.
InvalidDocumentBatch	string	Neplatná dávka dokumentu.
InvalidLocale	string	Neplatné národní prostředí.
InvalidLogDate	string	Neplatné datum protokolu.
InvalidLogEndTime	string	Neplatný čas ukončení protokolu.
InvalidLogId	string	Neplatné ID protokolu
InvalidLogStartTime	string	Neplatný čas spuštění protokolu.
InvalidModel	string	Neplatný model.
InvalidModelUri	string	Neplatný identifikátor URI modelu
InvalidParameter	string	Neplatný parametr.
InvalidParameterValue	string	Neplatná hodnota parametru
InvalidPayload	string	Neplatná datová část.
InvalidPermissions	string	Neplatná oprávnění.
InvalidPrerequisite	string	Neplatný předpoklad.
InvalidProductId	string	Neplatné ID produktu.
InvalidProject	string	Neplatný projekt.
InvalidProjectKind	string	Neplatný druh projektu.
InvalidRecordingsUri	string	Neplatný identifikátor URI nahrávek
InvalidRequestBodyFormat	string	Neplatný formát textu požadavku.
InvalidSasValidityDuration	string	Neplatná doba platnosti SAS.
InvalidSkipTokenForLogs	string	Neplatný token skip pro protokoly.
InvalidSourceAzureResourceId	string	Neplatné ID zdrojového prostředku Azure
InvalidSubscription	string	Neplatné předplatné.
InvalidTest	string	Neplatný test.
InvalidTimeToLive	string	Hodnota TTL (Time to Live) je neplatná.
InvalidTopForLogs	string	Neplatné top pro protokoly.
InvalidTranscription	string	Neplatný přepis.
InvalidWebHookEventKind	string	Neplatný druh události webhooku
MissingInputRecords	string	Chybí vstupní záznamy.
ModelCopyOperationExists	string	Existuje operace kopírování modelu.
ModelDeploymentNotCompleteState	string	Nasazení modelu není dokončeno.
ModelDeprecated	string	Model je zastaralý.
ModelExists	string	Model existuje.
ModelMismatch	string	Neshoda modelů.
ModelNotDeployable	string	Model nejde nasadit.
ModelVersionIncorrect	string	Nesprávná verze modelu.
NoUtf8WithBom	string	No utf8 s bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Pouze jednu z adres URL nebo kontejneru nebo datové sady.
ProjectGenderMismatch	string	Neshoda pohlaví v projektu.
QuotaViolation	string	Porušení kvóty.
SingleDefaultEndpoint	string	Jeden výchozí koncový bod.
SkuLimitsExist	string	Existují omezení skladových položek.
SubscriptionNotFound	string	Předplatné se nenašlo.
UnexpectedError	string	Neočekávaná chyba.
UnsupportedClassBasedAdaptation	string	Nepodporovaná adaptace na základě třídy
UnsupportedDelta	string	Nepodporovaná rozdílová.
UnsupportedDynamicConfiguration	string	Nepodporovaná dynamická konfigurace
UnsupportedFilter	string	Nepodporovaný filtr
UnsupportedLanguageCode	string	Nepodporovaný kód jazyka.
UnsupportedOrderBy	string	Nepodporované řazení podle.
UnsupportedPagination	string	Nepodporovaná stránkování.
UnsupportedTimeRange	string	Nepodporovaný časový rozsah.

Error

Chyba

Name	Typ	Description
code	ErrorCode	ErrorCode Kódy chyb vysoké úrovně.
details	Error[]	Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message	string	Chybová zpráva vysoké úrovně.
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

ErrorCode

Name	Typ	Description
Conflict	string	Představuje kód chyby konfliktu.
Forbidden	string	Představuje zakázaný kód chyby.
InternalCommunicationFailed	string	Představuje kód chyby selhání interní komunikace.
InternalServerError	string	Představuje kód vnitřní chyby serveru.
InvalidArgument	string	Představuje neplatný kód chyby argumentu.
InvalidRequest	string	Představuje neplatný kód chyby požadavku.
NotAllowed	string	Představuje nepovolený kód chyby.
NotFound	string	Představuje kód chyby nenalezena.
PipelineError	string	Představuje kód chyby kanálu.
ServiceUnavailable	string	Představuje kód chyby nedostupné služby.
TooManyRequests	string	Představuje kód chyby příliš mnoho požadavků.
Unauthorized	string	Představuje neoprávněný kód chyby.
UnprocessableEntity	string	Představuje nezpracovaný kód chyby entity.
UnsupportedMediaType	string	Představuje kód chyby nepodporovaného typu média.

InnerError

Vnitřní chyba

Name	Typ	Description
code	DetailedErrorCode	Podrobný kód chyby Podrobný výčet kódu chyby
details	object	Další podrobnosti podpory týkající se chyby nebo očekávaných zásad
innerError	InnerError	Vnitřní chyba Nový formát vnitřní chyby, který odpovídá pokynům k rozhraní API služeb Cognitive Services, které jsou k dispozici na adrese https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error (to může být vnořené).
message	string	Chybová zpráva vysoké úrovně.
target	string	Zdroj chyby. Například v případě neplatného dokumentu by to byly "dokumenty" nebo "ID dokumentu".

PaginatedProjects

Name	Typ	Description
@nextLink	string	Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.
values	Project[]	Seznam entit omezených parametry předaného dotazu "skip" a "top" nebo jejich výchozími hodnotami. Při iteraci seznamem pomocí stránkování a paralelním odstraňování entit se některé entity ve výsledcích přeskočí. Doporučujeme vytvořit seznam na klientovi a po načtení úplného seznamu ho odstranit.

Name

Typ

Description

@nextLink

string

Odkaz na další sadu stránkovaných výsledků, pokud je k dispozici více entit; jinak null.

values

Project[]

Seznam entit omezených parametry předaného dotazu "skip" a "top" nebo jejich výchozími hodnotami.

Při iteraci seznamem pomocí stránkování a paralelním odstraňování entit se některé entity ve výsledcích přeskočí. Doporučujeme vytvořit seznam na klientovi a po načtení úplného seznamu ho odstranit.

Project

Name	Typ	Description
createdDateTime	string	Časové razítko, kdy byl objekt vytvořen. Časové razítko je kódováno jako formát data a času ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", viz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Vlastní vlastnosti této entity. Maximální povolená délka klíče je 64 znaků, maximální délka povolené hodnoty je 256 znaků a počet povolených položek je 10.
description	string	Popis objektu.
displayName	string	Zobrazovaný název objektu.
links	ProjectLinks	Odkazy na projekt
locale	string	Národní prostředí obsažených dat.
properties	ProjectProperties	ProjectVlastnosti
self	string	Umístění této entity.

ProjectLinks

Odkazy na projekt

Name	Typ	Description
datasets	string	Umístění pro získání seznamu všech datových sad tohoto projektu Další podrobnosti najdete v operaci "Projects_ListDatasets".
endpoints	string	Umístění pro získání seznamu všech koncových bodů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListEndpoints".
evaluations	string	Umístění pro získání seznamu všech hodnocení tohoto projektu. Další podrobnosti najdete v operaci "Projects_ListEvaluations".
models	string	Umístění pro získání seznamu všech modelů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListModels".
transcriptions	string	Umístění pro získání seznamu všech přepisů tohoto projektu Další podrobnosti najdete v operaci "Projects_ListTranscriptions".

ProjectProperties

ProjectVlastnosti

Name	Typ	Description
datasetCount	integer	Počet datových sad přidružených k tomuto projektu.
endpointCount	integer	Počet koncových bodů přidružených k tomuto projektu.
evaluationCount	integer	Počet hodnocení přidružených k tomuto projektu.
modelCount	integer	Počet modelů přidružených k tomuto projektu.
transcriptionCount	integer	Počet přepisů přidružených k tomuto projektu

Projects - List

Parametry identifikátoru URI

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Authorization

Příklady

Get all projects

Sample Request

Sample Response

Get all projects created in 2018 or 2019

Sample Request

Sample Response

Definice

DetailedErrorCode

Error

ErrorCode

InnerError

PaginatedProjects

Project

ProjectLinks

ProjectProperties

Další materiály