Skip to content

thread_create_params

Classes:

Name Description
Message
ThreadCreateParams

Message

Attributes:

Name Type Description
content Required[str]

The content of the message.

file_ids List[str]

A list of File IDs that

metadata Optional[object]

Set of 16 key-value pairs that can be attached to an object.

role Required[Literal['user']]

The role of the entity that is creating the message.

content instance-attribute

content: Required[str]

The content of the message.

file_ids instance-attribute

file_ids: List[str]

A list of File IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like retrieval and code_interpreter that can access and use files.

metadata instance-attribute

metadata: Optional[object]

Set of 16 key-value pairs that can be attached to an object.

This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

role instance-attribute

role: Required[Literal['user']]

The role of the entity that is creating the message.

Currently only user is supported.

ThreadCreateParams

Attributes:

Name Type Description
messages Iterable[Message]

A list of messages to

metadata Optional[object]

Set of 16 key-value pairs that can be attached to an object.

messages instance-attribute

messages: Iterable[Message]

A list of messages to start the thread with.

metadata instance-attribute

metadata: Optional[object]

Set of 16 key-value pairs that can be attached to an object.

This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.