Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
ThreadsOperations interface
- Package:
- @azure/ai-agents
Interface representing a Threads operations.
Properties
| create | Creates a new thread. Threads contain messages and can be run by agents. |
| delete | Deletes an existing thread. |
| get | Gets information about an existing thread. |
| list | Gets a list of threads that were previously created. |
| update | Modifies an existing thread. |
Property Details
create
Creates a new thread. Threads contain messages and can be run by agents.
create: (options?: ThreadsCreateThreadOptionalParams) => Promise<AgentThread>Property Value
(options?: ThreadsCreateThreadOptionalParams) => Promise<AgentThread>
delete
Deletes an existing thread.
delete: (threadId: string, options?: ThreadsDeleteThreadOptionalParams) => Promise<ThreadDeletionStatus>Property Value
(threadId: string, options?: ThreadsDeleteThreadOptionalParams) => Promise<ThreadDeletionStatus>
get
Gets information about an existing thread.
get: (threadId: string, options?: ThreadsGetThreadOptionalParams) => Promise<AgentThread>Property Value
(threadId: string, options?: ThreadsGetThreadOptionalParams) => Promise<AgentThread>
list
Gets a list of threads that were previously created.
list: (options?: ThreadsListThreadsOptionalParams) => PagedAsyncIterableIterator<AgentThread, AgentThread[], PageSettings>Property Value
(options?: ThreadsListThreadsOptionalParams) => PagedAsyncIterableIterator<AgentThread, AgentThread[], PageSettings>
update
Modifies an existing thread.
update: (threadId: string, options?: ThreadsUpdateThreadOptionalParams) => Promise<AgentThread>Property Value
(threadId: string, options?: ThreadsUpdateThreadOptionalParams) => Promise<AgentThread>