Question Answering Projects - Get Sources

Tjänst:

Azure AI 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

Med valfria parametrar:

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 maxLength: 100	Namnet på projektet som ska användas.
api-version	query	True	string	Klient-API-version.
maxpagesize	query		integer (int32)	Det maximala antalet resurser som ska inkluderas 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

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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 Riktlinjerna för Microsoft One API – 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

Objekt

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

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – 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

Objekt

Anpassad källpost med senast uppdaterad datum-tid.

Name	Typ	Standardvärde	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Innehållsstrukturtyp för källor.
displayName	string minLength: 1 maxLength: 200		Eget namn på källan.
lastUpdatedDateTime	string (date-time)		Datum då QnA senast uppdaterades.
source	string		Unik källidentifierare. Namnet på filen om det är en filkälla. i annat fall den fullständiga URL:en om det är en url-källa.
sourceKind	sourceKind	url	Källtyper som stöds.
sourceUri	string (uri)		URI-plats för filen eller URL:en.

QnaSources

Objekt

Alla QnA-källor för projektet.

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

sourceContentStructureKind

Uppräkning

Innehållsstrukturtyp för källor.

Värde	Description
unstructured

sourceKind

Uppräkning

Källtyper som stöds.

Värde	Description
file
url