Question Answering Projects - Get Sources

Service:: Azure AI Services

API-versie:: 2021-10-01

Haalt alle bronnen van een project op.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.
maxpagesize	query		integer (int32)	Het maximum aantal resources dat in één antwoord moet worden opgenomen.
skip	query		integer (int32)	Een verschuiving in de verzameling van de eerste resource die moet worden geretourneerd.
top	query		integer (int32)	Het maximum aantal resources dat moet worden geretourneerd uit de verzameling.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	QnaSources	Alle bronnen van een project.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Aangepaste bronrecord met laatst bijgewerkte datum/tijd.
QnaSources	Alle QnA-bronnen voor het project.
sourceContentStructureKind	Inhoudsstructuurtype voor bronnen.
sourceKind	Ondersteunde brontypen.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

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

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

QnaSourceRecord

Object

Aangepaste bronrecord met laatst bijgewerkte datum/tijd.

Name	Type	Default value	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Inhoudsstructuurtype voor bronnen.
displayName	string minLength: 1 maxLength: 200		Beschrijvende naam van de bron.
lastUpdatedDateTime	string (date-time)		Datum en tijd waarop de QnA voor het laatst is bijgewerkt.
source	string		Unieke bron-id. De naam van het bestand als het een bestandsbron is; anders is de volledige URL als het een URL-bron is.
sourceKind	sourceKind	url	Ondersteunde brontypen.
sourceUri	string (uri)		URI-locatie voor het bestand of de URL.

QnaSources

Object

Alle QnA-bronnen voor het project.

Name	Type	Description
nextLink	string
value	QnaSourceRecord[]	Aangepaste bronnen waaruit QnA's zijn geëxtraheerd of expliciet aan het project zijn toegevoegd.

sourceContentStructureKind

Inventarisatie

Inhoudsstructuurtype voor bronnen.

Waarde	Description
unstructured

sourceKind

Inventarisatie

Ondersteunde brontypen.

Waarde	Description
file
url