Conversational Analysis Authoring - Create Project

Referência

Serviço:: Cognitive Services - Language

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

Cria um novo projeto ou atualiza um existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	O nome do projeto a utilizar.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

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

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Uma chave de subscrição para um recurso do Serviço de idiomas.

Corpo do Pedido

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

Name	Necessário	Tipo	Description
language	True	string	O idioma do projeto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "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 ou não utilizado para vários idiomas.
settings		ConversationalAnalysisAuthoringProjectSettings	As definições do projeto.

Respostas

Name	Tipo	Description
200 OK	ConversationalAnalysisAuthoringProjectMetadata	Os metadados do projeto atualizado, se 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 subscrição para um recurso do Serviço de idiomas.

Tipo: apiKey
Em: header

Exemplos

Successful Create Project

Pedido de amostra

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 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
ConversationalAnalysisAuthoringCreateProjectOptions	Representa as opções utilizadas para criar ou atualizar um projeto.
ConversationalAnalysisAuthoringProjectMetadata	Representa os metadados de um projeto.
ConversationalAnalysisAuthoringProjectSettings	Representa as definições utilizadas 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 Microsoft One API – 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 utilizadas para criar ou atualizar um projeto.

Name	Tipo	Description
description	string	A descrição do projeto.
language	string	O idioma do projeto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
multilingual	boolean	Se o projeto seria ou não utilizado para vários idiomas.
projectKind	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	As definições do projeto.

ConversationalAnalysisAuthoringProjectMetadata

Representa os metadados de um projeto.

Name	Tipo	Description
createdDateTime	string	Representa o datetime de criação do projeto.
description	string	A descrição do projeto.
language	string	O idioma do projeto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês, "en-gb" para inglês (Reino Unido), "es" para espanhol, etc.
lastDeployedDateTime	string	Representa o datatime da última implementação do projeto.
lastModifiedDateTime	string	Representa o datetime de criação do projeto.
lastTrainedDateTime	string	Representa o último datetime preparado do projeto.
multilingual	boolean	Se o projeto seria ou não utilizado para vários idiomas.
projectKind	ProjectKind	Representa o tipo de projeto.
projectName	string	O novo nome do projeto.
settings	ConversationalAnalysisAuthoringProjectSettings	As definições do projeto.

ConversationalAnalysisAuthoringProjectSettings

Representa as definições utilizadas para definir o comportamento do projeto.

Name	Tipo	Description
confidenceThreshold	number	O limiar da intenção com maior confiança, no qual a predição será automaticamente alterada para "Nenhum".

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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 por humanos do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

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

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode