Conversation Authoring Project - Create Project

Serviço:

Azure AI Services

Versão da API:

2025-11-01

Cria um novo projeto ou atualiza um existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade dos Serviços Cognitivos suportados, por exemplo, https://< resource-name.api.cognitiveservices.azure.com>.
projectName	path	True	string maxLength: 100	O novo nome do projeto.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
language	True	string	A linguagem do projeto. Esta é a representação BCP-47 de uma língua. 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		AnalyzeConversationAuthoringProjectSettings	As configurações do projeto.

Respostas

Name	Tipo	Description
200 OK	AnalyzeConversationAuthoringProjectMetadata	O pedido foi bem-sucedido.
201 Created	AnalyzeConversationAuthoringProjectMetadata	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name	Description
https://cognitiveservices.azure.com/.default

Exemplos

Successful Create Project

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:

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 estado:

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

Name	Description
AnalyzeConversationAuthoringCreateProjectOptions	Representa as opções usadas para criar ou atualizar um projeto.
AnalyzeConversationAuthoringProjectMetadata	Representa os metadados de um projeto.
AnalyzeConversationAuthoringProjectSettings	Representa as configurações usadas para definir o comportamento do projeto.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ProjectKind

AnalyzeConversationAuthoringCreateProjectOptions

Object

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

Name	Tipo	Description
description	string	A descrição do projeto.
language	string	A linguagem do projeto. Esta é a representação BCP-47 de uma língua. 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	AnalyzeConversationAuthoringProjectSettings	As configurações do projeto.

AnalyzeConversationAuthoringProjectMetadata

Object

Representa os metadados de um projeto.

Name	Tipo	Description
createdDateTime	string (date-time)	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 uma língua. Por exemplo, use "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
lastDeployedDateTime	string (date-time)	Representa o último projeto implantado datetime.
lastModifiedDateTime	string (date-time)	Representa o datetime de criação do projeto.
lastTrainedDateTime	string (date-time)	Representa a última data/hora treinada 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 maxLength: 100	O novo nome do projeto.
settings	AnalyzeConversationAuthoringProjectSettings	As configurações do projeto.

AnalyzeConversationAuthoringProjectSettings

Object

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

Name	Tipo	Description
confidenceThreshold	number (float)	O limiar da intenção com a maior confiança, no qual a previsão será automaticamente alterada para "Nenhuma". O valor do limiar deve estar compreendido entre 0 e 1, inclusive.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

ProjectKind

Enumeração

Valor	Description
Conversation	Um projeto para criar linguagem natural em aplicativos, bots e dispositivos IoT.
Orchestration	Um projeto para conectar e orquestrar conversação, resposta a perguntas personalizadas e projetos LUIS juntos em um único projeto.