Search 10-01-2023 preview Swagger Regen (Azure#37099)

* Swagger Regeneration 10-01-2023 preview

* Swagger Regeneration 10-01-2023 preview (updates)

* Swagger Regeneration 10-01-2023 preview (updates) with test re-recordings

* Swagger Regeneration 10-01-2023 preview (updates) with test re-recordings

* test re-recordings

* test re-recordings

* test re-recordings

* test re-recordings

* test re-recordings

* PR updates from feedback

* Updating Code-Customization

* Updating Code-Customization

* Updating Code-Customization

* Updating deserialization

* Fixing spotbugs and checkstyle issues

Author: jairmyree

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_5dd3c5969f"
+  "Tag": "java/search/azure-search-documents_0d03c8265f"
 }

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

@@ -1110,7 +1110,8 @@ static SearchRequest createSearchRequest(String searchText, SearchOptions option
             .setSemanticErrorHandling(options.getSemanticErrorHandling())
             .setSemanticMaxWaitInMilliseconds(options.getSemanticMaxWaitInMilliseconds())
             .setDebug(options.getDebug())
-            .setVectors(options.getVectors());
+            .setVectorQueries(options.getVectorQueries())
+            .setSemanticQuery(options.getSemanticQuery());
     }
 
     static String createSearchRequestAnswers(SearchOptions searchOptions) {

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

@@ -20,9 +20,9 @@ public enum SearchServiceVersion implements ServiceVersion {
     V2021_04_30_PREVIEW("2021-04-30-Preview"),
 
     /**
-     * {@code 2023-07-01-Preview} service version.
+     * {@code 2023-10-01-Preview} service version.
      */
-    V2023_07_01_PREVIEW("2023-07-01-Preview");
+    V2023_10_01_PREVIEW("2023-10-01-Preview");
 
     private final String version;
 
@@ -44,6 +44,6 @@ public String getVersion() {
      * @return The latest version supported by this client library.
      */
     public static SearchServiceVersion getLatest() {
-        return V2023_07_01_PREVIEW;
+        return V2023_10_01_PREVIEW;
     }
 }

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

@@ -115,6 +115,7 @@ Mono<Response<SearchDocumentsResult>> searchGet(
                 @QueryParam("queryType") QueryType queryType,
                 @QueryParam(value = "scoringParameter", multipleQueryParams = true) List<String> scoringParameters,
                 @QueryParam("scoringProfile") String scoringProfile,
+                @QueryParam("semanticQuery") String semanticQuery,
                 @QueryParam("semanticConfiguration") String semanticConfiguration,
                 @QueryParam("semanticErrorHandling") SemanticErrorHandling semanticErrorHandling,
                 @QueryParam("semanticMaxWaitInMilliseconds") Integer semanticMaxWaitInMilliseconds,
@@ -154,6 +155,7 @@ Response<SearchDocumentsResult> searchGetSync(
                 @QueryParam("queryType") QueryType queryType,
                 @QueryParam(value = "scoringParameter", multipleQueryParams = true) List<String> scoringParameters,
                 @QueryParam("scoringProfile") String scoringProfile,
+                @QueryParam("semanticQuery") String semanticQuery,
                 @QueryParam("semanticConfiguration") String semanticConfiguration,
                 @QueryParam("semanticErrorHandling") SemanticErrorHandling semanticErrorHandling,
                 @QueryParam("semanticMaxWaitInMilliseconds") Integer semanticMaxWaitInMilliseconds,

sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/implementation/models/SearchOptions.java

@@ -91,14 +91,22 @@ public final class SearchOptions implements JsonSerializable<SearchOptions> {
      */
     private String scoringProfile;
 
+    /*
+     * Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and
+     * semantic answers. Is useful for scenarios where there is a need to use different queries between the base
+     * retrieval and ranking phase, and the L2 semantic phase.
+     */
+    private String semanticQuery;
+
     /*
      * The name of the semantic configuration that lists which fields should be used for semantic ranking, captions,
      * highlights, and answers
      */
     private String semanticConfiguration;
 
     /*
-     * Allows the user to choose whether a semantic call should fail completely, or to return partial results.
+     * Allows the user to choose whether a semantic call should fail completely, or to return partial results
+     * (default).
      */
     private SemanticErrorHandling semanticErrorHandling;
 
@@ -448,6 +456,30 @@ public SearchOptions setScoringProfile(String scoringProfile) {
         return this;
     }
 
+    /**
+     * Get the semanticQuery property: Allows setting a separate search query that will be solely used for semantic
+     * reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different
+     * queries between the base retrieval and ranking phase, and the L2 semantic phase.
+     *
+     * @return the semanticQuery value.
+     */
+    public String getSemanticQuery() {
+        return this.semanticQuery;
+    }
+
+    /**
+     * Set the semanticQuery property: Allows setting a separate search query that will be solely used for semantic
+     * reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different
+     * queries between the base retrieval and ranking phase, and the L2 semantic phase.
+     *
+     * @param semanticQuery the semanticQuery value to set.
+     * @return the SearchOptions object itself.
+     */
+    public SearchOptions setSemanticQuery(String semanticQuery) {
+        this.semanticQuery = semanticQuery;
+        return this;
+    }
+
     /**
      * Get the semanticConfiguration property: The name of the semantic configuration that lists which fields should be
      * used for semantic ranking, captions, highlights, and answers.
@@ -472,7 +504,7 @@ public SearchOptions setSemanticConfiguration(String semanticConfiguration) {
 
     /**
      * Get the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely,
-     * or to return partial results.
+     * or to return partial results (default).
      *
      * @return the semanticErrorHandling value.
      */
@@ -482,7 +514,7 @@ public SemanticErrorHandling getSemanticErrorHandling() {
 
     /**
      * Set the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely,
-     * or to return partial results.
+     * or to return partial results (default).
      *
      * @param semanticErrorHandling the semanticErrorHandling value to set.
      * @return the SearchOptions object itself.
@@ -832,6 +864,7 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeArrayField(
                 "ScoringParameters", this.scoringParameters, (writer, element) -> writer.writeString(element));
         jsonWriter.writeStringField("scoringProfile", this.scoringProfile);
+        jsonWriter.writeStringField("semanticQuery", this.semanticQuery);
         jsonWriter.writeStringField("semanticConfiguration", this.semanticConfiguration);
         jsonWriter.writeStringField("semanticErrorHandling", Objects.toString(this.semanticErrorHandling, null));
         jsonWriter.writeNumberField("semanticMaxWaitInMilliseconds", this.semanticMaxWaitInMilliseconds);
@@ -893,6 +926,8 @@ public static SearchOptions fromJson(JsonReader jsonReader) throws IOException {
                             deserializedSearchOptions.scoringParameters = scoringParameters;
                         } else if ("scoringProfile".equals(fieldName)) {
                             deserializedSearchOptions.scoringProfile = reader.getString();
+                        } else if ("semanticQuery".equals(fieldName)) {
+                            deserializedSearchOptions.semanticQuery = reader.getString();
                         } else if ("semanticConfiguration".equals(fieldName)) {
                             deserializedSearchOptions.semanticConfiguration = reader.getString();
                         } else if ("semanticErrorHandling".equals(fieldName)) {

sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/implementation/models/SearchRequest.java

@@ -17,8 +17,9 @@
 import com.azure.search.documents.models.QueryType;
 import com.azure.search.documents.models.ScoringStatistics;
 import com.azure.search.documents.models.SearchMode;
-import com.azure.search.documents.models.SearchQueryVector;
 import com.azure.search.documents.models.SemanticErrorHandling;
+import com.azure.search.documents.models.VectorFilterMode;
+import com.azure.search.documents.models.VectorQuery;
 import java.io.IOException;
 import java.util.List;
 import java.util.Objects;
@@ -110,14 +111,21 @@ public final class SearchRequest implements JsonSerializable<SearchRequest> {
      */
     private String scoringProfile;
 
+    /*
+     * Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and
+     * semantic answers. Is useful for scenarios where there is a need to use different queries between the base
+     * retrieval and ranking phase, and the L2 semantic phase.
+     */
+    private String semanticQuery;
+
     /*
      * The name of a semantic configuration that will be used when processing documents for queries of type semantic.
      */
     private String semanticConfiguration;
 
     /*
-     * Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to
-     * return partial results.
+     * Allows the user to choose whether a semantic call should fail completely, or to return partial results
+     * (default).
      */
     private SemanticErrorHandling semanticErrorHandling;
 
@@ -204,9 +212,15 @@ public final class SearchRequest implements JsonSerializable<SearchRequest> {
     private String semanticFields;
 
     /*
-     * The query parameters for multi-vector search queries.
+     * The query parameters for vector and hybrid search queries.
+     */
+    private List<VectorQuery> vectorQueries;
+
+    /*
+     * Determines whether or not filters are applied before or after the vector search is performed. Default is
+     * 'preFilter'.
      */
-    private List<SearchQueryVector> vectors;
+    private VectorFilterMode vectorFilterMode;
 
     /** Creates an instance of SearchRequest class. */
     public SearchRequest() {}
@@ -517,6 +531,30 @@ public SearchRequest setScoringProfile(String scoringProfile) {
         return this;
     }
 
+    /**
+     * Get the semanticQuery property: Allows setting a separate search query that will be solely used for semantic
+     * reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different
+     * queries between the base retrieval and ranking phase, and the L2 semantic phase.
+     *
+     * @return the semanticQuery value.
+     */
+    public String getSemanticQuery() {
+        return this.semanticQuery;
+    }
+
+    /**
+     * Set the semanticQuery property: Allows setting a separate search query that will be solely used for semantic
+     * reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different
+     * queries between the base retrieval and ranking phase, and the L2 semantic phase.
+     *
+     * @param semanticQuery the semanticQuery value to set.
+     * @return the SearchRequest object itself.
+     */
+    public SearchRequest setSemanticQuery(String semanticQuery) {
+        this.semanticQuery = semanticQuery;
+        return this;
+    }
+
     /**
      * Get the semanticConfiguration property: The name of a semantic configuration that will be used when processing
      * documents for queries of type semantic.
@@ -540,8 +578,8 @@ public SearchRequest setSemanticConfiguration(String semanticConfiguration) {
     }
 
     /**
-     * Get the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely
-     * (default / current behavior), or to return partial results.
+     * Get the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely,
+     * or to return partial results (default).
      *
      * @return the semanticErrorHandling value.
      */
@@ -550,8 +588,8 @@ public SemanticErrorHandling getSemanticErrorHandling() {
     }
 
     /**
-     * Set the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely
-     * (default / current behavior), or to return partial results.
+     * Set the semanticErrorHandling property: Allows the user to choose whether a semantic call should fail completely,
+     * or to return partial results (default).
      *
      * @param semanticErrorHandling the semanticErrorHandling value to set.
      * @return the SearchRequest object itself.
@@ -862,22 +900,44 @@ public SearchRequest setSemanticFields(String semanticFields) {
     }
 
     /**
-     * Get the vectors property: The query parameters for multi-vector search queries.
+     * Get the vectorQueries property: The query parameters for vector and hybrid search queries.
+     *
+     * @return the vectorQueries value.
+     */
+    public List<VectorQuery> getVectorQueries() {
+        return this.vectorQueries;
+    }
+
+    /**
+     * Set the vectorQueries property: The query parameters for vector and hybrid search queries.
+     *
+     * @param vectorQueries the vectorQueries value to set.
+     * @return the SearchRequest object itself.
+     */
+    public SearchRequest setVectorQueries(List<VectorQuery> vectorQueries) {
+        this.vectorQueries = vectorQueries;
+        return this;
+    }
+
+    /**
+     * Get the vectorFilterMode property: Determines whether or not filters are applied before or after the vector
+     * search is performed. Default is 'preFilter'.
      *
-     * @return the vectors value.
+     * @return the vectorFilterMode value.
      */
-    public List<SearchQueryVector> getVectors() {
-        return this.vectors;
+    public VectorFilterMode getVectorFilterMode() {
+        return this.vectorFilterMode;
     }
 
     /**
-     * Set the vectors property: The query parameters for multi-vector search queries.
+     * Set the vectorFilterMode property: Determines whether or not filters are applied before or after the vector
+     * search is performed. Default is 'preFilter'.
      *
-     * @param vectors the vectors value to set.
+     * @param vectorFilterMode the vectorFilterMode value to set.
      * @return the SearchRequest object itself.
      */
-    public SearchRequest setVectors(List<SearchQueryVector> vectors) {
-        this.vectors = vectors;
+    public SearchRequest setVectorFilterMode(VectorFilterMode vectorFilterMode) {
+        this.vectorFilterMode = vectorFilterMode;
         return this;
     }
 
@@ -898,6 +958,7 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeArrayField(
                 "scoringParameters", this.scoringParameters, (writer, element) -> writer.writeString(element));
         jsonWriter.writeStringField("scoringProfile", this.scoringProfile);
+        jsonWriter.writeStringField("semanticQuery", this.semanticQuery);
         jsonWriter.writeStringField("semanticConfiguration", this.semanticConfiguration);
         jsonWriter.writeStringField("semanticErrorHandling", Objects.toString(this.semanticErrorHandling, null));
         jsonWriter.writeNumberField("semanticMaxWaitInMilliseconds", this.semanticMaxWaitInMilliseconds);
@@ -913,7 +974,8 @@ public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
         jsonWriter.writeNumberField("top", this.top);
         jsonWriter.writeStringField("captions", this.captions);
         jsonWriter.writeStringField("semanticFields", this.semanticFields);
-        jsonWriter.writeArrayField("vectors", this.vectors, (writer, element) -> writer.writeJson(element));
+        jsonWriter.writeArrayField("vectorQueries", this.vectorQueries, (writer, element) -> writer.writeJson(element));
+        jsonWriter.writeStringField("vectorFilterMode", Objects.toString(this.vectorFilterMode, null));
         return jsonWriter.writeEndObject();
     }
 
@@ -963,6 +1025,8 @@ public static SearchRequest fromJson(JsonReader jsonReader) throws IOException {
                             deserializedSearchRequest.scoringParameters = scoringParameters;
                         } else if ("scoringProfile".equals(fieldName)) {
                             deserializedSearchRequest.scoringProfile = reader.getString();
+                        } else if ("semanticQuery".equals(fieldName)) {
+                            deserializedSearchRequest.semanticQuery = reader.getString();
                         } else if ("semanticConfiguration".equals(fieldName)) {
                             deserializedSearchRequest.semanticConfiguration = reader.getString();
                         } else if ("semanticErrorHandling".equals(fieldName)) {
@@ -995,10 +1059,13 @@ public static SearchRequest fromJson(JsonReader jsonReader) throws IOException {
                             deserializedSearchRequest.captions = reader.getString();
                         } else if ("semanticFields".equals(fieldName)) {
                             deserializedSearchRequest.semanticFields = reader.getString();
-                        } else if ("vectors".equals(fieldName)) {
-                            List<SearchQueryVector> vectors =
-                                    reader.readArray(reader1 -> SearchQueryVector.fromJson(reader1));
-                            deserializedSearchRequest.vectors = vectors;
+                        } else if ("vectorQueries".equals(fieldName)) {
+                            List<VectorQuery> vectorQueries =
+                                    reader.readArray(reader1 -> VectorQuery.fromJson(reader1));
+                            deserializedSearchRequest.vectorQueries = vectorQueries;
+                        } else if ("vectorFilterMode".equals(fieldName)) {
+                            deserializedSearchRequest.vectorFilterMode =
+                                    VectorFilterMode.fromString(reader.getString());
                         } else {
                             reader.skipChildren();
                         }