Question Answering Projects - Get Sources

Serviço:

Azure AI Services

Versão da API:

2021-10-01

Obtém todas as fontes de um projeto.

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

Com parâmetros opcionais:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

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 maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.
maxpagesize	query		integer (int32)	O número máximo de recursos a serem incluídos em uma única resposta.
skip	query		integer (int32)	Um deslocamento para a 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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	QnaSources	Todas as fontes de um projeto.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "displayName": "source1",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    },
    {
      "displayName": "source2",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
      "sourceKind": "file",
      "contentStructureKind": "unstructured",
      "lastUpdatedDateTime": "2021-05-01T15:13:22Z",
      "source": "surface-guide.pdf"
    }
  ]
}

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.
QnaSourceRecord	Registro de origem personalizado com data/hora atualizada pela última vez.
QnaSources	Todas as fontes de QnA para o projeto.
sourceContentStructureKind	Tipo de estrutura de conteúdo para fontes.
sourceKind	Tipos de origem com suporte.

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
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

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
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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.

QnaSourceRecord

Objeto

Registro de origem personalizado com data/hora atualizada pela última vez.

Nome	Tipo	Valor padrão	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Tipo de estrutura de conteúdo para fontes.
displayName	string minLength: 1 maxLength: 200		Nome amigável da origem.
lastUpdatedDateTime	string (date-time)		Data/hora em que o QnA foi atualizado pela última vez.
source	string		Identificador de origem exclusivo. Nome do arquivo se for uma origem 'file'; caso contrário, a URL completa se for uma origem 'url'.
sourceKind	sourceKind	url	Tipos de origem com suporte.
sourceUri	string (uri)		Local do URI para o arquivo ou url.

QnaSources

Objeto

Todas as fontes de QnA para o projeto.

Nome	Tipo	Description
nextLink	string
value	QnaSourceRecord[]	Fontes personalizadas das quais os QnAs foram extraídos ou adicionados explicitamente ao projeto.

sourceContentStructureKind

Enumeração

Tipo de estrutura de conteúdo para fontes.

Valor	Description
unstructured

sourceKind

Enumeração

Tipos de origem com suporte.

Valor	Description
file
url