Add AI Search related constants for the bug of AI search tool call info #44474
Conversation
YusakuNo1
requested review from
dargilco,
glharper,
howieleung,
kingernupur,
nick863,
trangevi and
trrwilson
as code owners
There was a problem hiding this comment.
Pull request overview
This PR adds two AI Search-related constants to support parsing AI search responses: AZURE_AI_SEARCH_CALL to the ItemType enum and REMOTE_TOOL to the ToolType enum. These constants will be consumed by internal services and are also useful for users parsing AI search tool call information.
- Adds
AZURE_AI_SEARCH_CALLconstant toItemTypeenum for representing Azure AI Search call item types - Adds
REMOTE_TOOLconstant toToolTypeenum for representing AI Search remote tools
| FABRIC_DATAAGENT_PREVIEW = "fabric_dataagent_preview" | ||
| SHAREPOINT_GROUNDING_PREVIEW = "sharepoint_grounding_preview" | ||
| AZURE_AI_SEARCH = "azure_ai_search" | ||
| REMOTE_TOOL = "remote_tool" # AI Search Remote Tool |
There was a problem hiding this comment.
The inline comment style used here is inconsistent with the documentation patterns used throughout this file. The codebase convention is to use triple-quoted docstrings on a separate line after each enum value when documentation is needed. For example, see lines 384-387 for MemoryItemKind enum values or lines 644-653 for ScheduleProvisioningStatus enum values. Consider either removing the inline comment if the name is self-explanatory, or converting it to a docstring format consistent with the rest of the file.
| WORKFLOW_ACTION = "workflow_action" | ||
| MEMORY_SEARCH_CALL = "memory_search_call" | ||
| OAUTH_CONSENT_REQUEST = "oauth_consent_request" | ||
| AZURE_AI_SEARCH_CALL = "azure_ai_search_call" |
There was a problem hiding this comment.
The PR description checklist indicates that "CHANGELOG is updated for new features, bug fixes or other significant changes," but no changes to the CHANGELOG.md file are included in this PR. Adding new constants to public enums constitutes a feature addition that should be documented in the CHANGELOG with an entry under "Features Added" in the "2.0.0b3 (Unreleased)" section.
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
1 participant
Description
This PR adds 2 constants for AI search, they will be consumed from internal services, but the definitions are useful for people who's trying to parse AI search responses as well
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines