ナレッジベースタスクのリストを取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
pailangstudio:ListKnowledgeBaseJobs |
list |
*All Resource
|
なし | なし |
リクエスト構文
GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasejobs HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| KnowledgeBaseId |
string |
任意 |
ナレッジベースの ID。 |
d-ksicx823d |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WorkspaceId |
string |
任意 |
ナレッジベースが存在するワークスペースの ID。 |
478** |
| KnowledgeBaseJobId |
string |
任意 |
ナレッジベースタスクの ID。 |
kbjob-9m******54 |
| Status |
string |
任意 |
ナレッジベースタスクのステータス。有効な値:
|
Running |
| JobAction |
string |
任意 |
タスク操作のタイプ。有効な値:
|
SyncIndex |
| NextToken |
string |
任意 |
読み取りを開始する位置を示すページネーショントークン。先頭から読み取るには、このパラメーターを空のままにします。 |
10 |
| MaxResults |
integer |
任意 |
NextToken ベースのページネーションメソッドを使用する場合に返す結果の最大値。 |
10 |
| SortBy |
string |
任意 |
結果をソートするフィールド。現在、GmtCreateTime のみがサポートされています。 |
GmtCreateTime |
| Order |
string |
任意 |
ソート順序。有効な値:
|
DESC |
| PageNumber |
integer |
任意 |
ページ番号。有効な値: 0 より大きい値。デフォルト値: 1。MaxResults も指定されている場合、NextToken ベースのページネーションメソッドが使用され、このパラメーターは無視されます。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。MaxResults も指定されている場合、MaxResults の値が優先されます。 |
10 |
| Accessibility |
string |
任意 |
PRIVATE |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| KnowledgeBaseJobs |
array |
ナレッジベースタスクのリスト。 |
|
| KnowledgeBaseJob |
ナレッジベースタスクの詳細。 |
||
| MaxResults |
integer |
このリクエストで返すことが許可されるレコードの最大値。 |
20 |
| NextToken |
string |
次のクエリを開始する位置。空の値はすべてのデータが取得済みであることを示します。 |
20 |
| TotalCount |
integer |
レコードの総数。 |
32 |
| RequestId |
string |
リクエスト ID。 |
963BD7F9-0C02-5594-9550-BCC6DD43E3C0 |
例
成功レスポンス
JSONJSON
{
"KnowledgeBaseJobs": [
{
"WorkspaceId": "478**",
"Accessibility": "PRIVATE",
"Creator": "2003******4844",
"GmtCreateTime": "2024-05-13T01:43:15Z",
"GmtModifiedTime": "2024-05-13T03:05:22Z",
"KnowledgeBaseId": "d-ksicx823d",
"KnowledgeBaseJobId": "kbjob-9m******54",
"JobAction": "SyncIndex",
"Description": "This is a description of the knowledge base job.",
"Status": "Running",
"ResourceId": "quota89**76",
"EcsSpecs": [
{
"Type": "Worker",
"InstanceType": "ecs.c6.large",
"PodCount": 1,
"CPU": 4,
"GPU": 1,
"Memory": 16,
"SharedMemory": 16,
"GPUType": "V100",
"Driver": "550.127.08"
}
],
"UserVpc": {
"VpcId": "vpc-wz90****5v23",
"VSwitchId": "vsw-wz9r****ng10",
"SecurityGroupId": "sg-wz91****e10e"
},
"MaxRunningTimeInSeconds": 86400,
"GmtFinishTime": "2024-05-13T04:03:27Z",
"ErrorMessage": "Failed to update knwoledge base index, pipelineRunId: flow-9p8f****4t9z",
"PipelineRunInfo": {
"PipelineRunId": "flow-fi8z******g4gy"
},
"KnowledgeBaseJobResult": {
"TotalFileCount": 1,
"AddChunkCount": 10,
"DeleteChunkCount": 2
},
"EmbeddingConfig": {
"BatchSize": 8,
"Concurrency": 1
}
}
],
"MaxResults": 20,
"NextToken": "20",
"TotalCount": 32,
"RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。