-
Notifications
You must be signed in to change notification settings - Fork 4
fix: rename BasicAgent to BuiltInAgent and add deprecation #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,9 +62,9 @@ export type OverridableProperty = | |
| | "prompt"; | ||
|
|
||
| /** | ||
| * Supported model identifiers for BasicAgent | ||
| * Supported model identifiers for BuiltInAgent | ||
| */ | ||
| export type BasicAgentModel = | ||
| export type BuiltInAgentModel = | ||
| // OpenAI models | ||
| | "openai/gpt-5" | ||
| | "openai/gpt-5-mini" | ||
|
|
@@ -205,7 +205,7 @@ export function resolveModel(spec: ModelSpecifier): LanguageModel { | |
| } | ||
|
|
||
| /** | ||
| * Tool definition for BasicAgent | ||
| * Tool definition for BuiltInAgent | ||
| */ | ||
| export interface ToolDefinition<TParameters extends z.ZodTypeAny = z.ZodTypeAny> { | ||
| name: string; | ||
|
|
@@ -215,7 +215,7 @@ export interface ToolDefinition<TParameters extends z.ZodTypeAny = z.ZodTypeAny> | |
| } | ||
|
|
||
| /** | ||
| * Define a tool for use with BasicAgent | ||
| * Define a tool for use with BuiltInAgent | ||
| * @param name - The name of the tool | ||
| * @param description - Description of what the tool does | ||
| * @param parameters - Zod schema for the tool's input parameters | ||
|
|
@@ -423,13 +423,13 @@ export function convertToolDefinitionsToVercelAITools(tools: ToolDefinition[]): | |
| } | ||
|
|
||
| /** | ||
| * Configuration for BasicAgent | ||
| * Configuration for BuiltInAgent | ||
| */ | ||
| export interface BasicAgentConfiguration { | ||
| export interface BuiltInAgentConfiguration { | ||
| /** | ||
| * The model to use | ||
| */ | ||
| model: BasicAgentModel | LanguageModel; | ||
| model: BuiltInAgentModel | LanguageModel; | ||
| /** | ||
| * Maximum number of steps/iterations for tool calling (default: 1) | ||
| */ | ||
|
|
@@ -492,10 +492,10 @@ export interface BasicAgentConfiguration { | |
| tools?: ToolDefinition[]; | ||
| } | ||
|
|
||
| export class BasicAgent extends AbstractAgent { | ||
| export class BuiltInAgent extends AbstractAgent { | ||
| private abortController?: AbortController; | ||
|
|
||
| constructor(private config: BasicAgentConfiguration) { | ||
| constructor(private config: BuiltInAgentConfiguration) { | ||
| super(); | ||
| } | ||
|
|
||
|
|
@@ -976,10 +976,20 @@ export class BasicAgent extends AbstractAgent { | |
| } | ||
|
|
||
| clone() { | ||
| return new BasicAgent(this.config); | ||
| return new BuiltInAgent(this.config); | ||
| } | ||
|
|
||
| abortRun(): void { | ||
| this.abortController?.abort(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @deprecated Use BuiltInAgent instead | ||
| */ | ||
| export class BasicAgent extends BuiltInAgent { | ||
| constructor(config: BuiltInAgentConfiguration) { | ||
| super(config); | ||
| console.warn("BasicAgent is deprecated, use BuiltInAgent instead"); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice, this is a clean way to do this. |
||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add the import path path on a newline as well please?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's exactly the same path in this case