Conversational Analysis Authoring - Create Project

Referência

Serviço:: Cognitive Services - Language

Versão da API:: 2022-05-01

Cria um projeto ou atualiza um existente.

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2022-05-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	Versão de API do cliente.

Cabeçalho da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de assinatura para um recurso de serviço de linguagem.

Corpo da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
language	True	string	A linguagem do projeto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
projectKind	True	ProjectKind	Representa o tipo de projeto.
projectName	True	string	O novo nome do projeto.
description		string	A descrição do projeto.
multilingual		boolean	Se o projeto seria usado para vários idiomas ou não.
settings		ConversationalAnalysisAuthoringProjectSettings	As configurações do projeto.

Respostas

Nome	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Os metadados do projeto atualizado, se ele já existir.
201 Created	ConversationalAnalysisAuthoringProjectMetadata	Os metadados do projeto criado.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

Exemplos

Successful Create Project

Solicitação de exemplo

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2022-05-01


{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

Resposta de exemplo

Código de status:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Código de status:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

Definições

Nome	Description
ConversationalAnalysisAuthoringCreateProjectOptions	Representa as opções usadas para criar ou atualizar um projeto.
ConversationalAnalysisAuthoringProjectMetadata	Representa os metadados de um projeto.
ConversationalAnalysisAuthoringProjectSettings	Representa as configurações usadas para definir o comportamento do projeto.
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	Representa o tipo de projeto.

ConversationalAnalysisAuthoringCreateProjectOptions

Representa as opções usadas para criar ou atualizar um projeto.

Nome	Tipo	Description
description	string	A descrição do projeto.
language	string	A linguagem do projeto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
multilingual	boolean	Se o projeto seria usado para vários idiomas ou não.
projectKind	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	As configurações do projeto.

ConversationalAnalysisAuthoringProjectMetadata

Representa os metadados de um projeto.

Nome	Tipo	Description
createdDateTime	string	Representa o datetime de criação do projeto.
description	string	A descrição do projeto.
language	string	A linguagem do projeto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol etc.
lastDeployedDateTime	string	Representa o último datetime implantado do projeto.
lastModifiedDateTime	string	Representa o datetime de criação do projeto.
lastTrainedDateTime	string	Representa o último datetime treinado do projeto.
multilingual	boolean	Se o projeto seria usado para vários idiomas ou não.
projectKind	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	As configurações do projeto.

ConversationalAnalysisAuthoringProjectSettings

Representa as configurações usadas para definir o comportamento do projeto.

Nome	Tipo	Description
confidenceThreshold	number	O limite da intenção com a maior confiança, na qual a previsão será automaticamente alterada para "Nenhum".

Error

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo homem do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode