Projects - List

Serviço:
Azure AI Services
Versão da API:
v3.2-preview.2

Obtém a lista de projetos para a assinatura autenticada.

GET {endpoint}/speechtotext/v3.2-preview.2/projects
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip={skip}&top={top}&filter={filter}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
filter
 query

string

Uma expressão de filtragem para selecionar um subconjunto dos projetos disponíveis.

        - 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)

Número de conjuntos de dados que serão ignorados.
top
 query

integer (int32)

Número de conjuntos de dados que serão incluídos depois de ignorar.

Respostas

Nome Tipo Description
200 OK

PaginatedProjects

OKEY
Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta região. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all projects
Get all projects created in 2018 or 2019

Get all projects

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
}

Definições

Nome Description
DetailedErrorCode

DetailedErrorCode
Error

Erro
ErrorCode

Código de Erro
InnerError

InnerError
PaginatedProjects

PaginatedProjects
Project

Projeto
ProjectLinks

ProjectLinks
ProjectProperties

ProjectProperties

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor Description
InvalidParameterValue

Valor de parâmetro inválido.
InvalidRequestBodyFormat

Formato do corpo da solicitação inválido.
EmptyRequest

Solicitação vazia.
MissingInputRecords

Registros de entrada ausentes.
InvalidDocument

Documento inválido.
ModelVersionIncorrect

Versão do modelo incorreta.
InvalidDocumentBatch

Lote de Documentos Inválido.
UnsupportedLanguageCode

Código de idioma sem suporte.
DataImportFailed

Falha na importação de dados.
InUseViolation

Em violação de uso.
InvalidLocale

Localidade inválida.
InvalidBaseModel

Modelo base inválido.
InvalidAdaptationMapping

Mapeamento de adaptação inválido.
InvalidDataset

Conjunto de dados inválido.
InvalidTest

Teste inválido.
FailedDataset

Conjunto de dados com falha.
InvalidModel

Modelo inválido.
InvalidTranscription

Transcrição inválida.
InvalidPayload

Conteúdo inválido.
InvalidParameter

Parâmetro inválido.
EndpointWithoutLogging

Ponto de extremidade sem registro em log.
InvalidPermissions

Permissões inválidas.
InvalidPrerequisite

Pré-requisito inválido.
InvalidProductId

ID do produto inválido.
InvalidSubscription

Assinatura inválida.
InvalidProject

Projeto inválido.
InvalidProjectKind

Tipo de projeto inválido.
InvalidRecordingsUri

URI de gravações inválido.
OnlyOneOfUrlsOrContainerOrDataset

Apenas uma das URLs, contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris

Número excedido de uris de gravações.
ModelMismatch

Incompatibilidade de modelo.
ProjectGenderMismatch

Incompatibilidade de gênero do projeto.
ModelDeprecated

Modelo preterido.
ModelExists

O modelo existe.
ModelNotDeployable

Modelo não implantável.
EndpointNotUpdatable

Ponto de extremidade não atualizável.
SingleDefaultEndpoint

Ponto de extremidade padrão único.
EndpointCannotBeDefault

O ponto de extremidade não pode ser padrão.
InvalidModelUri

URI de modelo inválido.
SubscriptionNotFound

Assinatura não encontrada.
QuotaViolation

Violação de cota.
UnsupportedDelta

Delta sem suporte.
UnsupportedFilter

Filtro sem suporte.
UnsupportedPagination

Paginação sem suporte.
UnsupportedDynamicConfiguration

Configuração dinâmica sem suporte.
UnsupportedOrderBy

Ordem sem suporte por.
NoUtf8WithBom

Não utf8 com bom.
ModelDeploymentNotCompleteState

Implantação de modelo não completa o estado.
SkuLimitsExist

Existem limites de SKU.
DeployingFailedModel

Implantação de modelo com falha.
UnsupportedTimeRange

Intervalo de tempo sem suporte.
InvalidLogDate

Data de log inválida.
InvalidLogId

ID de log inválida.
InvalidLogStartTime

Hora de início do log inválida.
InvalidLogEndTime

Hora de término do log inválida.
InvalidTopForLogs

Parte superior inválida para logs.
InvalidSkipTokenForLogs

Token de ignorar inválido para logs.
DeleteNotAllowed

Exclusão não permitida.
Forbidden

Proibido.
DeployNotAllowed

Implantação não permitida.
UnexpectedError

Erro inesperado.
InvalidCollection

Coleção inválida.
InvalidCallbackUri

URI de retorno de chamada inválido.
InvalidSasValidityDuration

Duração de validade sas inválida.
InaccessibleCustomerStorage

Armazenamento de clientes inacessível.
UnsupportedClassBasedAdaptation

Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind

Tipo de evento de gancho da Web inválido.
InvalidTimeToLive

Tempo de vida inválido.
InvalidSourceAzureResourceId

ID de recurso do Azure de origem inválida.
ModelCopyOperationExists

A operação de cópia de modelo existe.

Error

Objeto

Erro

Nome Tipo Description
code

ErrorCode

Código de Erro
Códigos de erro de alto nível.
details

Error[]

Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Enumeração

Código de Erro

Valor Description
InvalidRequest

Representando o código de erro de solicitação inválido.
InvalidArgument

Representando o código de erro de argumento inválido.
InternalServerError

Representando o código de erro interno do servidor.
ServiceUnavailable

Representando o código de erro indisponível do serviço.
NotFound

Representando o código de erro não encontrado.
PipelineError

Representando o código de erro do pipeline.
Conflict

Representando o código de erro de conflito.
InternalCommunicationFailed

Representando o código de erro de falha de comunicação interna.
Forbidden

Representando o código de erro proibido.
NotAllowed

Representando o código de erro não permitido.
Unauthorized

Representando o código de erro não autorizado.
UnsupportedMediaType

Representando o código de erro de tipo de mídia sem suporte.
TooManyRequests

Representando o código de erro de muitas solicitações.
UnprocessableEntity

Representando o código de erro de entidade não processável.

InnerError

Objeto

InnerError

Nome Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração detalhada do código de erro.
details

object

Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

PaginatedProjects

Objeto

PaginatedProjects

Nome Tipo Description
@nextLink

string (uri)

Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo.
values

Project[]

Uma lista de entidades limitada pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão.

Ao iterar por meio de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.

Project

Objeto

Projeto

Nome Tipo Description
createdDateTime

string (date-time)

O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
description

string

A descrição do objeto.
displayName

string

minLength: 1

O nome de exibição do objeto.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

A localidade dos dados contidos.
properties

ProjectProperties

ProjectProperties
self

string (uri)

O local dessa entidade.
Objeto

ProjectLinks

Nome Tipo Description
datasets

string (uri)

O local para obter uma lista de todos os conjuntos de dados deste projeto. Consulte a operação "Projects_ListDatasets" para obter mais detalhes.
endpoints

string (uri)

O local para obter uma lista de todos os pontos de extremidade deste projeto. Consulte a operação "Projects_ListEndpoints" para obter mais detalhes.
evaluations

string (uri)

O local para obter uma lista de todas as avaliações deste projeto. Consulte a operação "Projects_ListEvaluations" para obter mais detalhes.
models

string (uri)

O local para obter uma lista de todos os modelos deste projeto. Consulte a operação "Projects_ListModels" para obter mais detalhes.
transcriptions

string (uri)

O local para obter uma lista de todas as transcrições deste projeto. Consulte a operação "Projects_ListTranscriptions" para obter mais detalhes.

ProjectProperties

Objeto

ProjectProperties

Nome Tipo Description
datasetCount

integer (int32)

O número de conjuntos de dados associados a este projeto.
endpointCount

integer (int32)

O número de pontos de extremidade associados a este projeto.
evaluationCount

integer (int32)

O número de avaliações associadas a este projeto.
modelCount

integer (int32)

O número de modelos associados a este projeto.
transcriptionCount

integer (int32)

O número de transcrições associadas a este projeto.