google-cloud-discovery_engine-v1beta 0.20.1 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2110b6076063952f57281b6236885c6768e4c30c4449ce59696442fc19ccb74b
-  data.tar.gz: 5d1177c31411721a942f882ffe161766d437a50199fe8014200e17fb9c69e359
+  metadata.gz: 225df45cd6bd848d2256f00fb2165e3be81bac5c084e28be3bb9688cb94eed82
+  data.tar.gz: 5527ba6246f256b79763414ae684f266f4f882dca319f33371bce5b269cbf20d
 SHA512:
-  metadata.gz: 4aaf723159521cb49de8b0ed2f979bdcca4fae27b3783f006c2bf2c61829c1930597a7e244f48d60aa97066092abdc5ef655468b7ad4a5017ff16f6c0970e2b9
-  data.tar.gz: 723b3782504a8d6d9c755ad1a683741b69d8616a37ce1108903b3a6dfec66192114c6fb7e9306b326ebe6f2965dcf4f4cdbdfa8b498276175b52e1cb9b134872
+  metadata.gz: f17a2e5602e3aff5c862f5595549b94e0ccb40d48157cd72efd63fbc6574d78a6cdeab2e859c58aa90b1d48d3c5d5daa1d2b808ba268fcd2329de6a1ee97dadd
+  data.tar.gz: 31aea61137e12ae88a0c64e6c0801025ffb7b13a4b992e06f690fcdd8e09078ea8b29aee7991360eda0d62bc5f389328c340bb196c858f37a580a97ef83e4b8d

data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb

@@ -1355,7 +1355,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload get_session(name: nil)
+            # @overload get_session(name: nil, include_answer_details: nil)
             #   Pass arguments to `get_session` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1363,6 +1363,9 @@ module Google
             #   @param name [::String]
             #     Required. The resource name of the Session to get. Format:
             #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+            #   @param include_answer_details [::Boolean]
+            #     Optional. If set to true, the full session including all answer details
+            #     will be returned.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Session]
@@ -1457,22 +1460,39 @@ module Google
             #     A page token, received from a previous `ListSessions` call.
             #     Provide this to retrieve the subsequent page.
             #   @param filter [::String]
-            #     A filter to apply on the list results. The supported features are:
-            #     user_pseudo_id, state.
-            #
-            #     Example:
+            #     A comma-separated list of fields to filter by, in EBNF grammar.
+            #     The supported fields are:
+            #     * `user_pseudo_id`
+            #     * `state`
+            #     * `display_name`
+            #     * `starred`
+            #     * `is_pinned`
+            #     * `labels`
+            #     * `create_time`
+            #     * `update_time`
+            #
+            #     Examples:
             #     "user_pseudo_id = some_id"
+            #     "display_name = \"some_name\""
+            #     "starred = true"
+            #     "is_pinned=true AND (NOT labels:hidden)"
+            #     "create_time > \"1970-01-01T12:00:00Z\""
             #   @param order_by [::String]
             #     A comma-separated list of fields to order by, sorted in ascending order.
             #     Use "desc" after a field name for descending.
             #     Supported fields:
+            #
             #       * `update_time`
             #       * `create_time`
             #       * `session_name`
+            #       * `is_pinned`
             #
             #     Example:
-            #     "update_time desc"
-            #     "create_time"
+            #
+            #     * "update_time desc"
+            #     * "create_time"
+            #     * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+            #        by update_time.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]

data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb

@@ -1271,7 +1271,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload get_session(name: nil)
+              # @overload get_session(name: nil, include_answer_details: nil)
               #   Pass arguments to `get_session` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -1279,6 +1279,9 @@ module Google
               #   @param name [::String]
               #     Required. The resource name of the Session to get. Format:
               #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+              #   @param include_answer_details [::Boolean]
+              #     Optional. If set to true, the full session including all answer details
+              #     will be returned.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Session]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1366,22 +1369,39 @@ module Google
               #     A page token, received from a previous `ListSessions` call.
               #     Provide this to retrieve the subsequent page.
               #   @param filter [::String]
-              #     A filter to apply on the list results. The supported features are:
-              #     user_pseudo_id, state.
-              #
-              #     Example:
+              #     A comma-separated list of fields to filter by, in EBNF grammar.
+              #     The supported fields are:
+              #     * `user_pseudo_id`
+              #     * `state`
+              #     * `display_name`
+              #     * `starred`
+              #     * `is_pinned`
+              #     * `labels`
+              #     * `create_time`
+              #     * `update_time`
+              #
+              #     Examples:
               #     "user_pseudo_id = some_id"
+              #     "display_name = \"some_name\""
+              #     "starred = true"
+              #     "is_pinned=true AND (NOT labels:hidden)"
+              #     "create_time > \"1970-01-01T12:00:00Z\""
               #   @param order_by [::String]
               #     A comma-separated list of fields to order by, sorted in ascending order.
               #     Use "desc" after a field name for descending.
               #     Supported fields:
+              #
               #       * `update_time`
               #       * `create_time`
               #       * `session_name`
+              #       * `is_pinned`
               #
               #     Example:
-              #     "update_time desc"
-              #     "create_time"
+              #
+              #     * "update_time desc"
+              #     * "create_time"
+              #     * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+              #        by update_time.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Session>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]

data/lib/google/cloud/discovery_engine/v1beta/rest.rb

@@ -33,6 +33,7 @@ require "google/cloud/discovery_engine/v1beta/sample_query_set_service/rest"
 require "google/cloud/discovery_engine/v1beta/schema_service/rest"
 require "google/cloud/discovery_engine/v1beta/search_tuning_service/rest"
 require "google/cloud/discovery_engine/v1beta/serving_config_service/rest"
+require "google/cloud/discovery_engine/v1beta/session_service/rest"
 require "google/cloud/discovery_engine/v1beta/site_search_engine_service/rest"
 require "google/cloud/discovery_engine/v1beta/user_event_service/rest"
 require "google/cloud/discovery_engine/v1beta/version"

data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb

@@ -455,22 +455,16 @@ module Google
             #     between /search API calls and /answer API calls.
             #
             #     Example #1 (multi-turn /search API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /search API with the session ID generated in the first call.
-            #          Here, the previous search query gets considered in query
-            #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-            #          and the current query is "How about 2023?", the current query will
-            #          be interpreted as "How did Alphabet do in 2023?".
+            #       Call /search API with the session ID generated in the first call.
+            #       Here, the previous search query gets considered in query
+            #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+            #       and the current query is "How about 2023?", the current query will
+            #       be interpreted as "How did Alphabet do in 2023?".
             #
             #     Example #2 (coordination between /search API calls and /answer API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /answer API with the session ID generated in the first call.
-            #          Here, the answer generation happens in the context of the search
-            #          results from the first search call.
-            #
-            #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-            #     gets automatically created. Otherwise, users can use the create-session API
-            #     to create a session manually.
+            #       Call /answer API with the session ID generated in the first call.
+            #       Here, the answer generation happens in the context of the search
+            #       results from the first search call.
             #
             #     Multi-turn Search feature is currently at private GA stage. Please use
             #     v1alpha or v1beta version instead before we launch this feature to public
@@ -830,22 +824,16 @@ module Google
             #     between /search API calls and /answer API calls.
             #
             #     Example #1 (multi-turn /search API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /search API with the session ID generated in the first call.
-            #          Here, the previous search query gets considered in query
-            #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-            #          and the current query is "How about 2023?", the current query will
-            #          be interpreted as "How did Alphabet do in 2023?".
+            #       Call /search API with the session ID generated in the first call.
+            #       Here, the previous search query gets considered in query
+            #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+            #       and the current query is "How about 2023?", the current query will
+            #       be interpreted as "How did Alphabet do in 2023?".
             #
             #     Example #2 (coordination between /search API calls and /answer API calls):
-            #       1. Call /search API with the auto-session mode (see below).
-            #       2. Call /answer API with the session ID generated in the first call.
-            #          Here, the answer generation happens in the context of the search
-            #          results from the first search call.
-            #
-            #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-            #     gets automatically created. Otherwise, users can use the create-session API
-            #     to create a session manually.
+            #       Call /answer API with the session ID generated in the first call.
+            #       Here, the answer generation happens in the context of the search
+            #       results from the first search call.
             #
             #     Multi-turn Search feature is currently at private GA stage. Please use
             #     v1alpha or v1beta version instead before we launch this feature to public

data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb

@@ -448,22 +448,16 @@ module Google
               #     between /search API calls and /answer API calls.
               #
               #     Example #1 (multi-turn /search API calls):
-              #       1. Call /search API with the auto-session mode (see below).
-              #       2. Call /search API with the session ID generated in the first call.
-              #          Here, the previous search query gets considered in query
-              #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-              #          and the current query is "How about 2023?", the current query will
-              #          be interpreted as "How did Alphabet do in 2023?".
+              #       Call /search API with the session ID generated in the first call.
+              #       Here, the previous search query gets considered in query
+              #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+              #       and the current query is "How about 2023?", the current query will
+              #       be interpreted as "How did Alphabet do in 2023?".
               #
               #     Example #2 (coordination between /search API calls and /answer API calls):
-              #       1. Call /search API with the auto-session mode (see below).
-              #       2. Call /answer API with the session ID generated in the first call.
-              #          Here, the answer generation happens in the context of the search
-              #          results from the first search call.
-              #
-              #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-              #     gets automatically created. Otherwise, users can use the create-session API
-              #     to create a session manually.
+              #       Call /answer API with the session ID generated in the first call.
+              #       Here, the answer generation happens in the context of the search
+              #       results from the first search call.
               #
               #     Multi-turn Search feature is currently at private GA stage. Please use
               #     v1alpha or v1beta version instead before we launch this feature to public
@@ -816,22 +810,16 @@ module Google
               #     between /search API calls and /answer API calls.
               #
               #     Example #1 (multi-turn /search API calls):
-              #       1. Call /search API with the auto-session mode (see below).
-              #       2. Call /search API with the session ID generated in the first call.
-              #          Here, the previous search query gets considered in query
-              #          standing. I.e., if the first query is "How did Alphabet do in 2022?"
-              #          and the current query is "How about 2023?", the current query will
-              #          be interpreted as "How did Alphabet do in 2023?".
+              #       Call /search API with the session ID generated in the first call.
+              #       Here, the previous search query gets considered in query
+              #       standing. I.e., if the first query is "How did Alphabet do in 2022?"
+              #       and the current query is "How about 2023?", the current query will
+              #       be interpreted as "How did Alphabet do in 2023?".
               #
               #     Example #2 (coordination between /search API calls and /answer API calls):
-              #       1. Call /search API with the auto-session mode (see below).
-              #       2. Call /answer API with the session ID generated in the first call.
-              #          Here, the answer generation happens in the context of the search
-              #          results from the first search call.
-              #
-              #     Auto-session mode: when `projects/.../sessions/-` is used, a new session
-              #     gets automatically created. Otherwise, users can use the create-session API
-              #     to create a session manually.
+              #       Call /answer API with the session ID generated in the first call.
+              #       Here, the answer generation happens in the context of the search
+              #       results from the first search call.
               #
               #     Multi-turn Search feature is currently at private GA stage. Please use
               #     v1alpha or v1beta version instead before we launch this feature to public