Idickers/2025-11-01-preview-sdk-gen-java (Azure#47057)

* Autorest generated code and some changes

* breaking change fixes

* autorest regeneration with most recent SHA+ updated knowledgebases namespace

* Clean state before full Agent→Base replacement

* KA -> KB rename completed

* clean build after fixing errors from KA->KB rename

* Adress some PR comments, need to regenerate searchservice to delete incorrectly placed files

* regen of searchservice.json

* changes made to all confirmed PR comments

* remove unnecessary change in readme

* update CHANGELOG.md

* deleted KnowledgeAgentTests, added clientbuilder files, removed mention of classes used by KBTests that were deleted by swagger

* First tests

* spotless cleanup

* commit before regen with newest hash

* commit after autorest regeneration with latest hash

* update latest preview version to 2025-11-01

* regen and rebuild to push changes to pipeline

* update old preview version used in compatability tests

* rebuild for pipeline

* add some tests for review

* commit before deploying to stamp

* tests done and verified

* PR comment changes

* resolve conflicts

* add remote sharepoint tests

* add reasoning effort

* last minute changes

* updated assets

* fix cspell error

* fix failed checks

* re-record all tests

* last generation

* fix tests and run linting suppression

* fix tests and add apackage-info to knowledgebases

* fix minor syntax error

* address checkstyle issue

* address checkstyle issue

---------

Co-authored-by: Robert Lee <[email protected]>

Author: idickerson7

sdk/search/azure-search-documents/CHANGELOG.md

@@ -1,13 +1,37 @@
 # Release History
 
-## 11.9.0-beta.1 (Unreleased)
+## 11.9.0-beta.1 (2025-11-17)
 
 ### Features Added
 
 - Added back all service preview features dropped in `2025-09-01` service version release.
+- Added optional parameter `x-ms-enable-elevated-read` for elevated read access that bypasses document-level permission checks.
+- Added statistical aggregation properties to `FacetResult`: `avg`, `min`, `max`, and `cardinality` for enhanced analytics.
+- Added support for new Azure OpenAI models: `gpt-5`, `gpt-5-mini`, and `gpt-5-nano`.
+- Added support for `sharepoint` data source type in `SearchIndexerDataSourceType`.
+- Added support for new `KnowledgeSourceKind` types: `web`, `remoteSharePoint`, `indexedSharePoint`, and `indexedOneLake`.
+- Added `purviewEnabled` property to `SearchIndex` for Microsoft Purview integration.
+- Added `maxCumulativeIndexerRuntimeSeconds` property to `ServiceLimits` for runtime monitoring.
+- Added required `runtime` property to `SearchIndexerStatus` and `indexersRuntime` property to `ServiceStatistics`.
+- Added `product` enum value to `ScoringFunctionAggregation`.
+- Added enhanced knowledge source parameters: `sourceDataFields`, `searchFields`, `semanticConfigurationName` in `SearchIndexKnowledgeSourceParameters`.
+- Added Azure Data Lake Storage Gen2 support with `isADLSGen2` and `ingestionParameters` in `AzureBlobKnowledgeSourceParameters`.
+- Added partial content response support (HTTP 206) for knowledge base operations.
+- Added `error` property to `KnowledgeBaseActivityRecord` for enhanced error handling.
+- Added enhanced knowledge source parameters: `includeReferences`, `includeReferenceSourceData`, `alwaysQuerySource`, `rerankerThreshold` in `SearchIndexKnowledgeSourceParams`.
 
 ### Breaking Changes
 
+- **Knowledge Agent to Knowledge Base Migration**: Complete API rename from Knowledge Agent to Knowledge Base.
+  - All `KnowledgeAgent*` classes renamed to `KnowledgeBase*` (e.g., `KnowledgeAgent` → `KnowledgeBase`).
+  - API paths changed from `/agents` to `/knowledgebases`.
+  - Client parameter `AgentNameParameter` renamed to `KnowledgeBaseNameParameter`.
+  - All agent-related activity record types updated with new naming convention
+- Removed deprecated Knowledge Agent classes: `KnowledgeAgentOutputConfiguration`, `KnowledgeAgentRequestLimits`, `KnowledgeAgentModel`, `KnowledgeAgentModelKind`, `KnowledgeAgentAzureOpenAIModel`.
+- Removed properties from `KnowledgeSourceReference`:`includeReferences`,`includeReferenceSourceData`,`alwaysQuerySource`,`maxSubQueries`,`rerankerThreshold`
+- Removed `sourceDataSelect` property from `SearchIndexKnowledgeSourceParameters`.
+- Removed properties from `AzureBlobKnowledgeSourceParameters`: `identity`, `embeddingModel`, `chatCompletionModel`, `ingestionSchedule`, `disableImageVerbalization`.
+
 - Updated `RescoringOptions` to match what was changed in `11.8.0` release.
     - `isEnableRescoring` -> `isRescoringEnabled`
     - `setEnableRescoring` -> `setRescoringEnabled`
@@ -200,7 +224,7 @@ enabling multi-index grounding for agentic retrieval.
 - `QueryCaption` now supports a `maxCharLength` option to limit the character length of the caption.
 - `VectorizableTextQuery` now supports a `queryRewrites` option to specify the number query rewrites the service will generate.
 - `SemanticSearchOptions` now supports a `queryRewrites` option to specify the number query rewrites the service will generate.
-- `VectorSearchCompression` now supports configuring the `rescoringOptoins`.
+- `VectorSearchCompression` now supports configuring the `rescoringOptions`.
 - `IndexingParametersConfiguration` now supports two additional options for `MarkdownParsingSubmode` and `MarkdownHeaderDepth`.
 - Added a new skill: `DocumentIntelligenceLayoutSkill` that extracts content and layout information (as markdown), via Azure AI Services, from files within the enrichment pipeline.
 - Added 2 subtypes of `CognitiveServiceAccounts`: `AzureCognitiveServiceAccount` and `AzureCognitiveServiceAccountKey`.

sdk/search/azure-search-documents/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/search/azure-search-documents",
-  "Tag": "java/search/azure-search-documents_b2580498bd"
+  "Tag": "java/search/azure-search-documents_3eb1fda9ef"
 }

sdk/search/azure-search-documents/checkstyle-suppressions.xml

@@ -3,6 +3,7 @@
 <!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. -->
 
 <suppressions>
+  <suppress files="com.azure.search.documents.knowledgebases.SearchKnowledgeBaseAsyncClient.java" checks="JavadocPackageCheck" />
   <suppress files="com.azure.search.documents.test.environment.models.Book.java" checks="MemberNameCheck" />
   <suppress files="com.azure.search.documents.test.environment.models.LoudHotel.java" checks="MemberNameCheck" />
   <suppress files="com.azure.search.documents.test.environment.models.Book.java" checks="MethodNameCheck" />

sdk/search/azure-search-documents/spotbugs-exclude.xml

@@ -2,9 +2,18 @@
 
 <FindBugsFilter xmlns="https://github.com/spotbugs/filter/3.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd">
+  <Match>
+    <Bug pattern="BC_VACUOUS_INSTANCEOF" />
+    <Class name="com.azure.search.documents.KnowledgeSourceTests" />
+  </Match>
+  <Match>
+    <Bug pattern="DCN_NULLPOINTER_EXCEPTION" />
+    <Class name="com.azure.search.documents.KnowledgeSourceTests" />
+  </Match>
   <Match>
     <Bug pattern="DLS_DEAD_LOCAL_STORE" />
     <Or>
+      <Class name="com.azure.search.documents.KnowledgeSourceTests" />
       <Class name="com.azure.search.documents.ReadmeSamples" />
       <Class name="com.azure.search.documents.SearchJavaDocCodeSnippets" />
     </Or>
@@ -17,6 +26,17 @@
       <Class name="com.azure.search.documents.indexes.SearchIndexerClientBuilderTests" />
     </Or>
   </Match>
+  <Match>
+    <Bug pattern="DM_DEFAULT_ENCODING" />
+    <Class name="com.azure.search.documents.KnowledgeSourceTests" />
+  </Match>
+  <Match>
+    <Bug pattern="EC_UNRELATED_TYPES" />
+    <Or>
+      <Class name="com.azure.search.documents.KnowledgeSourceTests" />
+      <Class name="com.azure.search.documents.indexes.SkillsetManagementTests" />
+    </Or>
+  </Match>
   <Match>
     <Bug pattern="EI_EXPOSE_STATIC_REP2" />
     <Or>
@@ -36,6 +56,10 @@
       <Class name="com.azure.search.documents.indexes.SearchIndexerClientBuilderTests" />
     </Or>
   </Match>
+  <Match>
+    <Bug pattern="UC_USELESS_OBJECT" />
+    <Class name="com.azure.search.documents.indexes.SkillsetManagementTests" />
+  </Match>
   <Match>
     <Bug pattern="UWF_UNWRITTEN_FIELD" />
     <Class name="com.azure.search.documents.test.environment.models.HotelWithUnsupportedField" />

sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchAsyncClient.java

@@ -28,6 +28,7 @@
 import com.azure.search.documents.implementation.util.Utility;
 import com.azure.search.documents.indexes.models.IndexDocumentsBatch;
 import com.azure.search.documents.models.AutocompleteOptions;
+import com.azure.search.documents.models.GetDocumentOptions;
 import com.azure.search.documents.models.IndexAction;
 import com.azure.search.documents.models.IndexActionType;
 import com.azure.search.documents.models.IndexBatchException;
@@ -55,6 +56,7 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
@@ -858,7 +860,7 @@ Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocumentsBa
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<T> getDocument(String key, Class<T> modelClass) {
-        return getDocumentWithResponse(key, modelClass, null, null).map(Response::getValue);
+        return getDocumentWithResponse(key, modelClass, (List<String>) null, (String) null).map(Response::getValue);
     }
 
     /**
@@ -893,7 +895,8 @@ public <T> Mono<T> getDocument(String key, Class<T> modelClass) {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<T> getDocument(String key, Class<T> modelClass, String querySourceAuthorization) {
-        return getDocumentWithResponse(key, modelClass, null, querySourceAuthorization).map(Response::getValue);
+        return getDocumentWithResponse(key, modelClass, (List<String>) null, querySourceAuthorization)
+            .map(Response::getValue);
     }
 
     /**
@@ -929,7 +932,8 @@ public <T> Mono<T> getDocument(String key, Class<T> modelClass, String querySour
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<Response<T>> getDocumentWithResponse(String key, Class<T> modelClass, List<String> selectedFields) {
-        return withContext(context -> getDocumentWithResponse(key, modelClass, selectedFields, null, context));
+        return withContext(
+            context -> getDocumentWithResponseInternal(key, modelClass, selectedFields, null, null, context));
     }
 
     /**
@@ -968,15 +972,44 @@ public <T> Mono<Response<T>> getDocumentWithResponse(String key, Class<T> modelC
     @ServiceMethod(returns = ReturnType.SINGLE)
     public <T> Mono<Response<T>> getDocumentWithResponse(String key, Class<T> modelClass, List<String> selectedFields,
         String querySourceAuthorization) {
-        return withContext(
-            context -> getDocumentWithResponse(key, modelClass, selectedFields, querySourceAuthorization, context));
+        return withContext(context -> getDocumentWithResponseInternal(key, modelClass, selectedFields,
+            querySourceAuthorization, null, context));
+    }
+
+    /**
+     * Retrieves a document from the Azure AI Search index.
+     * <p>
+     * View <a href="https://docs.microsoft.com/rest/api/searchservice/Naming-rules">naming rules</a> for guidelines on
+     * constructing valid document keys.
+     *
+     * @param options Additional options for retrieving the document.
+     * @param <T> Convert document to the generic type.
+     * @return response containing a document object
+     * @throws NullPointerException If {@code options} is null.
+     * @see <a href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document">Lookup document</a>
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public <T> Mono<Response<T>> getDocumentWithResponse(GetDocumentOptions<T> options) {
+        return withContext(context -> getDocumentWithResponse(options, context));
+    }
+
+    <T> Mono<Response<T>> getDocumentWithResponse(GetDocumentOptions<T> options, Context context) {
+        Objects.requireNonNull(options, "'options' cannot be null.");
+        return getDocumentWithResponseInternal(options.getKey(), options.getModelClass(), options.getSelectedFields(),
+            null, options.isElevatedReadEnabled(), context);
     }
 
     <T> Mono<Response<T>> getDocumentWithResponse(String key, Class<T> modelClass, List<String> selectedFields,
         String querySourceAuthorization, Context context) {
+        return getDocumentWithResponseInternal(key, modelClass, selectedFields, querySourceAuthorization, null,
+            context);
+    }
+
+    <T> Mono<Response<T>> getDocumentWithResponseInternal(String key, Class<T> modelClass, List<String> selectedFields,
+        String querySourceAuthorization, Boolean enableElevatedRead, Context context) {
         try {
             return restClient.getDocuments()
-                .getWithResponseAsync(key, selectedFields, querySourceAuthorization, null, context)
+                .getWithResponseAsync(key, selectedFields, querySourceAuthorization, enableElevatedRead, null, context)
                 .onErrorMap(Utility::exceptionMapper)
                 .map(res -> new SimpleResponse<>(res, serializer
                     .deserializeFromBytes(serializer.serializeToBytes(res.getValue()), createInstance(modelClass))));
@@ -1259,8 +1292,9 @@ public SearchPagedFlux search(String searchText, SearchOptions searchOptions, St
         // The firstPageResponse shared among all functional calls below.
         // Do not initial new instance directly in func call.
         final SearchFirstPageResponseWrapper firstPageResponse = new SearchFirstPageResponseWrapper();
-        Function<String, Mono<SearchPagedResponse>> func = continuationToken -> withContext(
-            context -> search(request, continuationToken, firstPageResponse, querySourceAuthorization, context));
+        Boolean enableElevatedRead = (searchOptions != null) ? searchOptions.isElevatedReadEnabled() : null;
+        Function<String, Mono<SearchPagedResponse>> func = continuationToken -> withContext(context -> search(request,
+            continuationToken, firstPageResponse, querySourceAuthorization, enableElevatedRead, context));
         return new SearchPagedFlux(() -> func.apply(null), func);
     }
 
@@ -1269,20 +1303,22 @@ SearchPagedFlux search(String searchText, SearchOptions searchOptions, String qu
         SearchRequest request = createSearchRequest(searchText, searchOptions);
         // The firstPageResponse shared among all functional calls below.
         // Do not initial new instance directly in func call.
+        Boolean enableElevatedRead = (searchOptions != null) ? searchOptions.isElevatedReadEnabled() : null;
         final SearchFirstPageResponseWrapper firstPageResponseWrapper = new SearchFirstPageResponseWrapper();
         Function<String, Mono<SearchPagedResponse>> func = continuationToken -> search(request, continuationToken,
-            firstPageResponseWrapper, querySourceAuthorization, context);
+            firstPageResponseWrapper, querySourceAuthorization, enableElevatedRead, context);
         return new SearchPagedFlux(() -> func.apply(null), func);
     }
 
     private Mono<SearchPagedResponse> search(SearchRequest request, String continuationToken,
-        SearchFirstPageResponseWrapper firstPageResponseWrapper, String querySourceAuthorization, Context context) {
+        SearchFirstPageResponseWrapper firstPageResponseWrapper, String querySourceAuthorization,
+        Boolean enableElevatedRead, Context context) {
         SearchRequest requestToUse = (continuationToken == null)
             ? request
             : SearchContinuationToken.deserializeToken(serviceVersion.getVersion(), continuationToken);
 
         return restClient.getDocuments()
-            .searchPostWithResponseAsync(requestToUse, querySourceAuthorization, null, context)
+            .searchPostWithResponseAsync(requestToUse, querySourceAuthorization, enableElevatedRead, null, context)
             .onErrorMap(MappingUtils::exceptionMapper)
             .map(response -> {
                 SearchPagedResponse page = mapToSearchPagedResponse(response, serializer, serviceVersion);