Question Answering Projects - Get Sources

Servizio:

Azure AI Services

Versione API:

2021-10-01

Ottiene tutte le origini di un progetto.

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

Con parametri facoltativi:

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 di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nome del progetto da utilizzare.
api-version	query	True	string	Versione dell'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

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Record di origine personalizzato con data e ora dell'ultimo aggiornamento.
QnaSources	Tutte le origini QnA per il progetto.
sourceContentStructureKind	Tipo di struttura del contenuto per le origini.
sourceKind	Tipi di origine supportati.

Error

Object

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

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'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 errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

QnaSourceRecord

Object

Record di origine personalizzato con data e ora dell'ultimo aggiornamento.

Nome	Tipo	Valore predefinito	Descrizione
contentStructureKind	sourceContentStructureKind	Unstructured	Tipo di struttura del contenuto per le origini.
displayName	string minLength: 1 maxLength: 200		Nome descrittivo dell'origine.
lastUpdatedDateTime	string (date-time)		Data e ora dell'ultimo aggiornamento del QnA.
source	string		Identificatore di origine univoco. Nome del file se si tratta di un'origine 'file'; in caso contrario, l'URL completo se è un'origine 'url'.
sourceKind	sourceKind	url	Tipi di origine supportati.
sourceUri	string (uri)		Percorso URI per il file o l'URL.

QnaSources

Object

Tutte le origini QnA per il progetto.

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

sourceContentStructureKind

Enumerazione

Tipo di struttura del contenuto per le origini.

Valore	Descrizione
unstructured

sourceKind

Enumerazione

Tipi di origine supportati.

Valore	Descrizione
file
url