ListKnowledgeBaseJobs - Platform For AI

取得知識庫任務列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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: 執行中。 Success: 執行成功。 Failed: 執行失敗。	Running
JobAction	string	否	任務操作類型。 SyncIndex：更新知識庫索引。	SyncIndex
NextToken	string	否	用來標記當前開始讀取的位置，置空表示從頭開始。	10
MaxResults	integer	否	使用 NextToken 方式查詢時，每次最多返回的結果數。	10
SortBy	string	否	排序欄位。目前只支援 GmtCreateTime。	GmtCreateTime
Order	string	否	排序方式。 ASC：升序。 DESC：降序。	DESC
PageNumber	integer	否	當前頁數。取值範圍：大於 0。預設值：1。如果同時傳入 MaxResults，則使用 NextToken 查詢方式，忽略此欄位值。	1
PageSize	integer	否	每頁查詢的數量。如果同時傳入 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

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。