Regenerate and Include New Skillsets (Azure#22945)

Regenerate and Include New Skillsets

Author: alzimmermsft

eng/code-quality-reports/src/main/resources/revapi/revapi.json

@@ -549,8 +549,8 @@
       },
       {
         "code": "java.method.added",
-          "new": "method com.azure.core.util.HttpClientOptions com.azure.core.util.HttpClientOptions::setResponseTimeout(java.time.Duration)",
-          "justification": "New Setter method."
+        "new": "method com.azure.core.util.HttpClientOptions com.azure.core.util.HttpClientOptions::setResponseTimeout(java.time.Duration)",
+        "justification": "New Setter method."
       },
       {
         "code": "java.annotation.attributeValueChanged",

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

@@ -841,7 +841,9 @@ private static SearchRequest createSearchRequest(String searchText, SearchOption
             .setSessionId(options.getSessionId())
             .setSelect(nullSafeStringJoin(options.getSelect()))
             .setSkip(options.getSkip())
-            .setTop(options.getTop());
+            .setTop(options.getTop())
+            .setCaptions(options.getCaptions())
+            .setSemanticFields(nullSafeStringJoin(options.getSemanticFields()));
     }
 
     private static String createSearchRequestAnswers(SearchOptions searchOptions) {

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

@@ -10,7 +10,7 @@
  */
 public enum SearchServiceVersion implements ServiceVersion {
     V2020_06_30("2020-06-30"),
-    V2020_06_30_PREVIEW("2020-06-30-Preview");
+    V2021_04_30_PREVIEW("2021-04-30-Preview");
 
     private final String version;
 
@@ -32,6 +32,6 @@ public String getVersion() {
      * @return The latest version supported by this client library.
      */
     public static SearchServiceVersion getLatest() {
-        return V2020_06_30_PREVIEW;
+        return V2021_04_30_PREVIEW;
     }
 }

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

@@ -37,6 +37,7 @@
 import com.azure.search.documents.models.AutocompleteMode;
 import com.azure.search.documents.models.AutocompleteOptions;
 import com.azure.search.documents.models.AutocompleteResult;
+import com.azure.search.documents.models.Captions;
 import com.azure.search.documents.models.QueryLanguage;
 import com.azure.search.documents.models.QuerySpeller;
 import com.azure.search.documents.models.QueryType;
@@ -112,6 +113,8 @@ Mono<Response<SearchDocumentsResult>> searchGet(
                 @QueryParam("$select") String select,
                 @QueryParam("$skip") Integer skip,
                 @QueryParam("$top") Integer top,
+                @QueryParam("captions") Captions captions,
+                @QueryParam("semanticFields") String semanticFields,
                 @QueryParam("api-version") String apiVersion,
                 @HeaderParam("x-ms-client-request-id") UUID xMsClientRequestId,
                 @HeaderParam("Accept") String accept,
@@ -370,6 +373,16 @@ public Mono<Response<SearchDocumentsResult>> searchGetWithResponseAsync(
             topInternal = searchOptions.getTop();
         }
         Integer top = topInternal;
+        Captions captionsInternal = null;
+        if (searchOptions != null) {
+            captionsInternal = searchOptions.getCaptions();
+        }
+        Captions captions = captionsInternal;
+        List<String> semanticFieldsInternal = null;
+        if (searchOptions != null) {
+            semanticFieldsInternal = searchOptions.getSemanticFields();
+        }
+        List<String> semanticFields = semanticFieldsInternal;
         UUID xMsClientRequestIdInternal = null;
         if (requestOptions != null) {
             xMsClientRequestIdInternal = requestOptions.getXMsClientRequestId();
@@ -387,6 +400,8 @@ public Mono<Response<SearchDocumentsResult>> searchGetWithResponseAsync(
                 JacksonAdapter.createDefaultSerializerAdapter().serializeList(searchFields, CollectionFormat.CSV);
         String selectConverted =
                 JacksonAdapter.createDefaultSerializerAdapter().serializeList(select, CollectionFormat.CSV);
+        String semanticFieldsConverted =
+                JacksonAdapter.createDefaultSerializerAdapter().serializeList(semanticFields, CollectionFormat.CSV);
         return service.searchGet(
                 this.client.getEndpoint(),
                 this.client.getIndexName(),
@@ -412,6 +427,8 @@ public Mono<Response<SearchDocumentsResult>> searchGetWithResponseAsync(
                 selectConverted,
                 skip,
                 top,
+                captions,
+                semanticFieldsConverted,
                 this.client.getApiVersion(),
                 xMsClientRequestId,
                 accept,

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

@@ -208,7 +208,7 @@ public SearchIndexClientImplBuilder addPolicy(HttpPipelinePolicy customPolicy) {
      */
     public SearchIndexClientImpl buildClient() {
         if (apiVersion == null) {
-            this.apiVersion = "2020-06-30-Preview";
+            this.apiVersion = "2021-04-30-Preview";
         }
         if (pipeline == null) {
             this.pipeline = createHttpPipeline();

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

@@ -7,6 +7,7 @@
 package com.azure.search.documents.implementation.models;
 
 import com.azure.core.annotation.Fluent;
+import com.azure.search.documents.models.Captions;
 import com.azure.search.documents.models.QueryLanguage;
 import com.azure.search.documents.models.QuerySpeller;
 import com.azure.search.documents.models.QueryType;
@@ -193,6 +194,23 @@ public final class SearchOptions {
     @JsonProperty(value = "$top")
     private Integer top;
 
+    /*
+     * This parameter is only valid if the query type is 'semantic'. If set,
+     * the query returns captions extracted from key passages in the highest
+     * ranked documents. When Captions is set to 'extractive', highlighting is
+     * enabled by default, and can be configured by appending the pipe
+     * character '|' followed by the 'highlight-<true/false>' option, such as
+     * 'extractive|highlight-true'. Defaults to 'None'.
+     */
+    @JsonProperty(value = "captions")
+    private Captions captions;
+
+    /*
+     * The list of field names used for semantic search.
+     */
+    @JsonProperty(value = "semanticFields")
+    private List<String> semanticFields;
+
     /**
      * Get the includeTotalCount property: A value that specifies whether to fetch the total count of results. Default
      * is false. Setting this value to true may have a performance impact. Note that the count returned is an
@@ -676,4 +694,50 @@ public SearchOptions setTop(Integer top) {
         this.top = top;
         return this;
     }
+
+    /**
+     * Get the captions property: This parameter is only valid if the query type is 'semantic'. If set, the query
+     * returns captions extracted from key passages in the highest ranked documents. When Captions is set to
+     * 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|'
+     * followed by the 'highlight-&lt;true/false&gt;' option, such as 'extractive|highlight-true'. Defaults to 'None'.
+     *
+     * @return the captions value.
+     */
+    public Captions getCaptions() {
+        return this.captions;
+    }
+
+    /**
+     * Set the captions property: This parameter is only valid if the query type is 'semantic'. If set, the query
+     * returns captions extracted from key passages in the highest ranked documents. When Captions is set to
+     * 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|'
+     * followed by the 'highlight-&lt;true/false&gt;' option, such as 'extractive|highlight-true'. Defaults to 'None'.
+     *
+     * @param captions the captions value to set.
+     * @return the SearchOptions object itself.
+     */
+    public SearchOptions setCaptions(Captions captions) {
+        this.captions = captions;
+        return this;
+    }
+
+    /**
+     * Get the semanticFields property: The list of field names used for semantic search.
+     *
+     * @return the semanticFields value.
+     */
+    public List<String> getSemanticFields() {
+        return this.semanticFields;
+    }
+
+    /**
+     * Set the semanticFields property: The list of field names used for semantic search.
+     *
+     * @param semanticFields the semanticFields value to set.
+     * @return the SearchOptions object itself.
+     */
+    public SearchOptions setSemanticFields(List<String> semanticFields) {
+        this.semanticFields = semanticFields;
+        return this;
+    }
 }

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

@@ -7,6 +7,7 @@
 package com.azure.search.documents.implementation.models;
 
 import com.azure.core.annotation.Fluent;
+import com.azure.search.documents.models.Captions;
 import com.azure.search.documents.models.QueryLanguage;
 import com.azure.search.documents.models.QuerySpeller;
 import com.azure.search.documents.models.QueryType;
@@ -203,6 +204,19 @@ public final class SearchRequest {
     @JsonProperty(value = "top")
     private Integer top;
 
+    /*
+     * A value that specifies whether captions should be returned as part of
+     * the search response.
+     */
+    @JsonProperty(value = "captions")
+    private Captions captions;
+
+    /*
+     * The comma-separated list of field names used for semantic search.
+     */
+    @JsonProperty(value = "semanticFields")
+    private String semanticFields;
+
     /**
      * Get the includeTotalResultCount property: A value that specifies whether to fetch the total count of results.
      * Default is false. Setting this value to true may have a performance impact. Note that the count returned is an
@@ -714,4 +728,46 @@ public SearchRequest setTop(Integer top) {
         this.top = top;
         return this;
     }
+
+    /**
+     * Get the captions property: A value that specifies whether captions should be returned as part of the search
+     * response.
+     *
+     * @return the captions value.
+     */
+    public Captions getCaptions() {
+        return this.captions;
+    }
+
+    /**
+     * Set the captions property: A value that specifies whether captions should be returned as part of the search
+     * response.
+     *
+     * @param captions the captions value to set.
+     * @return the SearchRequest object itself.
+     */
+    public SearchRequest setCaptions(Captions captions) {
+        this.captions = captions;
+        return this;
+    }
+
+    /**
+     * Get the semanticFields property: The comma-separated list of field names used for semantic search.
+     *
+     * @return the semanticFields value.
+     */
+    public String getSemanticFields() {
+        return this.semanticFields;
+    }
+
+    /**
+     * Set the semanticFields property: The comma-separated list of field names used for semantic search.
+     *
+     * @param semanticFields the semanticFields value to set.
+     * @return the SearchRequest object itself.
+     */
+    public SearchRequest setSemanticFields(String semanticFields) {
+        this.semanticFields = semanticFields;
+        return this;
+    }
 }

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

@@ -111,10 +111,12 @@ private static List<SearchField> build(Class<?> currentClass, Stack<Class<?>> cl
             LOGGER.warning("There is circular dependencies {}, {}", classChain, currentClass);
             return null;
         }
+
         if (classChain.size() > MAX_DEPTH) {
             throw LOGGER.logExceptionAsError(new RuntimeException(
                 "The dependency graph is too deep. Please review your schema."));
         }
+
         classChain.push(currentClass);
         List<SearchField> searchFields = getDeclaredFieldsAndMethods(currentClass)
             .filter(FieldBuilder::fieldOrMethodIgnored)
@@ -240,23 +242,18 @@ private static Type getComponentOrElementType(Type arrayOrListType) {
     }
 
     private static SearchField convertToBasicSearchField(String fieldName, Type type) {
-
         SearchFieldDataType dataType = covertToSearchFieldDataType(type, false);
-        if (dataType == null) {
-            return null;
-        }
 
-        return new SearchField(fieldName, dataType);
+        return (dataType == null) ? null : new SearchField(fieldName, dataType);
     }
 
     private static SearchField enrichWithAnnotation(SearchField searchField, Member member) {
         SimpleField simpleField = getDeclaredAnnotation(member, SimpleField.class);
         SearchableField searchableField = getDeclaredAnnotation(member, SearchableField.class);
 
         if (simpleField != null && searchableField != null) {
-            throw LOGGER.logExceptionAsError(new IllegalArgumentException(
-                String.format("@SimpleFieldProperty and @SearchableFieldProperty cannot be present simultaneously "
-                    + "for %s", member.getName())));
+            throw LOGGER.logExceptionAsError(new IllegalArgumentException(String.format(
+                "@SimpleField and @SearchableField cannot be present simultaneously for %s", member.getName())));
         }
         if (simpleField != null) {
             searchField.setSearchable(false)
@@ -268,9 +265,9 @@ private static SearchField enrichWithAnnotation(SearchField searchField, Member
         } else if (searchableField != null) {
             if (!searchField.getType().equals(SearchFieldDataType.STRING)
                 && !searchField.getType().equals(SearchFieldDataType.collection(SearchFieldDataType.STRING))) {
-                throw LOGGER.logExceptionAsError(new RuntimeException(String.format("SearchFieldProperty can only"
-                        + " be used on string properties. Property %s returns a %s value.",
-                    member.getName(), searchField.getType())));
+                throw LOGGER.logExceptionAsError(new RuntimeException(String.format("SearchField can only be used on "
+                        + "string properties. Property %s returns a %s value.", member.getName(),
+                    searchField.getType())));
             }
 
             searchField.setSearchable(true)

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

@@ -192,7 +192,7 @@ public SearchServiceClientImplBuilder addPolicy(HttpPipelinePolicy customPolicy)
      */
     public SearchServiceClientImpl buildClient() {
         if (apiVersion == null) {
-            this.apiVersion = "2020-06-30-Preview";
+            this.apiVersion = "2021-04-30-Preview";
         }
         if (pipeline == null) {
             this.pipeline = createHttpPipeline();