Share via

AgentThreadCreationOptions interface

  • Reference
Package:
@azure/ai-projects

The details used to create a new agent thread.

Properties

messages

The initial messages to associate with the new thread.
metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
toolResources

A set of resources that are made available to the agent's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

Property Details

messages

The initial messages to associate with the new thread.

messages?: ThreadMessageOptions[]

Property Value

ThreadMessageOptions[]

metadata

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

toolResources

A set of resources that are made available to the agent's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

toolResources?: null | ToolResources

Property Value

null | ToolResources