Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Regenerates azure-search-documents models/clients from updated TypeSpec, adding new knowledgebase, MCP server, debug, permission/Purview, and indexer runtime features, plus new service API versions.
Changes:
- Adds/updates many generated model types (knowledgebases, MCP server configuration, new enums, and additional response fields).
- Extends JSON (de)serialization for new response fields (debug info, permissions, sensitivity labels, indexer runtime, etc.).
- Updates
SearchServiceVersionwith new preview versions and changesgetLatest()selection.
Reviewed changes
Copilot reviewed 141 out of 170 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/models/FacetResult.java | Adds additional facet metrics and nested facets deserialization. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/models/DocumentDebugInfo.java | Adds semantic debug info and innerHits deserialization + getters. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/models/DebugInfo.java | Moves DebugInfo into public models package and adds query rewrites debug payload. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/models/ContentUnderstandingSkillChunkingMethod.java | Introduces chunking method enum for Content Understanding skill. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/WorkIQAttribution.java | Adds WorkIQ attribution model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/WebKnowledgeSourceParams.java | Adds new runtime parameters (alwaysQuerySource, failOnError, maxOutputDocuments, enableImageServing). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/SearchIndexKnowledgeSourceParams.java | Adds new runtime parameters (alwaysQuerySource, failOnError, maxOutputDocuments, enableImageServing). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeSourceIngestionParameters.java | Adds assetStore and freshnessPolicy ingestion configuration. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalReasoningEffortKind.java | Adds LOW and MEDIUM reasoning effort kinds. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalReasoningEffort.java | Expands discriminator handling for low/medium reasoning effort subtypes. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalOutputMode.java | Adds output mode enum for knowledge retrieval. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalMinimalReasoningEffort.java | Makes constructor public for minimal reasoning effort subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalMediumReasoningEffort.java | Adds medium reasoning effort subtype model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeRetrievalLowReasoningEffort.java | Adds low reasoning effort subtype model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseWorkIQReference.java | Adds WorkIQ reference subtype for retrieval references. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseSearchIndexReference.java | Adds sensitivity label info to search index references. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseRetrievalResult.java | Adds sensitivity label info for overall response. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseReferenceType.java | Adds new reference types (SharePoint, WorkIQ, Fabric). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseReference.java | Expands discriminator mapping for new reference subtypes. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseMessageTextContent.java | Makes constructor public for message text content. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseMessageImageContent.java | Makes constructor public for message image content. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseMessageContent.java | Makes base message content constructor public. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseMessage.java | Switches to @Fluent and adds role setter. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseIndexedOneLakeReference.java | Adds sensitivity label info to OneLake references. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseImageContent.java | Makes constructor public for image content. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseFabricOntologyReference.java | Adds Fabric Ontology reference subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseAzureBlobReference.java | Adds sensitivity label info to blob references. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseAgenticReasoningActivityRecord.java | Adds warning field serialization and parsing. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseActivityRecordType.java | Adds new activity record types (SharePoint, WorkIQ, Fabric, model activities). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/KnowledgeBaseActivityRecord.java | Adds new discriminator subtypes and warning message field. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/IndexedOneLakeKnowledgeSourceParams.java | Adds new runtime parameters (alwaysQuerySource, failOnError, maxOutputDocuments, enableImageServing). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/FreshnessPolicy.java | Adds freshness-aware retrieval configuration. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/AzureBlobKnowledgeSourceParams.java | Adds new runtime parameters (alwaysQuerySource, failOnError, maxOutputDocuments, enableImageServing). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/models/AssetStore.java | Adds asset store configuration for extracted assets. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/KnowledgeBaseRetrievalClient.java | Updates REST docs/schema comments for new request/response fields and headers. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/knowledgebases/KnowledgeBaseRetrievalAsyncClient.java | Updates REST docs/schema comments for new request/response fields and headers. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/WorkIQKnowledgeSource.java | Adds WorkIQ knowledge source type. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/WebKnowledgeSourceParameters.java | Adds web knowledge source parameters (language/market/count/freshness). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/VectorSearchVectorizer.java | Adds aiServicesVision discriminator mapping. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SplitSkillUnit.java | Adds split skill unit enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SplitSkillEncoderModelName.java | Adds tokenizer encoder model enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SplitSkill.java | Adds split parameters for token-based splitting and tokenizer params. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SemanticConfiguration.java | Adds flightingOptIn configuration. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchServiceStatistics.java | Adds indexersRuntime statistics. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchResourceEncryptionKey.java | Adds isServiceLevelKey support. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerStatus.java | Adds runtime/currentState deserialization + getters. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerSkill.java | Adds discriminator mappings for AML skill and VisionVectorizeSkill. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerKnowledgeStoreParameters.java | Adds knowledge store parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerKnowledgeStore.java | Adds parameters field to knowledge store. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerDataUserAssignedIdentity.java | Makes identity fluent and adds federatedIdentityClientId. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexerDataSourceConnection.java | Adds subType and indexerPermissionOptions. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexer.java | Adds cache configuration support. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexResponse.java | Adds permissionFilterOption and purviewEnabled to index response. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexPermissionFilterOption.java | Adds permission filtering option enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndexKnowledgeSourceParameters.java | Adds baseFilter support. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/SearchIndex.java | Adds permission/purview settings and SharePoint app registration. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/PermissionFilter.java | Adds enum for permission filter field behavior. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerToolInclusionMode.java | Adds MCP tool inclusion mode enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerStoredHeadersParameters.java | Adds MCP stored headers parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerStoredHeadersAuthentication.java | Adds stored-headers authentication subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerSplitOutputParsing.java | Adds split output parsing subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerOutputParsingKind.java | Adds MCP output parsing kind enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerOutputParsingJsonParameters.java | Adds JSON output parsing parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerOutputParsing.java | Adds MCP output parsing base polymorphic model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerNoneOutputParsing.java | Adds “none” output parsing subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerKnowledgeSourceParameters.java | Adds MCP knowledge source parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerJsonOutputParsing.java | Adds JSON output parsing subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerHeaders.java | Adds model for stored HTTP headers map. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerFoundryConnectionParameters.java | Adds Foundry connection auth parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerFoundryConnectionAuthentication.java | Adds Foundry connection authentication subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerAutoOutputParsing.java | Adds auto output parsing subtype. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerAuthenticationKind.java | Adds MCP authentication kind enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/McpServerAuthentication.java | Adds MCP authentication base polymorphic model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/KnowledgeSourceReference.java | Adds enableImageServing/enableFreshness to references. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/KnowledgeSourceKind.java | Adds new knowledge source kinds (SharePoint, SQL, file, MCP, Fabric). |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/KnowledgeSourceIngestionPermissionOption.java | Adds sensitivityLabels ingestion option. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/KnowledgeSource.java | Expands discriminator mapping for new knowledge source subtypes. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexingMode.java | Adds indexer execution mode enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexerPermissionOption.java | Adds indexer permission options enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexerExecutionStatusDetail.java | Adds indexer execution status detail enum. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexerExecutionResult.java | Adds mode/statusDetail fields to execution result. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexedSharePointContainerName.java | Adds enum for selecting SharePoint container scope. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/IndexStatisticsSummary.java | Adds index statistics summary model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/FileKnowledgeSourceParameters.java | Adds file knowledge source parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/FileKnowledgeSource.java | Adds file knowledge source type. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/FabricOntologyKnowledgeSourceParameters.java | Adds Fabric Ontology knowledge source parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/FabricDataAgentKnowledgeSourceParameters.java | Adds Fabric Data Agent knowledge source parameters model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/EmbeddingColumnMapping.java | Adds SQL embedding column mapping model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/ContentUnderstandingSkillChunkingUnit.java | Adds tokens chunking unit. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/ContentUnderstandingSkillChunkingProperties.java | Adds chunking method property support. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/ContentColumnMapping.java | Adds SQL content column mapping model. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/AzureOpenAITokenizerParameters.java | Adds tokenizer parameters model used by SplitSkill. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/AzureOpenAIModelName.java | Adds additional model names. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/indexes/models/AIServicesVisionVectorizer.java | Adds AI Services Vision vectorizer type. |
| sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchServiceVersion.java | Adds preview versions and updates latest selection. |
| sdk/search/azure-search-documents/checkstyle-suppressions.xml | Adds suppression for denylisted words check on MCP knowledge source parameters. |
| public static SearchServiceVersion getLatest() { | ||
| return V2026_04_01; | ||
| return V2026_05_01_PREVIEW; | ||
| } |
There was a problem hiding this comment.
getLatest() now returns a preview service version. In the Azure SDKs, the latest default typically points to the latest GA/stable API to avoid customers accidentally opting into preview behavior. Consider keeping getLatest() returning V2026_04_01 (GA) and, if needed, add a separate helper like getLatestPreview() (or document clearly that preview is the default).
| @Generated | ||
| private McpServerAuthenticationKind kind = McpServerAuthenticationKind.fromString("McpServerAuthentication"); |
There was a problem hiding this comment.
The base polymorphic type initializes kind to a non-schema discriminator value (\"McpServerAuthentication\"), and toJson will emit that value if a caller constructs the base type. This produces invalid payloads. Suggested fix: make the base type non-instantiable (e.g., abstract with protected constructor) and/or default kind to null so it doesn't serialize an invalid discriminator.
| @Override | ||
| public JsonWriter toJson(JsonWriter jsonWriter) throws IOException { | ||
| jsonWriter.writeStartObject(); | ||
| jsonWriter.writeStringField("kind", this.kind == null ? null : this.kind.toString()); |
There was a problem hiding this comment.
The base polymorphic type initializes kind to a non-schema discriminator value (\"McpServerAuthentication\"), and toJson will emit that value if a caller constructs the base type. This produces invalid payloads. Suggested fix: make the base type non-instantiable (e.g., abstract with protected constructor) and/or default kind to null so it doesn't serialize an invalid discriminator.
| * The kind of output parsing to apply. | ||
| */ | ||
| @Generated | ||
| private McpServerOutputParsingKind kind = McpServerOutputParsingKind.fromString("McpServerOutputParsing"); |
There was a problem hiding this comment.
Same issue as McpServerAuthentication: the base polymorphic type defaults kind to an invalid discriminator (\"McpServerOutputParsing\") and serializes it. Making the base type abstract (with a protected constructor) and/or leaving kind as null in the base type would prevent emitting invalid values.
| private McpServerOutputParsingKind kind = McpServerOutputParsingKind.fromString("McpServerOutputParsing"); | |
| private McpServerOutputParsingKind kind; |
| @Override | ||
| public JsonWriter toJson(JsonWriter jsonWriter) throws IOException { | ||
| jsonWriter.writeStartObject(); | ||
| jsonWriter.writeStringField("kind", this.kind == null ? null : this.kind.toString()); |
There was a problem hiding this comment.
Same issue as McpServerAuthentication: the base polymorphic type defaults kind to an invalid discriminator (\"McpServerOutputParsing\") and serializes it. Making the base type abstract (with a protected constructor) and/or leaving kind as null in the base type would prevent emitting invalid values.
| } | ||
|
|
||
| /* | ||
| * The resulting total avg for the facet when a avg metric is requested. |
There was a problem hiding this comment.
Fix article usage in the doc comment: use 'an avg metric' (and similarly 'a min/max/sum/cardinality' should be 'a min/max/sum/cardinality metric' or adjust wording consistently).
| * The resulting total avg for the facet when a avg metric is requested. | |
| * The resulting total avg for the facet when an avg metric is requested. |
| * Get the federatedIdentityClientId property: Multi-tenant User-Assigned Managed Identity Support: The client id of | ||
| * the multi-tentant App that has been configured to federate with the user-assigned managed identity. |
There was a problem hiding this comment.
Correct typo in the Javadoc: 'multi-tentant' should be 'multi-tenant'.
| <suppress files="com.azure.search.documents.implementation.batching.SearchIndexingPublisher.java" checks="io.clientcore.linting.extensions.checkstyle.checks.ThrowFromClientLoggerCheck" /> | ||
| <suppress files="com.azure.search.documents.indexes.models.SearchIndexerKnowledgeStoreProjectionSelector.java" checks="io.clientcore.linting.extensions.checkstyle.checks.SerializableMethodsCheck" /> | ||
| <suppress files="com.azure.search.documents.models.SearchContinuationToken.java" checks="io.clientcore.linting.extensions.checkstyle.checks.SerializableMethodsCheck" /> | ||
| <suppress files="com.azure.search.documents.indexes.models.McpServerKnowledgeSourceParameters.java" checks="io.clientcore.linting.extensions.checkstyle.checks.DenyListedWordsCheck" /> |
There was a problem hiding this comment.
This adds a file-level suppression for DenyListedWordsCheck. If possible, it’s better to fix the offending term(s) in code/Javadoc (or narrow the suppression to the smallest scope possible with a clear rationale) rather than suppressing the rule for the whole file, since this can mask future violations.
| <suppress files="com.azure.search.documents.indexes.models.McpServerKnowledgeSourceParameters.java" checks="io.clientcore.linting.extensions.checkstyle.checks.DenyListedWordsCheck" /> |
| * The URL of the MCP server endpoint. | ||
| */ | ||
| @Generated | ||
| private final String serverURL; |
There was a problem hiding this comment.
The property is modeled as serverURL / getServerURL(), which is inconsistent with common Java naming/JavaBeans conventions (Url vs URL). This can cause awkward ergonomics and tooling/introspection quirks. Consider renaming to serverUrl with accessor getServerUrl() while still serializing to the expected JSON field name via the generator or serialization annotations/mapping.
| public String getServerURL() { | ||
| return this.serverURL; | ||
| } |
There was a problem hiding this comment.
The property is modeled as serverURL / getServerURL(), which is inconsistent with common Java naming/JavaBeans conventions (Url vs URL). This can cause awkward ergonomics and tooling/introspection quirks. Consider renaming to serverUrl with accessor getServerUrl() while still serializing to the expected JSON field name via the generator or serialization annotations/mapping.
Description
Please add an informative description that covers that changes made by the pull request and link all relevant issues.
If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines