use new typespec and rename assistantId to agentID #33350
Closed
Conversation
This file contains 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
bobogogo1990
requested review from
bterlson,
a team,
ganeshyb and
GraceBrigham
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR systematically renames every occurrence of "assistantId" to "agentsID" in the ai-projects package and updates associated typespecs. The changes span API definitions, client calls, conversion functions, and tests.
- Renamed the parameter, property, and variable names from "assistantId" to "agentsID" in multiple files.
- Updated types and conversion functions to handle the new identifier.
- Adjusted related inline documentation and error messages where applicable.
Reviewed Changes
Copilot reviewed 21 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/ai/ai-projects/review/ai-projects.api.md | Updated interface definitions to use the new identifier. |
| sdk/ai/ai-projects/src/agents/customModels.ts | Renamed helper types to use the new identifier. |
| sdk/ai/ai-projects/src/agents/index.ts | Updated API operations in client functions to reflect changes. |
| sdk/ai/ai-projects/src/agents/assistants.ts | Modified parameter names and endpoint paths along with validation error texts. |
| sdk/ai/ai-projects/src/customization/outputModels.ts | Changed model properties from "assistantId" to "agentsID". |
| sdk/ai/ai-projects/src/agents/runs.ts | Revised functions to use the new parameter name consistently. |
| sdk/ai/ai-projects/test/public/agents/streaming.spec.ts | Adjusted log statements to match updated model properties. |
| sdk/ai/ai-projects/src/customization/convertModelsToWrite.ts | Updated conversion functions for write operations to use the new name. |
| sdk/ai/ai-projects/src/customization/models.ts | Altered model definitions to reflect the new identifier naming. |
Comments suppressed due to low confidence (2)
sdk/ai/ai-projects/review/ai-projects.api.md:115
- [nitpick] The PR title indicates renaming to 'agentID' but the code uses 'agentsID'. Consider aligning the naming to avoid confusion.
createRun: (threadId: string, agentsID: string, options?: CreateRunOptionalParams) => AgentRunResponse;
sdk/ai/ai-projects/src/agents/assistants.ts:267
- [nitpick] The error message still references 'Assistant ID' while the parameter is now 'agentsID'. Update the error message to align with the new naming, for example, 'Agent ID is required'.
throw new Error("Assistant ID is required");
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
ganeshyb
reviewed
Mar 12, 2025
| @@ -112,21 +112,21 @@ export interface AgentsOperations { | |||
| cancelVectorStoreFileBatch: (vectorStoreId: string, batchId: string, options?: CancelVectorStoreFileBatchOptionalParams) => Promise<VectorStoreFileBatchOutput>; | |||
| createAgent: (model: string, options?: CreateAgentOptionalParams) => Promise<AgentOutput>; | |||
| createMessage: (threadId: string, messageOptions: ThreadMessageOptions, options?: CreateMessageOptionalParams) => Promise<ThreadMessageOutput>; | |||
| createRun: (threadId: string, assistantId: string, options?: CreateRunOptionalParams) => AgentRunResponse; | |||
| createRun: (threadId: string, agentsID: string, options?: CreateRunOptionalParams) => AgentRunResponse; | |||
There was a problem hiding this comment.
curios why its agentsID instead of agentId ?
dargilco
approved these changes
Mar 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Packages impacted by this PR
rename assistantId to agentID in the
ai-projectspackage.Issues associated with this PR
this is a breaking change.
Describe the problem that is addressed by this PR
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
Provide a list of related PRs (if any)
Command used to generate this PR:**(Applicable only to SDK release request PRs)
Checklists