Question Answering Projects - Get Sources
Lekéri a projekt összes forrását.
GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01
GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
A használni kívánt projekt neve. |
api-version
|
query | True |
string |
Ügyfél API-verziója. |
maxpagesize
|
query |
integer int32 |
Az egyetlen válaszba belefoglalandó erőforrások maximális száma. |
|
skip
|
query |
integer int32 |
Az első visszaadandó erőforrás gyűjteményének eltolása. |
|
top
|
query |
integer int32 |
A gyűjteményből visszatérni kívánt erőforrások maximális száma. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A projekt összes forrása. |
|
Other Status Codes |
Hibaválasz. |
Biztonság
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Példák
Successful query
Sample Request
GET {Endpoint}/language/query-knowledgebases/projects/proj1/sources?api-version=2021-10-01
Sample Response
{
"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"
}
]
}
Definíciók
Name | Description |
---|---|
Error |
A hibaobjektum. |
Error |
Emberi olvasásra alkalmas hibakód. |
Error |
Hibaválasz. |
Inner |
Emberi olvasásra alkalmas hibakód. |
Inner |
Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Qna |
Egyéni forrásrekord a legutóbbi frissítés dátum-időpontjával. |
Qna |
A projekt összes QnA-forrása. |
source |
A források tartalomstruktúra-típusa. |
source |
Támogatott forrástípusok. |
Error
A hibaobjektum.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
Error[] |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról. |
|
message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
A hiba célja. |
ErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | 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
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
InnerErrorCode
Emberi olvasásra alkalmas hibakód.
Name | Típus | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
ExtractionFailure |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
KnowledgeBaseNotFound |
string |
InnerErrorModel
Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
object |
Hiba részletei. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról. |
|
message |
string |
Hibaüzenet. |
target |
string |
Hibacél. |
QnaSourceRecord
Egyéni forrásrekord a legutóbbi frissítés dátum-időpontjával.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
contentStructureKind | Unstructured |
A források tartalomstruktúra-típusa. |
|
displayName |
string |
A Forrás rövid neve. |
|
lastUpdatedDateTime |
string |
A QnA utolsó frissítésének dátuma. |
|
source |
string |
Egyedi forrásazonosító. A fájl neve, ha "fájl" forrás; ellenkező esetben a teljes URL-címet, ha az "URL" forrás. |
|
sourceKind | url |
Támogatott forrástípusok. |
|
sourceUri |
string |
A fájl vagy url URI-helye. |
QnaSources
A projekt összes QnA-forrása.
Name | Típus | Description |
---|---|---|
nextLink |
string |
|
value |
Egyéni források, amelyekből a QNA-kat kinyerték vagy explicit módon hozzáadták a projekthez. |
sourceContentStructureKind
A források tartalomstruktúra-típusa.
Name | Típus | Description |
---|---|---|
unstructured |
string |
sourceKind
Támogatott forrástípusok.
Name | Típus | Description |
---|---|---|
file |
string |
|
url |
string |