Question Answering Projects - Create Project

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

Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).

projectName
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

Nome Obrigatório Tipo Description
language True

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.

description

string

Descrição do projeto.

multilingualResource

boolean

Defina como true para habilitar a criação de bases de dados de conhecimento em idiomas diferentes para o mesmo recurso.

settings

ProjectSettings

Configurações configuráveis do Projeto.

Respostas

Nome Tipo Description
200 OK

ProjectMetadata

Os metadados do projeto atualizado, se ele 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

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 query

Solicitação de exemplo

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

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

Resposta de exemplo

{
  "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"
}
{
  "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

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

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

Defina como true para habilitar a criação de bases de dados de conhecimento em idiomas diferentes para o mesmo recurso.

settings

ProjectSettings

Configurações configuráveis do Projeto.

Error

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

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

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 do erro.

ProjectMetadata

Representa o projeto.

Nome Tipo Description
createdDateTime

string

Data e hora da 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

Representa a data e hora da última implantação do projeto.

lastModifiedDateTime

string

Representa a data-hora da última modificação do projeto.

multilingualResource

boolean

Recurso habilitado para vários idiomas entre projetos ou não.

projectName

string

Nome do projeto.

settings

ProjectSettings

Configurações configuráveis do Projeto.

ProjectSettings

Configurações configuráveis do Projeto.

Nome Tipo Description
defaultAnswer

string

Resposta padrão quando nenhuma correspondência boa é encontrada no base de dados de conhecimento.