Question Answering Projects - Create Project

Serviço:

Azure AI Services

Versão da API:

2023-04-01

Cria ou atualiza um projeto.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nome do projeto.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
description	string	Descrição do projeto.
language	string	Idioma dos registros de texto. Esta é a representação BCP-47 de um idioma. 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	Recurso habilitado para vários idiomas em projetos ou não.
settings	ProjectSettings	Configurações configuráveis do Projeto.

Respostas

Nome	Tipo	Description
200 OK	QuestionAnsweringProjectMetadata	A solicitação foi bem-sucedida.
201 Created	QuestionAnsweringProjectMetadata	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

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

Exemplos

Successful query

Solicitação de exemplo

HTTP

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

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

Resposta de exemplo

Código de status:

200

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

Código de status:

201

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

Definições

Nome	Description
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.
ProjectSettings	Configurações configuráveis do Projeto.
QuestionAnsweringProjectMetadata	Representa o projeto.
QuestionAnsweringProjectMetadataCreateOrUpdate	Representa o projeto.

Error

Objeto

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 ser humano do erro.
target	string	O destino do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválido
InvalidArgument	Erro de argumento inválido
Unauthorized	Erro de acesso não autorizado
Forbidden	Erro de acesso proibido
NotFound	Erro não encontrado
ProjectNotFound	Erro não encontrado no projeto
OperationNotFound	Erro de operação não encontrada
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Erro não encontrado no índice do Azure Cognitive Search
TooManyRequests	Erro de muitas solicitações
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Erro atingido no limite de índice do Azure Cognitive Search
InternalServerError	Erro interno do servidor
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
QuotaExceeded	Erro de cota excedido
Conflict	Erro de conflito
Warning	Erro de aviso

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválido
InvalidParameterValue	Erro de valor de parâmetro inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
ExtractionFailure	Erro de falha de extração
InvalidRequestBodyFormat	Erro de formato do corpo da solicitação inválido
EmptyRequest	Erro de solicitação vazia
MissingInputDocuments	Erro de documentos de entrada ausentes
InvalidDocument	Erro de documento inválido
ModelVersionIncorrect	Erro incorreto da versão do modelo
InvalidDocumentBatch	Erro em lote de documento inválido
UnsupportedLanguageCode	Erro de código de idioma sem suporte
InvalidCountryHint	Erro de dica de país inválido

InnerErrorModel

Objeto

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	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	object	Detalhes do erro.
innererror	InnerErrorModel	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 de erro.

ProjectSettings

Objeto

Configurações configuráveis do Projeto.

Nome	Tipo	Description
defaultAnswer	string	Resposta padrão quando nenhuma correspondência boa é encontrada na base de dados de conhecimento.

QuestionAnsweringProjectMetadata

Objeto

Representa o projeto.

Nome	Tipo	Description
createdDateTime	string (date-time)	Data e hora de criação do projeto.
description	string	Descrição do projeto.
language	string	Idioma dos registros de texto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão.
lastDeployedDateTime	string (date-time)	Representa a data e hora da última implantação do projeto.
lastModifiedDateTime	string (date-time)	Representa a data/hora da última modificação do projeto.
multilingualResource	boolean	Recurso habilitado para vários idiomas em projetos ou não.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nome do projeto.
settings	ProjectSettings	Configurações configuráveis do Projeto.

QuestionAnsweringProjectMetadataCreateOrUpdate

Objeto

Representa o projeto.

Nome	Tipo	Description
description	string	Descrição do projeto.
language	string	Idioma dos registros de texto. Esta é a representação BCP-47 de um idioma. 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	Recurso habilitado para vários idiomas em projetos ou não.
settings	ProjectSettings	Configurações configuráveis do Projeto.