Dela via


Question Answering Projects - Get Sources

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

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-15-preview
GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-15-preview&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-parametrar

Name I Obligatorisk Typ Description
projectName
path True

string

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.

Svar

Name Typ Description
200 OK

QnaSources

Alla källor i ett projekt.

Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

AADToken

Det här är Azure Active Directory OAuth2 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anteckningar

  • Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

  • För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för Arbete, Skola och Gäster men stöder inte personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-15-preview

Exempelsvar

{
  "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

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

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

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

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

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.

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 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-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 QnA:er 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