Projects - Create

Referência

Serviço:: Azure AI Services

Versão da API:: v3.1

Cria um novo projeto.

POST {endpoint}/speechtotext/v3.1/projects

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).

Corpo do Pedido

Name	Necessário	Tipo	Description
displayName	True	string minLength: 1	O nome para exibição do objeto.
locale	True	string minLength: 1	A localidade dos dados contidos.
customProperties		object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description		string	A descrição do objeto.
links		ProjectLinks	Links do Projeto
properties		ProjectProperties	ProjectProperties

Respostas

Name	Tipo	Description
201 Created	Project	A resposta contém informações sobre a entidade como carga útil e sua localização como cabeçalho. Cabeçalhos Location: string
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

201 Created

Project

A resposta contém informações sobre a entidade como carga útil e sua localização como cabeçalho.

Cabeçalhos

Location: string

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da sua 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. Certifique-se de adicionar o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Create a project

Pedido de amostra

HTTP

POST {endpoint}/speechtotext/v3.1/projects

{
  "locale": "en-US",
  "displayName": "My speech project"
}

Resposta da amostra

Código de estado:: 201

{
  "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.1/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
    "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
    "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
    "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
    "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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"
}

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Erro
ErrorCode	Código de erro
InnerError	InnerError
Project	Projeto
ProjectLinks	Links do Projeto
ProjectProperties	ProjectProperties

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	Excluir não permitido.
DeployNotAllowed	Implantação não permitida.
DeployingFailedModel	Implantação de modelo com falha.
EmptyRequest	Pedido vazio.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable	Ponto final não atualizável.
EndpointWithoutLogging	Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
FailedDataset	Conjunto de dados com falha.
Forbidden	Proibido.
InUseViolation	Violação em uso.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidBaseModel	Modelo base inválido.
InvalidCallbackUri	Uri de retorno de chamada inválido.
InvalidCollection	Coleção inválida.
InvalidDataset	Conjunto de dados inválido.
InvalidDocument	Documento inválido.
InvalidDocumentBatch	Lote de documentos inválido.
InvalidLocale	Localidade inválida.
InvalidLogDate	Data de registo inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de log inválida.
InvalidModel	Modelo inválido.
InvalidModelUri	Uri de modelo inválido.
InvalidParameter	Parâmetro inválido.
InvalidParameterValue	Valor de parâmetro inválido.
InvalidPayload	Carga útil inválida.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
InvalidRequestBodyFormat	Formato de corpo de solicitação inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
InvalidSubscription	Subscrição inválida.
InvalidTest	Teste inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidTranscription	Transcrição inválida.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
MissingInputRecords	Registros de entrada ausentes.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelMismatch	Incompatibilidade de modelos.
ModelNotDeployable	Modelo não implantável.
ModelVersionIncorrect	Versão do modelo incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
QuotaViolation	Violação de quotas.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
SkuLimitsExist	Existem limites de Sku.
SubscriptionNotFound	Subscrição não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
UnsupportedDelta	Delta não suportado.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedFilter	Filtro não suportado.
UnsupportedLanguageCode	Código de idioma não suportado.
UnsupportedOrderBy	Ordem não suportada por.
UnsupportedPagination	Paginação não suportada.
UnsupportedTimeRange	Intervalo de tempo não suportado.

Error

Object

Erro

Name	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 políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

ErrorCode

Enumeração

Código de erro

Valor	Description
Conflict	Representando o código de erro de conflito.
Forbidden	Representando o código de erro proibido.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
InternalServerError	Representando o código de erro interno do servidor.
InvalidArgument	Representando o código de erro de argumento inválido.
InvalidRequest	Representando o código de erro de solicitação inválida.
NotAllowed	Representando o código de erro não permitido.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
TooManyRequests	Representando o código de erro de muitas solicitações.
Unauthorized	Representando o código de erro não autorizado.
UnprocessableEntity	Representando o código de erro de entidade não processável.
UnsupportedMediaType	Representando o código de erro de tipo de mídia não suportado.

InnerError

Object

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Código de erro detalhado enum.
details	object	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

Project

Object

Projeto

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string minLength: 1	O nome para exibição do objeto.
links	ProjectLinks	Links do Projeto
locale	string minLength: 1	A localidade dos dados contidos.
properties	ProjectProperties	ProjectProperties
self	string (uri)	A localização desta entidade.

ProjectLinks

Object

Links do Projeto

Name	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 finais 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

Object

ProjectProperties

Name	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.

Partilhar via

Projects - Create

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Create a project

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

Error

ErrorCode

InnerError

Project

ProjectLinks

ProjectProperties

Recursos adicionais