Conversational Analysis Authoring - Create Project
Cria um projeto ou atualiza um existente.
PATCH {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}?api-version=2023-04-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). |
project
|
path | True |
string |
O nome do projeto a ser usado. |
api-version
|
query | True |
string |
Versão de API do cliente. |
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 |
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 |
As configurações do projeto. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Os metadados do projeto atualizado, se ele já existir. |
|
201 Created |
Os metadados do projeto criado. |
|
Other Status Codes |
Resposta de erro. |
Segurança
AADToken
Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.
Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.
Observações
- Essa definição de segurança requer o uso do
x-ms-client-id
cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.
O Authorization URL
é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory.
* O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST.
* O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.
- Atualmente, o Azure Active Directory v1.0 ou v2.0 dá suporte a Trabalho, Escola e Convidados, mas não dá suporte a contas pessoais.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
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
PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-01
{
"projectName": "myproject",
"language": "en",
"projectKind": "Conversation",
"description": "This is a sample conversation project.",
"multilingual": false
}
Resposta de exemplo
{
"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"
}
{
"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 |
---|---|
Conversational |
Representa as opções usadas para criar ou atualizar um projeto. |
Conversational |
Representa os metadados de um projeto. |
Conversational |
Representa as configurações usadas para definir o comportamento do projeto. |
Error |
O objeto de erro. |
Error |
Código de erro legível por humanos. |
Error |
Resposta de erro. |
Inner |
Código de erro legível por humanos. |
Inner |
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. |
Project |
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 |
Representa o tipo de projeto. |
|
projectName |
string |
O novo nome do projeto. |
settings |
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 |
Representa o tipo de projeto. |
|
projectName |
string |
O novo nome do projeto. |
settings |
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". O valor do limite deve estar entre 0 e 1 inclusive. |
Error
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
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 |
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 |
O objeto de erro. |
InnerErrorCode
Código de erro legível por humanos.
Nome | Tipo | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
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.
Nome | Tipo | Description |
---|---|---|
code |
Um de um conjunto definido pelo servidor de códigos de erro. |
|
details |
object |
Detalhes do erro. |
innererror |
Um objeto que contém informações mais específicas do que o objeto atual sobre o erro. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |
ProjectKind
Representa o tipo de projeto.
Nome | Tipo | Description |
---|---|---|
Conversation |
string |
Um projeto para criar linguagem natural em aplicativos, bots e dispositivos IoT. |
Orchestration |
string |
Um projeto para conectar e orquestrar projetos de Conversa, Respostas às Perguntas personalizadas e LUIS em um único projeto. |