Question Answering Projects - Create Project

Referência

Serviço:: Azure AI Services

Versão da API:: 2023-04-15-preview

Crie ou atualize um projeto.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?api-version=2023-04-15-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
projectName	path	True	string	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
language	True	string	Língua dos registos de texto. Esta é a representação BCP-47 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.
description		string	Descrição do projeto.
multilingualResource		boolean	Defina como true para permitir a criação de bases de conhecimento em idiomas diferentes para o mesmo recurso.
settings		ProjectSettings	Configurações configuráveis do Projeto.

Respostas

Name	Tipo	Description
200 OK	ProjectMetadata	Os metadados do projeto atualizado, se já existir.
201 Created	ProjectMetadata	Os metadados do projeto criado, se ele não existir.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Estes são os Fluxos de do Azure Ative Directory OAuth2. Quando emparelhado com controle de de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST do Azure Maps. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais contas de recursos ou subrecursos do Azure Maps. 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 APIs REST do Azure Maps.

Para implementar cenários, recomendamos a visualização conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos(s) por meio de objetos capazes de controle de acesso em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do cabeçalho x-ms-client-id para indicar a qual recurso do Azure Maps o aplicativo está solicitando acesso. Isso pode ser adquirido na API de gerenciamento do Maps.

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 Ative Directory. * O controle de acesso baseado em função do Azure é configurado a partir do plano de gerenciamento do Azure por meio do portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web do Azure Maps permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

Atualmente, o Azure Ative Directory v1.0 ou v2.0 oferece suporte a Trabalho, Escola e Convidados, mas não oferece suporte a contas Pessoais.

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

Âmbitos

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

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1?api-version=2023-04-15-preview

{
  "description": "proj1 is a test project.",
  "language": "en",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "multilingualResource": true
}

Resposta da amostra

Código de estado:: 200

{
  "projectName": "proj1",
  "description": "proj1 is a test project.",
  "language": "en",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "multilingualResource": true,
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z"
}

Código de estado:: 201

{
  "projectName": "proj1",
  "description": "proj1 is a test project.",
  "language": "en",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "multilingualResource": true,
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z"
}

Definições

Name	Description
CreateProjectOptions	Parâmetros necessários para criar o 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.
ProjectMetadata	Representa o projeto.
ProjectSettings	Configurações configuráveis do Projeto.

CreateProjectOptions

Parâmetros necessários para criar o projeto.

Name	Tipo	Description
description	string	Descrição do projeto.
language	string	Língua dos registos de texto. Esta é a representação BCP-47 de uma língua. Por exemplo, use "en" para inglês; "es" para espanhol, etc. Se não estiver definido, use "en" para inglês como padrão.
multilingualResource	boolean	Defina como true para permitir a criação de bases de conhecimento em idiomas diferentes para o mesmo recurso.
settings	ProjectSettings	Configurações configuráveis do Projeto.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo 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