Datasets

Manage datasets, including creating, retrieving, listing, updating, and deleting datasets. These datasets can be used for Retrieval-Augmented Generation (RAG).

Create a Dataset

post

查询参数

tenantUnitIdstring可选Example: {{tenantUnitId}}

tenantIdstring必填Example: {{tenantId}}

头参数

X-Api-Keystring可选

the API Key

Example: {{apiKey}}

请求体

application/json

idstring可选

tenantUnitIdstring可选

namestring必填

descriptionstring · 可为 null可选

typestring可选

knowledge or qa

tagsstring[]可选

响应

200成功

application/json

post

/admin/api/v1/datasets

HTTPcURLJavaScriptPython

POST /admin/api/v1/datasets?tenantId=text HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "name": "rdc-poc-dataset-dev",
  "tenantId": "12953d87-3c05-4b8e-b8d8-cd02149f4cee",
  "tenantUnitId": "78c8e44c-9ef2-461d-88ba-ee7783a90251",
  "description": "rdc poc dataset in dev env"
}

200成功

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

Get a Dataset

get

路径参数

datasetIdstring必填Example: {{datasetId}}

查询参数

tenantIdstring必填Example: {{tenantId}}

头参数

X-Api-Keystring可选

the API Key

Example: {{apiKey}}

响应

200成功

application/json

get

/admin/api/v1/datasets/{datasetId}

HTTPcURLJavaScriptPython

GET /admin/api/v1/datasets/{datasetId}?tenantId=text HTTP/1.1
Host: api.workfx.ai
Accept: */*

200成功

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

List Dataset

get

查询参数

tenantIdstring可选Example: ff9bd0ba-8de5-46e1-9303-1bd2081cfc74

tenantUnitIdstring可选Example: f96c6fc1-af3e-45d0-bec8-1e5525da8905

limitinteger可选

If no parameters are provided, all datasets will be returned.

Example: 5

typestring可选

头参数

X-Api-Keystring可选

the API Key

Example: {{apiKey}}

响应

200成功

application/json

get

/admin/api/v1/datasets

HTTPcURLJavaScriptPython

GET /admin/api/v1/datasets HTTP/1.1
Host: api.workfx.ai
Accept: */*

200成功

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

Delete dataset

delete

路径参数

datasetIdstring必填Example: 0361d480-ac91-430e-94d4-8e3a9762675f

查询参数

deleteDocumentstring可选Example: true

tenantIdstring可选Example: fcbb17f3-646f-41d3-a097-fdb801f73142

头参数

X-Api-Keystring可选

the API Key

Example: {{apiKey}}

响应

204成功

application/json

delete

/admin/api/v1/datasets/{datasetId}

HTTPcURLJavaScriptPython

DELETE /admin/api/v1/datasets/{datasetId} HTTP/1.1
Host: api.workfx.ai
Accept: */*

204成功

{}

Partial update dataset

patch

路径参数

datatsetIdstring必填

查询参数

tenantIdstring必填Example: {{tenantId}}

头参数

X-Api-Keystring可选

the API Key

Example: {{apiKey}}

请求体

application/json

namestring可选

descriptionstring · 可为 null可选

typestring可选

knowledge or qa

tagsstring[]可选

响应

200成功

application/json

patch

/admin/api/v1/datasets/{datatsetId}

HTTPcURLJavaScriptPython

PATCH /admin/api/v1/datasets/{datatsetId}?tenantId=text HTTP/1.1
Host: api.workfx.ai
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "text",
  "description": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}

200成功

{
  "id": "text",
  "tenantId": "text",
  "tenantUnitId": "text",
  "name": "text",
  "description": "text",
  "createdTime": "text",
  "updatedTime": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "status": "text",
  "type": "text",
  "tags": [
    "text"
  ]
}