Update Dataset Config

PATCH

https://api.coactive.ai/api/v1/datasets/:dataset_id/config

Update configuration for a dataset in the dataset_config JSONB column. Returns 204 No Content if no changes were made.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

dataset_idstringRequiredformat: "uuid"

This endpoint expects an object.

embedding_idmap from strings to strings or nullOptional

Mapping of modality to embedding UUID.

encoder_namemap from strings to strings or nullOptional

Mapping of modality to encoder name.

hybrid_searchmap from strings to maps from strings to doubles or nullOptional

Hybrid search weights config.

metadata_fields_to_embedlist of strings or nullOptional

metadata_fields_to_indexlist of strings or nullOptional

new_video_data_modelboolean or nullOptional

celebrity_detection_enabledboolean or nullOptional

context_studio_enabledboolean or nullOptional

agentic_search_metadata_descriptionmap from strings to nullable strings or nullOptional

Per-key descriptions of metadata fields. String value adds or overwrites; null value deletes that key (no-op if absent).

asset_identifier_keystring or nullOptional

The metadata field name that uniquely identifies each asset in the dataset.

context_studio_export_json_connection_namestring or nullOptional

The name of the connection required for external s3 export. (this is related to context_studio feature).

Successful Response

dataset_idstringformat: "uuid"

embedding_idmap from strings to strings or null

encoder_namemap from strings to strings or null

hybrid_searchmap from strings to maps from strings to doubles or null

metadata_fields_to_embedlist of strings or null

metadata_fields_to_indexlist of strings or null

new_video_data_modelboolean or null

celebrity_detection_enabledboolean or nullDefaults to false

context_studio_enabledboolean or nullDefaults to false

agentic_search_metadata_descriptionmap from strings to strings or null

asset_identifier_keystring or null

422

Unprocessable Entity Error

$	curl -X PATCH https://api.coactive.ai/api/v1/datasets/dataset_id/config \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"dataset_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"embedding_id": {},
4	"encoder_name": {},
5	"hybrid_search": {},
6	"metadata_fields_to_embed": [
7	"title",
8	"description",
9	"tags"
10	],
11	"metadata_fields_to_index": [
12	"category",
13	"author",
14	"publish_date"
15	],
16	"new_video_data_model": true,
17	"celebrity_detection_enabled": true,
18	"context_studio_enabled": true,
19	"agentic_search_metadata_description": {},
20	"asset_identifier_key": "external_id"
21	}