Update Fileset Metadata

PATCH

https://host.com/apis/files/v2/workspaces/:workspace/filesets/:name

PATCH

/apis/files/v2/workspaces/:workspace/filesets/:name

$ curl -X PATCH https://host.com/apis/files/v2/workspaces/workspace/filesets/name \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "id": "fileset-1234abcd",
3   "name": "customer_data_2024",
4   "workspace": "marketing_team",
5   "description": "Fileset containing customer demographic and transaction data for Q1 2024 analysis.",
6   "purpose": "dataset",
7   "storage": {
8     "read_chunk_size": 1048576,
9     "type": "local",
10     "path": "/mnt/data/marketing/customer_data_2024",
11     "write_buffer_size": 16777216
12   },
13   "metadata": {
14     "dataset": {
15       "schema": {},
16       "schema_defs": {},
17       "schemas_by_path": {}
18     },
19     "model": {
20       "tool_calling": {
21         "chat_template": "Hello {{user}}, how can I assist you with the model today?",
22         "tool_call_parser": "openai",
23         "tool_call_plugin": "ml_workspace/custom_tool_plugin",
24         "auto_tool_choice": true
25       }
26     }
27   },
28   "custom_fields": {},
29   "project": "customer_insights_q1",
30   "created_at": "2024-04-01T09:00:00Z",
31   "updated_at": "2024-04-15T16:45:00Z"
32 }

Update Fileset Metadata.

Path parameters

workspacestringRequired

namestringRequired

Request

This endpoint expects an object.

descriptionstringOptional<=255 characters

The description of the fileset.

projectstringOptional

The name of the project associated with this fileset.

purposeenumOptional

The purpose of the fileset.

metadataobjectOptional

Purpose-specific metadata. Use the purpose as the key (e.g., {dataset: {…}}).

custom_fieldsmap from strings to anyOptional

Custom fields for the fileset.

Response

Successful Response

idstring

namestring

workspacestring

descriptionstring

purposeenum

storageobject

metadataobject

Tagged metadata container - the key indicates the type.

Example: metadata = FilesetMetadata( dataset=DatasetMetadataContent( schema={“columns”: [“id”, “name”]}, ) )

custom_fieldsmap from strings to any

projectstring

created_atstring

updated_atstring

Errors

422

Unprocessable Entity Error