ChatFilesActionRequest¶

pydantic model openapi_client.models.chat_files_action_request.ChatFilesActionRequest¶

POST /ai/playground/files body. Upload (no save_to_dataset action) requires FileName; optional ChatId, ProjectId, FileSize. save_to_dataset requires DatasetId and Files (max 5); optional PartitionKeys. Extra fields are ignored.

Fields:

chat_id (str | None)
dataset_id (str | None)
file_name (str | None)
file_size (int | None)
files (List[openapi_client.models.chat_files_action_request_files_inner.ChatFilesActionRequestFilesInner] | None)
partition_keys (Dict[str, Any] | None)
project_id (str | None)

field chat_id: Optional[StrictStr] = None (alias 'ChatId')¶: Upload target chat. Use global for the user’s global files. Ignored when ProjectId is set. Unused for save_to_dataset except via Files[].ChatId.

field project_id: Optional[StrictStr] = None (alias 'ProjectId')¶: Upload target project. When set (not N/A), uploads to project files. Unused for save_to_dataset except via Files[].ProjectId.

field file_name: Optional[StrictStr] = None (alias 'FileName')¶: Required for upload URL. File name to upload.

field file_size: Optional[StrictInt] = None (alias 'FileSize')¶: Optional. Used for project uploads; values over 50 MB are rejected. Default 0 if omitted. Unused for chat uploads and save_to_dataset.

field dataset_id: Optional[StrictStr] = None (alias 'DatasetId')¶: Required for save_to_dataset. Target dataset identifier.

field files: Optional[Annotated[List[ChatFilesActionRequestFilesInner], Field(max_length=5)]] = None (alias 'Files')¶: Required for save_to_dataset. Existing files to ingest (max 5).

field partition_keys: Optional[Dict[str, Any]] = None (alias 'PartitionKeys')¶: Optional partition key-value map for dataset ingestion (save_to_dataset).

to_str()¶

Returns the string representation of the model using alias

Return type:: str

to_json()¶

Returns the JSON representation of the model using alias

Return type:: str

classmethod from_json(json_str)¶

Create an instance of ChatFilesActionRequest from a JSON string

Return type:: Optional[Self]

to_dict()¶

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:: Dict[str, Any]

classmethod from_dict(obj)¶

Create an instance of ChatFilesActionRequest from a dict

Return type:: Optional[Self]