Question Answering Projects - Get Project Details

Serviço:

Azure AI Services

Versão da API:

2021-10-01

Obtenha os metadados do projeto solicitados.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}?api-version=2021-10-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Name	Tipo	Description
200 OK	ProjectMetadata	Os metadados para o projeto especificado.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1?api-version=2021-10-01

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."
  },
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z"
}

Definições

Name	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.
ProjectMetadata	Representa o projeto.
ProjectSettings	Configurações configuráveis do Projeto.

Error

Object

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

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

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.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
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	Alvo de erro.

ProjectMetadata

Object

Representa o projeto.

Name	Tipo	Description
createdDateTime	string (date-time)	Data-hora de criação do projeto.
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.
lastDeployedDateTime	string (date-time)	Representa a data-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	Nome do projeto.
settings	ProjectSettings	Configurações configuráveis do Projeto.

ProjectSettings

Object

Configurações configuráveis do Projeto.

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