Skip to main content
PATCH
/
datasets
/
{dataset_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "provider": "<string>",
  "permission": "<string>",
  "data_source_type": "<string>",
  "indexing_technique": "<string>",
  "app_count": 123,
  "document_count": 123,
  "word_count": 123,
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": 123,
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": 123,
  "embedding_model": "<string>",
  "embedding_model_provider": "<string>",
  "embedding_available": true,
  "retrieval_model_dict": {
    "search_method": "hybrid_search",
    "reranking_enable": true,
    "reranking_mode": {
      "reranking_provider_name": "<string>",
      "reranking_model_name": "<string>"
    },
    "top_k": 123,
    "score_threshold_enabled": true,
    "score_threshold": 123,
    "weights": 123
  },
  "tags": [
    {}
  ],
  "doc_form": "<string>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
dataset_id
string<uuid>
required

The unique identifier of the knowledge base.

Body

application/json
​
name
string

New name for the knowledge base.

​
description
string

New description for the knowledge base.

​
indexing_technique
enum<string>
Available options:
high_quality,
economy
​
permission
enum<string>
Available options:
only_me,
all_team_members,
partial_members
​
embedding_model_provider
string
​
embedding_model
string
​
retrieval_model
object
​
partial_member_list
string[]

List of member IDs for 'partial_members' permission.

Response

Successfully updated dataset details.

​
id
string<uuid>
​
name
string
​
description
string | null
​
provider
string
​
permission
string
​
data_source_type
string | null
​
indexing_technique
string | null
​
app_count
integer
​
document_count
integer
​
word_count
integer
​
created_by
string<uuid>
​
created_at
integer<int64>
​
updated_by
string<uuid>
​
updated_at
integer<int64>
​
embedding_model
string | null
​
embedding_model_provider
string | null
​
embedding_available
boolean | null
​
retrieval_model_dict
object
​
tags
object[]
​
doc_form
string | null