OpenAIAssistants class
OpenAI Assistant Management capability implementation
This module handles assistant creation, management, and interaction for OpenAI providers.
- Implemented types
Constructors
- OpenAIAssistants.new(OpenAIClient client, OpenAIConfig config)
Properties
- client → OpenAIClient
-
final
- config → OpenAIConfig
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addTools(
String assistantId, List< AssistantTool> tools) → Future<Assistant> - Add tools to assistant
-
assistantExists(
String assistantId) → Future< bool> - Check if assistant exists
-
cloneAssistant(
String assistantId, {String? newName, String? newDescription, Map< String, String> ? additionalMetadata}) → Future<Assistant> - Clone an assistant with modifications
-
createAssistant(
CreateAssistantRequest request) → Future< Assistant> -
Create an assistant
override
-
deleteAssistant(
String assistantId) → Future< DeleteAssistantResponse> -
Delete an assistant
override
-
deleteAssistants(
List< String> assistantIds) → Future<List< DeleteAssistantResponse> > - Batch delete assistants
-
exportAssistant(
Assistant assistant) → Map< String, dynamic> - Export assistant configuration
-
getAssistantByName(
String name) → Future< Assistant?> - Get assistant by name
-
getAssistantsByModel(
String model) → Future< List< Assistant> > - Get assistants by model
-
getAssistantStats(
Assistant assistant) → Map< String, dynamic> - Get assistant usage statistics (if available in metadata)
-
importAssistant(
Map< String, dynamic> config) → Future<Assistant> - Import assistant from configuration
-
listAssistants(
[ListAssistantsQuery? query]) → Future< ListAssistantsResponse> -
List assistants
override
-
modifyAssistant(
String assistantId, ModifyAssistantRequest request) → Future< Assistant> -
Modify an assistant
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeTools(
String assistantId, List< String> toolTypes) → Future<Assistant> - Remove tools from assistant
-
retrieveAssistant(
String assistantId) → Future< Assistant> -
Retrieve an assistant
override
-
searchAssistants(
{String? namePattern, String? model, List< String> ? requiredTools, Map<String, String> ? metadataFilters}) → Future<List< Assistant> > - Search assistants by criteria
-
toString(
) → String -
A string representation of this object.
inherited
-
updateInstructions(
String assistantId, String newInstructions) → Future< Assistant> - Update assistant instructions
-
updateMetadata(
String assistantId, Map< String, String> metadata) → Future<Assistant> - Update assistant metadata
-
updateToolResources(
String assistantId, ToolResources toolResources) → Future< Assistant> - Update assistant tool resources
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited