Question Answering Projects - Get Sources

Riferimento

Service:: Cognitive Services

API Version:: 2021-10-01

Ottiene tutte le origini di un progetto.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint servizi cognitivi supportati (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Nome del progetto da usare.
api-version	query	True	string	Versione API client.
maxpagesize	query		integer int32	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer int32	Offset nella raccolta della prima risorsa da restituire.
top	query		integer int32	Numero massimo di risorse da restituire dalla raccolta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	QnaSources	Tutte le origini di un progetto.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Esempio

Successful query

Sample Request

HTTP

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

Sample Response

Status code:: 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"
    }
  ]
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile dall'utente.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile dall'utente.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Record di origine personalizzato con l'ultima data aggiornata.
QnaSources	Tutte le origini QnA per il progetto.
sourceContentStructureKind	Tipo di struttura del contenuto per le origini.
sourceKind	Tipi di origine supportati.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile dall'utente.

Nome	Tipo	Descrizione
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Codice di errore leggibile dall'utente.

Nome	Tipo	Descrizione
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli degli errori.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

QnaSourceRecord

Record di origine personalizzato con l'ultima data aggiornata.

Nome	Tipo	Valore predefinito	Descrizione
contentStructureKind	sourceContentStructureKind	Unstructured	Tipo di struttura del contenuto per le origini.
displayName	string		Nome descrittivo dell'origine.
lastUpdatedDateTime	string		Data-ora dell'ultimo aggiornamento del QnA.
source	string		Identificatore di origine univoco. Nome del file se è un'origine 'file'; in caso contrario, l'URL completo se è un'origine "URL".
sourceKind	sourceKind	url	Tipi di origine supportati.
sourceUri	string		Percorso URI per il file o l'URL.

QnaSources

Tutte le origini QnA per il progetto.

Nome	Tipo	Descrizione
nextLink	string
value	QnaSourceRecord[]	Origini personalizzate da cui sono state estratte o aggiunte in modo esplicito i QnA al progetto.

sourceContentStructureKind

Tipo di struttura del contenuto per le origini.

Nome	Tipo	Descrizione
unstructured	string

sourceKind

Tipi di origine supportati.

Nome	Tipo	Descrizione
file	string
url	string

Condividi tramite