Question Answering Projects - Get Sources

Referens

Service:: Cognitive Services

API Version:: 2021-10-01

Hämtar alla källor för ett projekt.

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.
maxpagesize	query		integer int32	Det maximala antalet resurser som ska ingå i ett enda svar.
skip	query		integer int32	En förskjutning i samlingen av den första resursen som ska returneras.
top	query		integer int32	Det maximala antalet resurser som ska returneras från samlingen.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Svar

Name	Typ	Description
200 OK	QnaSources	Alla källor i ett projekt.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
QnaSourceRecord	Anpassad källpost med senast uppdaterad datum/tid.
QnaSources	Alla QnA-källor för projektet.
sourceContentStructureKind	Innehållsstrukturtyp för källor.
sourceKind	Källtyper som stöds.

Error

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

QnaSourceRecord

Anpassad källpost med senast uppdaterad datum/tid.

Name	Typ	Standardvärde	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Innehållsstrukturtyp för källor.
displayName	string		Eget namn på källan.
lastUpdatedDateTime	string		Datum när QnA senast uppdaterades.
source	string		Unik källidentifierare. Namnet på filen om det är en filkälla. Annars är den fullständiga URL:en om det är en url-källa.
sourceKind	sourceKind	url	Källtyper som stöds.
sourceUri	string		URI-plats för filen eller URL:en.

QnaSources

Alla QnA-källor för projektet.

Name	Typ	Description
nextLink	string
value	QnaSourceRecord[]	Anpassade källor från vilka frågor och svar extraherades eller uttryckligen lades till i projektet.

sourceContentStructureKind

Innehållsstrukturtyp för källor.

Name	Typ	Description
unstructured	string

sourceKind

Källtyper som stöds.

Name	Typ	Description
file	string
url	string

Share via