Question Answering Projects - List Projects

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

Obtém todos os projetos para um usuário.

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

Com parâmetros opcionais:

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.
maxpagesize	query		integer (int32)	O número máximo de recursos a incluir numa única resposta.
skip	query		integer (int32)	Um deslocamento na coleção do primeiro recurso a ser retornado.
top	query		integer (int32)	O número máximo de recursos a serem retornados da coleção.

Respostas

Name	Tipo	Description
200 OK	PagedQuestionAnsweringProjectMetadata	O pedido foi bem-sucedido.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

PagedQuestionAnsweringProjectMetadata

O pedido foi bem-sucedido.

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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

Exemplos

Successful query

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "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",
      "language": "en"
    },
    {
      "description": "proj2 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": "proj2",
      "language": "fr"
    }
  ]
}

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.
PagedQuestionAnsweringProjectMetadata	Coleção paginada de itens QuestionAnsweringProjectMetadata
ProjectSettings	Configurações configuráveis do Projeto.
QuestionAnsweringProjectMetadata	Representa o 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	Erro de solicitação inválida
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 de projeto não encontrado
OperationNotFound	Erro de operação não encontrado
AzureCognitiveSearchNotFound	Erro não encontrado da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexNotFound	Erro de índice da Pesquisa Cognitiva do Azure não encontrado
TooManyRequests	Erro de muitas solicitações
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
AzureCognitiveSearchIndexLimitReached	Erro atingido pelo limite do índice da Pesquisa Cognitiva do Azure
InternalServerError	Erro interno do servidor
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
QuotaExceeded	Erro de quota excedida
Conflict	Erro de conflito
Warning	Erro de aviso

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	Erro de solicitação inválida
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 da Pesquisa Cognitiva do Azure
AzureCognitiveSearchThrottling	Erro de limitação da Pesquisa Cognitiva do Azure
ExtractionFailure	Erro de falha de extração
InvalidRequestBodyFormat	Erro de formato de corpo de 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 de versão incorreta do modelo
InvalidDocumentBatch	Erro de lote de documento inválido
UnsupportedLanguageCode	Erro de código de idioma não suportado
InvalidCountryHint	Erro de dica de país inválido

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.

PagedQuestionAnsweringProjectMetadata

Object

Coleção paginada de itens QuestionAnsweringProjectMetadata

Name	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	QuestionAnsweringProjectMetadata[]	Os itens QuestionAnsweringProjectMetadata nesta página

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.

QuestionAnsweringProjectMetadata

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

Partilhar via

Question Answering Projects - List Projects

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Successful query

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

PagedQuestionAnsweringProjectMetadata

ProjectSettings

QuestionAnsweringProjectMetadata