AssistantApi extension

Extension providing assistant management functionality for LangGraphClient.

This extension enables creation, retrieval, updating, deletion, and searching of LangGraph assistants, which represent configurable instances of graphs that can be used to process messages in threads. It also provides access to assistant versioning, schemas, and subgraph operations.

on

Methods

createAssistant({required String graphId, String? assistantId, AssistantConfig? config, Map<String, dynamic>? metadata, String ifExists = 'raise', String? name}) Future<Assistant>

Available on LangGraphClient, provided by the AssistantApi extension

Creates a new assistant with the specified configuration.
deleteAssistant(String assistantId) Future<void>

Available on LangGraphClient, provided by the AssistantApi extension

Deletes an assistant by its ID.
getAssistant(String assistantId) Future<Assistant>

Available on LangGraphClient, provided by the AssistantApi extension

Retrieves an assistant by its ID.
getAssistantGraph(String assistantId) Future<Map<String, dynamic>>

Available on LangGraphClient, provided by the AssistantApi extension

Gets the graph definition for an assistant.
getAssistantSchemas(String assistantId) Future<AssistantSchema>

Available on LangGraphClient, provided by the AssistantApi extension

Gets the schema information for an assistant.
getAssistantSubgraph(String assistantId, String namespace) Future<AssistantSubgraph>

Available on LangGraphClient, provided by the AssistantApi extension

Gets a specific subgraph for an assistant.
getLatestAssistantVersion(String assistantId) Future<AssistantVersion>

Available on LangGraphClient, provided by the AssistantApi extension

Gets the latest version of an assistant.
listAssistantSubgraphs(String assistantId) Future<List<String>>

Available on LangGraphClient, provided by the AssistantApi extension

Lists subgraphs for an assistant.
listAssistantVersions(String assistantId) Future<List<AssistantVersion>>

Available on LangGraphClient, provided by the AssistantApi extension

Lists all versions of an assistant.
searchAssistants({Map<String, dynamic>? metadata, String? graphId, int limit = 10, int offset = 0}) Future<List<Assistant>>

Available on LangGraphClient, provided by the AssistantApi extension

Searches for assistants matching the specified criteria.
updateAssistant(String assistantId, {String? graphId, AssistantConfig? config, Map<String, dynamic>? metadata, String? name}) Future<Assistant>

Available on LangGraphClient, provided by the AssistantApi extension

Updates an existing assistant with new properties.