openai_dart_assistants library
Deprecated Assistants API for OpenAI.
DEPRECATED: The Assistants API is being phased out by OpenAI.
Use the Responses API instead: import 'package:openai_dart/openai_dart.dart'
This entry point provides access to:
- Assistants
- Threads
- Messages
- Runs
- Vector Stores
Usage with import prefix to avoid conflicts:
import 'package:openai_dart/openai_dart.dart';
import 'package:openai_dart/openai_dart_assistants.dart' as assistants;
// Use Responses API (modern)
final tool = CodeInterpreterTool();
// Use Assistants API (deprecated)
final assistantTool = assistants.CodeInterpreterTool();
Classes
- Assistant
- An assistant that can interact with users and use tools.
- AssistantList
- A list of assistants.
- AssistantTool
- A tool that an assistant can use.
- AttachmentTool
- A tool specification for a message attachment.
- AutoChunkingStrategy
- Auto chunking strategy.
- ChunkingStrategy
- A chunking strategy for file processing.
- CodeInterpreterAttachmentTool
- Code interpreter tool for attachments.
- CodeInterpreterOutput
- A code interpreter output.
- CodeInterpreterResources
- Resources for the code interpreter tool.
- CodeInterpreterStepCall
- A code interpreter tool call.
- CodeInterpreterTool
- Code interpreter tool for executing Python code.
- CreateAssistantRequest
- A request to create an assistant.
- CreateMessageRequest
- A request to create a message.
- CreateRunRequest
- A request to create a run.
- CreateThreadRequest
- A request to create a thread.
- CreateVectorStoreFileRequest
- A request to create a vector store file.
- CreateVectorStoreRequest
- A request to create a vector store.
- DeleteAssistantResponse
- The response from deleting an assistant.
- DeleteMessageResponse
- The response from deleting a message.
- DeleteThreadResponse
- The response from deleting a thread.
- DeleteVectorStoreFileResponse
- The response from deleting a vector store file.
- DeleteVectorStoreResponse
- The response from deleting a vector store.
- ExpirationPolicy
- An expiration policy for a vector store.
- FileCitation
- A file citation.
- FileCitationAnnotation
- A file citation annotation.
- FilePath
- A file path reference.
- FilePathAnnotation
- A file path annotation.
- FileSearchAttachmentTool
- File search tool for attachments.
- FileSearchRankingOptions
- Ranking options for file search.
- FileSearchResources
- Resources for the file search tool.
- FileSearchStepCall
- A file search tool call.
- FileSearchTool
- File search tool for semantic search over files.
- FunctionStepCall
- A function tool call.
- FunctionTool
- Function tool for calling custom functions.
- ImageFile
- An image file reference.
- ImageFileMessageContent
- Image file content in a message.
- ImageOutput
- Image output from code interpreter.
- ImageUrl
- An image URL.
- ImageUrlMessageContent
- Image URL content in a message.
- IncompleteDetails
- Details about why a message is incomplete.
- LogsOutput
- Logs output from code interpreter.
- Message
- A message in a thread.
- MessageAttachment
- A file attachment for a message.
- MessageContent
- Content of a message.
- MessageCreationDetails
- Details for a message creation step.
- MessageList
- A list of messages.
- ModifyAssistantRequest
- A request to modify an assistant.
- ModifyMessageRequest
- A request to modify a message.
- ModifyThreadRequest
- A request to modify a thread.
- ModifyVectorStoreRequest
- A request to modify a vector store.
- RefusalMessageContent
- Refusal content in a message.
- RequiredAction
- A required action for a run.
- Run
- A run representing the execution of an assistant on a thread.
- RunError
- A run error.
- RunFunctionCall
- A function call in a run.
- RunIncompleteDetails
- Details about why a run is incomplete.
- RunList
- A list of runs.
- RunStep
- A step in a run's execution.
- RunStepList
- A list of run steps.
- RunToolCall
- A tool call in a run.
- StaticChunkingStrategy
- Static chunking strategy with fixed parameters.
- StepDetails
- Details about a run step.
- StepError
- A run step error.
- StepToolCall
- A tool call in a run step.
- SubmitToolOutputs
- Tool outputs that need to be submitted.
- SubmitToolOutputsRequest
- A request to submit tool outputs.
- TextAnnotation
- An annotation in text content.
- TextContent
- Text content with annotations.
- TextMessageContent
- Text content in a message.
- Thread
- A thread representing a conversation with an assistant.
- ThreadMessage
- A message to add to a thread during creation.
- ToolCallsDetails
- Details for a tool calls step.
- ToolOutput
- A tool output to submit.
- ToolResources
- Resources available to an assistant's tools.
- TruncationStrategy
- The truncation strategy for a run.
- VectorStore
- A vector store for semantic file search.
- VectorStoreConfig
- Configuration for creating a vector store.
- VectorStoreFile
- A file in a vector store.
- VectorStoreFileCounts
- File counts by status in a vector store.
- VectorStoreFileError
- An error from vector store file processing.
- VectorStoreFileList
- A list of vector store files.
- VectorStoreList
- A list of vector stores.
Enums
- MessageStatus
- Message status values.
- RunStatus
- Run status values.
- RunStepStatus
- Run step status values.
- RunStepType
- Run step type values.
- VectorStoreFileStatus
- Vector store file status values.
- VectorStoreStatus
- Vector store status values.