Skip to content

Commit 70968d0

Browse files
idickerson7idickerson7
committed
new SHA regen and skill file changes
1 parent eec1a35 commit 70968d0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+3131
-56
lines changed

‎sdk/search/azure-search-documents/.github/skills/Azure.Search.Documents/references/architecture.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ sdk/search/azure-search-documents/
4040

4141
## Source Layout (`src/main/java/`)
4242

43-
Unlike .NET which separates `Generated/` and custom partial-class files, **Java has no partial classes**. All generated code is emitted directly into the package folders. Generated files are identified by the header comment `// Code generated by Microsoft (R) TypeSpec Code Generator.` and `@Generated` annotations on members.
4443

4544
Post-generation modifications are applied via `SearchCustomizations.java` (JavaParser AST manipulation at code-generation time), not by editing generated files.
4645

@@ -158,9 +157,7 @@ tsp-client update
158157

159158
> **Rule**: Never hand-edit generated files (files with `// Code generated by Microsoft (R) TypeSpec Code Generator.` header). All post-generation modifications must go into `customizations/src/main/java/SearchCustomizations.java`.
160159
161-
### Generated vs. Custom (no partial classes in Java)
162-
163-
Java does not have partial classes. Instead, the SDK uses two mechanisms for customization:
160+
The SDK uses two mechanisms for customization:
164161

165162
| Mechanism | Where | When to use |
166163
|---|---|---|
@@ -173,7 +170,6 @@ The `SearchCustomizations.java` file runs during code generation and manipulates
173170
- Add new enum constants
174171
- Modify method bodies
175172

176-
**Important distinction from .NET**: In .NET, custom code lives in separate partial-class files alongside `Generated/`. In Java, customizations are applied as AST transformations that **modify the generated files in-place** during the generation step. The result is a single file per class, not a split.
177173

178174
---
179175

‎sdk/search/azure-search-documents/.github/skills/Azure.Search.Documents/references/customizations.md‎

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ For TypeSpec-level customizations (preferred when possible), see [TypeSpec Clien
3232

3333
### How Java customizations work
3434

35-
Java does **not** have partial classes. The .NET SDK uses `partial class` + attributes (`[CodeGenType]`, `[CodeGenMember]`, `[CodeGenSuppress]`) to extend generated code. **None of these concepts exist in Java.**
36-
37-
Instead, Java uses **`SearchCustomizations.java`** in `customizations/src/main/java/`. This file:
35+
Java uses **`SearchCustomizations.java`** in `customizations/src/main/java/`. This file:
3836
1. Extends `com.azure.autorest.customization.Customization` (package name is a legacy artifact — the tool works with **TypeSpec**, not AutoRest)
3937
2. Overrides `customize(LibraryCustomization, Logger)`
4038
3. Uses the `LibraryCustomization` → `PackageCustomization` → `ClassCustomization` API
@@ -551,27 +549,6 @@ Debug by inspecting the generated file after customization is applied. The custo
551549

552550
---
553551

554-
## Differences from .NET Customizations
555-
556-
If you are familiar with the .NET SDK's customization approach, here are the key differences:
557-
558-
| .NET approach | Java approach |
559-
|---|---|
560-
| `partial class` — split type across multiple files | Not available in Java; single file per class |
561-
| `[CodeGenType("Old")]` — rename a type | TypeSpec `@@clientName` or AST rename in `SearchCustomizations.java` |
562-
| `[CodeGenMember("Old")]` — rename a property | TypeSpec `@@clientName` or AST manipulation |
563-
| `[CodeGenSuppress("Member")]` — suppress a member | AST manipulation to remove or hide the member |
564-
| `[CodeGenSerialization]` — custom JSON key | Not available; use TypeSpec `@@encodedName` or `@JsonProperty` |
565-
| `[EditorBrowsable(Never)]` — hide from IntelliSense | Not available in Java; use `@Deprecated` or make package-private |
566-
| `[ForwardsClientCalls]` — forwarding overloads | No equivalent; manually add convenience methods |
567-
| `SearchModelFactory` — test/mock factory | Not used in Java SDK |
568-
| `ApiCompatBaseline.txt` — API compat suppressions | Not used in Java SDK |
569-
| `api/*.cs` — public API snapshots | Not used in Java SDK |
570-
| `dotnet build` | `mvn clean compile` |
571-
| `dotnet test` | `mvn test` |
572-
| `Export-API.ps1` | No equivalent |
573-
574-
---
575552

576553
## Quick-Reference Checklist: After a Regeneration
577554

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,11 @@ public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocu
407407
* exhaustive: Boolean (Optional)
408408
* oversampling: Double (Optional)
409409
* weight: Float (Optional)
410+
* threshold (Optional): {
411+
* kind: String(vectorSimilarity/searchScore) (Required)
412+
* }
413+
* filterOverride: String (Optional)
414+
* perDocumentVectorLimit: Integer (Optional)
410415
* }
411416
* ]
412417
* vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
@@ -425,6 +430,16 @@ public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocu
425430
* String (Required): [
426431
* (Required){
427432
* count: Long (Optional)
433+
* avg: Double (Optional)
434+
* min: Double (Optional)
435+
* max: Double (Optional)
436+
* sum: Double (Optional)
437+
* cardinality: Long (Optional)
438+
* &#64;search.facets (Optional): {
439+
* String (Required): [
440+
* (recursive schema, see above)
441+
* ]
442+
* }
428443
* (Optional): {
429444
* String: Object (Required)
430445
* }
@@ -442,6 +457,8 @@ public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocu
442457
* }
443458
* }
444459
* ]
460+
* &#64;search.debug (Optional): {
461+
* }
445462
* &#64;search.nextPageParameters (Optional): {
446463
* count: Boolean (Optional)
447464
* facets (Optional): [
@@ -489,6 +506,11 @@ public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocu
489506
* exhaustive: Boolean (Optional)
490507
* oversampling: Double (Optional)
491508
* weight: Float (Optional)
509+
* threshold (Optional): {
510+
* kind: String(vectorSimilarity/searchScore) (Required)
511+
* }
512+
* filterOverride: String (Optional)
513+
* perDocumentVectorLimit: Integer (Optional)
492514
* }
493515
* ]
494516
* vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
@@ -529,6 +551,18 @@ public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocu
529551
* documentBoost: Double (Optional)
530552
* }
531553
* }
554+
* innerHits (Optional): {
555+
* String (Required): [
556+
* (Required){
557+
* ordinal: Long (Optional)
558+
* vectors (Optional): [
559+
* (Optional){
560+
* String (Required): (recursive schema, see String above)
561+
* }
562+
* ]
563+
* }
564+
* ]
565+
* }
532566
* }
533567
* (Optional): {
534568
* String: Object (Required)

‎sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchClient.java‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,11 @@ public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsB
408408
* exhaustive: Boolean (Optional)
409409
* oversampling: Double (Optional)
410410
* weight: Float (Optional)
411+
* threshold (Optional): {
412+
* kind: String(vectorSimilarity/searchScore) (Required)
413+
* }
414+
* filterOverride: String (Optional)
415+
* perDocumentVectorLimit: Integer (Optional)
411416
* }
412417
* ]
413418
* vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
@@ -426,6 +431,16 @@ public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsB
426431
* String (Required): [
427432
* (Required){
428433
* count: Long (Optional)
434+
* avg: Double (Optional)
435+
* min: Double (Optional)
436+
* max: Double (Optional)
437+
* sum: Double (Optional)
438+
* cardinality: Long (Optional)
439+
* &#64;search.facets (Optional): {
440+
* String (Required): [
441+
* (recursive schema, see above)
442+
* ]
443+
* }
429444
* (Optional): {
430445
* String: Object (Required)
431446
* }
@@ -443,6 +458,8 @@ public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsB
443458
* }
444459
* }
445460
* ]
461+
* &#64;search.debug (Optional): {
462+
* }
446463
* &#64;search.nextPageParameters (Optional): {
447464
* count: Boolean (Optional)
448465
* facets (Optional): [
@@ -490,6 +507,11 @@ public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsB
490507
* exhaustive: Boolean (Optional)
491508
* oversampling: Double (Optional)
492509
* weight: Float (Optional)
510+
* threshold (Optional): {
511+
* kind: String(vectorSimilarity/searchScore) (Required)
512+
* }
513+
* filterOverride: String (Optional)
514+
* perDocumentVectorLimit: Integer (Optional)
493515
* }
494516
* ]
495517
* vectorFilterMode: String(postFilter/preFilter/strictPostFilter) (Optional)
@@ -530,6 +552,18 @@ public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsB
530552
* documentBoost: Double (Optional)
531553
* }
532554
* }
555+
* innerHits (Optional): {
556+
* String (Required): [
557+
* (Required){
558+
* ordinal: Long (Optional)
559+
* vectors (Optional): [
560+
* (Optional){
561+
* String (Required): (recursive schema, see String above)
562+
* }
563+
* ]
564+
* }
565+
* ]
566+
* }
533567
* }
534568
* (Optional): {
535569
* String: Object (Required)

‎sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/implementation/KnowledgeBaseRetrievalClientImpl.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,12 @@ public final class KnowledgeBaseRetrievalClientImpl {
4545
private final KnowledgeBaseRetrievalClientService service;
4646

4747
/**
48-
* The endpoint URL of the search service.
48+
* Service host.
4949
*/
5050
private final String endpoint;
5151

5252
/**
53-
* Gets The endpoint URL of the search service.
53+
* Gets Service host.
5454
*
5555
* @return the endpoint value.
5656
*/
@@ -103,7 +103,7 @@ public SerializerAdapter getSerializerAdapter() {
103103
/**
104104
* Initializes an instance of KnowledgeBaseRetrievalClient client.
105105
*
106-
* @param endpoint The endpoint URL of the search service.
106+
* @param endpoint Service host.
107107
* @param serviceVersion Service version.
108108
*/
109109
public KnowledgeBaseRetrievalClientImpl(String endpoint, SearchServiceVersion serviceVersion) {
@@ -115,7 +115,7 @@ public KnowledgeBaseRetrievalClientImpl(String endpoint, SearchServiceVersion se
115115
* Initializes an instance of KnowledgeBaseRetrievalClient client.
116116
*
117117
* @param httpPipeline The HTTP pipeline to send requests through.
118-
* @param endpoint The endpoint URL of the search service.
118+
* @param endpoint Service host.
119119
* @param serviceVersion Service version.
120120
*/
121121
public KnowledgeBaseRetrievalClientImpl(HttpPipeline httpPipeline, String endpoint,
@@ -128,7 +128,7 @@ public KnowledgeBaseRetrievalClientImpl(HttpPipeline httpPipeline, String endpoi
128128
*
129129
* @param httpPipeline The HTTP pipeline to send requests through.
130130
* @param serializerAdapter The serializer to serialize an object into a string.
131-
* @param endpoint The endpoint URL of the search service.
131+
* @param endpoint Service host.
132132
* @param serviceVersion Service version.
133133
*/
134134
public KnowledgeBaseRetrievalClientImpl(HttpPipeline httpPipeline, SerializerAdapter serializerAdapter,

0 commit comments

Comments
 (0)