Search May 2025 Preview #45293
Merged
Search May 2025 Preview #45293
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a new set of clients and supporting models for interacting with Azure AI Search Knowledge Agents, enabling both synchronous and asynchronous operations. Key changes include the implementation of synchronous (SearchKnowledgeAgentClient) and asynchronous (SearchKnowledgeAgentAsyncClient) clients, the introduction of a fluent builder (SearchKnowledgeAgentClientBuilder), and several supporting model and implementation classes for query planning, message content, error responses, and document references.
Reviewed Changes
Copilot reviewed 83 out of 83 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| KnowledgeAgentModelQueryPlanningActivityRecord.java | New model for query planning activity records with JSON (de)serialization. |
| KnowledgeAgentMessageTextContent.java | Implementation of text content for knowledge agent messages. |
| KnowledgeAgentMessageImageContentImage.java | Model for encapsulating image content in messages. |
| KnowledgeAgentMessageImageContent.java | Model linking image content with message content type. |
| KnowledgeAgentMessageContentType.java | Definition of expandable message content types (text/image). |
| KnowledgeAgentMessageContent.java | Base class for message content with JSON (de)serialization. |
| KnowledgeAgentMessage.java | Model for the overall message composed of one or more content parts. |
| KnowledgeAgentIndexParams.java | Model for specifying index parameters with JSON (de)serialization support. |
| KnowledgeAgentAzureSearchDocReference.java | Model for Azure Search document references including additional source data. |
| KnowledgeAgentActivityRecord.java | Base class for activity records with common JSON (de)serialization logic. |
| ErrorResponseException.java | Custom exception encapsulating error response details. |
| ErrorResponse.java | Model for error responses which embeds error details. |
| ErrorDetail.java | Model capturing detailed error information (code, message, target, etc.). |
| ErrorAdditionalInfo.java | Model for any additional error information. |
| KnowledgeRetrievalsImpl.java | Implementation class for executing retrieval operations via REST proxy calls. |
| KnowledgeAgentRetrievalClientImpl.java | Low-level client implementation used by the public client classes. |
| SearchKnowledgeAgentClientBuilder.java | Fluent builder for constructing both synchronous and asynchronous clients. |
| SearchKnowledgeAgentClient.java | Synchronous client exposing retrieval APIs for Azure AI Search agents. |
| SearchKnowledgeAgentAsyncClient.java | Asynchronous client exposing retrieval APIs for Azure AI Search agents. |
...ure-search-documents/src/main/java/com/azure/search/documents/agents/models/ErrorDetail.java
Show resolved
Hide resolved
...ch-documents/src/main/java/com/azure/search/documents/agents/models/ErrorAdditionalInfo.java
Show resolved
Hide resolved
...cuments/src/main/java/com/azure/search/documents/agents/SearchKnowledgeAgentAsyncClient.java
Outdated
Show resolved
Hide resolved
...ments/src/main/java/com/azure/search/documents/agents/SearchKnowledgeAgentClientBuilder.java
Show resolved
Hide resolved
...ments/src/main/java/com/azure/search/documents/agents/SearchKnowledgeAgentClientBuilder.java
Outdated
Show resolved
Hide resolved
...ments/src/main/java/com/azure/search/documents/agents/SearchKnowledgeAgentClientBuilder.java
Outdated
Show resolved
Hide resolved
...ch-documents/src/main/java/com/azure/search/documents/agents/models/ErrorAdditionalInfo.java
Show resolved
Hide resolved
...e-search-documents/src/main/java/com/azure/search/documents/agents/models/ErrorResponse.java
Show resolved
Hide resolved
...documents/src/main/java/com/azure/search/documents/agents/models/ErrorResponseException.java
Show resolved
Hide resolved
...-search-documents/src/main/java/com/azure/search/documents/agents/models/RequestOptions.java
Show resolved
Hide resolved
...re-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchField.java
Show resolved
Hide resolved
...nts/src/main/java/com/azure/search/documents/indexes/implementation/KnowledgeAgentsImpl.java
Show resolved
Hide resolved
…ch/documents/agents/SearchKnowledgeAgentAsyncClient.java Co-authored-by: Alan Zimmer <[email protected]>
…com/Azure/azure-sdk-for-java into jairmyree/search/2025-05-01-preview
… parameter and set it to null by default; add permissionFilter to SearchableField annotation.
- Added methods to create, update, retrieve, and delete Knowledge Agents in SearchIndexAsyncClient and SearchIndexClient. - Introduced support for query source authorization in SearchClient methods for document retrieval and search operations. - Updated SearchResult and SemanticSearchResult classes to include reranker boosted score for enhanced search relevance. - Improved documentation with code samples for new methods and parameters. - Refactored SearchResultHelper and SearchResultConverter to accommodate new semantic search features. - Fixed formatting and code style issues across various classes for better readability. - Enhanced error handling in Knowledge Agent operations to ensure robust API interactions.
Member
|
Need one last update to add |
…ng and improve documentation; add suppressions for missing Javadoc methods.
Contributor
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
alzimmermsft
approved these changes
May 16, 2025
Member
alzimmermsft
left a comment
alzimmermsft
left a comment
There was a problem hiding this comment.
API looks good aside SearchServiceVersion needing to be updated.
jairmyree
requested review from
Netyyyy,
conniey,
g2vinay,
moarychan,
rujche,
saragluna and
srnagar
as code owners
Member
Author
|
/check-enforcer override |
alzimmermsft
approved these changes
May 19, 2025
Member
|
/check-enforcer override |
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.
Search May 2025 Preview
Preview Information: https://gist.github.com/alzimmermsft/d1dfe89635384c0498ec222afb6295f3
Closes #45141
This pull request introduces a new set of clients and a builder for interacting with Azure AI Search Knowledge Agents, enabling both synchronous and asynchronous operations. It includes the implementation of
SearchKnowledgeAgentClient,SearchKnowledgeAgentAsyncClient, andSearchKnowledgeAgentClientBuilder, providing a comprehensive API for knowledge retrieval from various backing stores.New Client Implementations:
Asynchronous Client:
SearchKnowledgeAgentAsyncClient, which provides asynchronous APIs for retrieving knowledge from Azure AI Search Knowledge Agents. It supports operations likeretrieveandretrieveWithResponsefor fetching data from multiple sources.Synchronous Client:
SearchKnowledgeAgentClient, which offers synchronous APIs for similar operations as the asynchronous client. It includes methods forretrieveandretrieveWithResponseas well.Client Builder:
SearchKnowledgeAgentClientBuilderto configure and instantiate both synchronous and asynchronous clients. The builder supports setting up credentials (API key or token-based), endpoint, agent name, API version, and other client options like retry policies and HTTP pipeline customization.