google-cloud-discovery_engine-v1 2.3.1 → 2.4.0

data/proto_docs/google/cloud/discoveryengine/v1/assistant.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Discovery Engine Assistant resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Resource name of the assistant.
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
+        #
+        #     It must be a UTF-8 encoded string with a length limit of 1024 characters.
+        class Assistant
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # User metadata of the request.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     Optional. IANA time zone, e.g. Europe/Budapest.
+        # @!attribute [rw] preferred_language_code
+        #   @return [::String]
+        #     Optional. Preferred language to be used for answering if language detection
+        #     fails. Also used as the language of error messages created by actions,
+        #     regardless of language detection results.
+        class AssistUserMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the
+        # {::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client#stream_assist AssistantService.StreamAssist}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Assistant Assistant}. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
+        #     Optional. Current user query.
+        #
+        #     Empty query is only supported if `file_ids` are provided. In this case, the
+        #     answer will be generated based on those context files.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Optional. The session to use for the request. If specified, the assistant
+        #     has access to the session history, and the query and the answer are stored
+        #     there.
+        #
+        #     If `-` is specified as the session ID, or it is left empty, then a new
+        #     session is created with an automatically generated ID.
+        #
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
+        # @!attribute [rw] user_metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata]
+        #     Optional. Information about the user initiating the query.
+        # @!attribute [rw] tools_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec]
+        #     Optional. Specification of tools that are used to serve the request.
+        # @!attribute [rw] generation_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec]
+        #     Optional. Specification of the generation configuration for the request.
+        class StreamAssistRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specification of tools that are used to serve the request.
+          # @!attribute [rw] vertex_ai_search_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec]
+          #     Optional. Specification of the Vertex AI Search tool.
+          # @!attribute [rw] web_grounding_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::WebGroundingSpec]
+          #     Optional. Specification of the web grounding tool.
+          #     If field is present, enables grounding with web search. Works only if
+          #     [Assistant.web_grounding_type][google.cloud.discoveryengine.v1.Assistant.web_grounding_type]
+          #     is [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] or
+          #     [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
+          # @!attribute [rw] image_generation_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::ImageGenerationSpec]
+          #     Optional. Specification of the image generation tool.
+          # @!attribute [rw] video_generation_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VideoGenerationSpec]
+          #     Optional. Specification of the video generation tool.
+          class ToolsSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Specification of the Vertex AI Search tool.
+            # @!attribute [rw] data_store_specs
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>]
+            #     Optional. Specs defining
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to filter on in
+            #     a search call and configurations for those data stores. This is only
+            #     considered for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with
+            #     multiple data stores.
+            # @!attribute [rw] filter
+            #   @return [::String]
+            #     Optional. The filter syntax consists of an expression language for
+            #     constructing a predicate from one or more fields of the documents being
+            #     filtered. Filter expression is case-sensitive.
+            #
+            #     If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+            #
+            #     Filtering in Vertex AI Search is done by mapping the LHS filter key to
+            #     a key property defined in the Vertex AI Search backend -- this mapping
+            #     is defined by the customer in their schema. For example a media
+            #     customer might have a field 'name' in their schema. In this case the
+            #     filter would look like this: filter --> name:'ANY("king kong")'
+            #
+            #     For more information about filtering including syntax and filter
+            #     operators, see
+            #     [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+            class VertexAiSearchSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the web grounding tool.
+            class WebGroundingSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the image generation tool.
+            class ImageGenerationSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the video generation tool.
+            class VideoGenerationSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Assistant generation specification for the request.
+          # This allows to override the default generation configuration at the engine
+          # level.
+          # @!attribute [rw] model_id
+          #   @return [::String]
+          #     Optional. The Vertex AI model_id used for the generative model. If not
+          #     set, the default Assistant model will be used.
+          class GenerationSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response for the
+        # {::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client#stream_assist AssistantService.StreamAssist}
+        # method.
+        # @!attribute [rw] answer
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer]
+        #     Assist answer resource object containing parts of the assistant's final
+        #     answer for the user's query.
+        #
+        #     Not present if the current response doesn't add anything to previously
+        #     sent
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#replies AssistAnswer.replies}.
+        #
+        #     Observe
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#state AssistAnswer.state} to
+        #     see if more parts are to be expected. While the state is `IN_PROGRESS`, the
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#replies AssistAnswer.replies}
+        #     field in each response will contain replies (reply fragments) to be
+        #     appended to the ones received in previous responses. [AssistAnswer.name][]
+        #     won't be filled.
+        #
+        #     If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
+        #     is the last response and [AssistAnswer.name][] will have a value.
+        # @!attribute [rw] session_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo]
+        #     Session information.
+        # @!attribute [rw] assist_token
+        #   @return [::String]
+        #     A global unique ID that identifies the current pair of request and stream
+        #     of responses. Used for feedback and support.
+        class StreamAssistResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about the session.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Name of the newly generated or continued session.
+          #
+          #     Format:
+          #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
+          class SessionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb

@@ -926,11 +926,23 @@ module Google
         #     Provide this to retrieve the subsequent page.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     A filter to apply on the list results. The supported features are:
-        #     user_pseudo_id, state.
+        #     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`
         #
-        #     Example:
+        #     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\""
         # @!attribute [rw] order_by
         #   @return [::String]
         #     A comma-separated list of fields to order by, sorted in ascending order.

data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb

@@ -243,22 +243,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/proto_docs/google/cloud/discoveryengine/v1/session.rb

@@ -59,10 +59,11 @@ module Google
           # answer from service.
           # @!attribute [rw] query
           #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
-          #     The user query.
+          #     Optional. The user query. May not be set if this turn is merely
+          #     regenerating an answer to a different turn
           # @!attribute [rw] answer
           #   @return [::String]
-          #     The resource name of the answer to the user query.
+          #     Optional. The resource name of the answer to the user query.
           #
           #     Only set if the answer generation (/answer API call) happened in this
           #     turn.
@@ -74,9 +75,24 @@ module Google
           #     {::Google::Cloud::DiscoveryEngine::V1::GetSessionRequest#include_answer_details GetSessionRequest.include_answer_details}
           #     is set to true, this field will be populated when getting answer query
           #     session.
+          # @!attribute [rw] query_config
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. Represents metadata related to the query config, for example
+          #     LLM model and version used, model parameters (temperature, grounding
+          #     parameters, etc.). The prefix "google." is reserved for Google-developed
+          #     functionality.
           class Turn
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class QueryConfigEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # Enumeration of the state of the session.
@@ -93,9 +109,9 @@ module Google
         # @!attribute [rw] text
         #   @return [::String]
         #     Plain text.
-        # @!attribute [rw] query_id
+        # @!attribute [r] query_id
         #   @return [::String]
-        #     Unique Id for the query.
+        #     Output only. Unique Id for the query.
         class Query
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Google LLC
@@ -65,6 +65,13 @@ files:
 - README.md
 - lib/google-cloud-discovery_engine-v1.rb
 - lib/google/cloud/discovery_engine/v1.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/client.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/paths.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/rest.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1/assistant_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1/cmek_config_service.rb
 - lib/google/cloud/discovery_engine/v1/cmek_config_service/client.rb
 - lib/google/cloud/discovery_engine/v1/cmek_config_service/credentials.rb
@@ -196,6 +203,13 @@ files:
 - lib/google/cloud/discovery_engine/v1/serving_config_service/rest.rb
 - lib/google/cloud/discovery_engine/v1/serving_config_service/rest/client.rb
 - lib/google/cloud/discovery_engine/v1/serving_config_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1/session_service.rb
+- lib/google/cloud/discovery_engine/v1/session_service/client.rb
+- lib/google/cloud/discovery_engine/v1/session_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1/session_service/paths.rb
+- lib/google/cloud/discovery_engine/v1/session_service/rest.rb
+- lib/google/cloud/discovery_engine/v1/session_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1/session_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb
 - lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb
 - lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb
@@ -225,6 +239,10 @@ files:
 - lib/google/cloud/discovery_engine/v1/user_license_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1/version.rb
 - lib/google/cloud/discoveryengine/v1/answer_pb.rb
+- lib/google/cloud/discoveryengine/v1/assist_answer_pb.rb
+- lib/google/cloud/discoveryengine/v1/assistant_pb.rb
+- lib/google/cloud/discoveryengine/v1/assistant_service_pb.rb
+- lib/google/cloud/discoveryengine/v1/assistant_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1/chunk_pb.rb
 - lib/google/cloud/discoveryengine/v1/cmek_config_service_pb.rb
 - lib/google/cloud/discoveryengine/v1/cmek_config_service_services_pb.rb
@@ -276,6 +294,8 @@ files:
 - lib/google/cloud/discoveryengine/v1/serving_config_service_pb.rb
 - lib/google/cloud/discoveryengine/v1/serving_config_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1/session_pb.rb
+- lib/google/cloud/discoveryengine/v1/session_service_pb.rb
+- lib/google/cloud/discoveryengine/v1/session_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb
 - lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb
 - lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb
@@ -292,6 +312,9 @@ files:
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/discoveryengine/v1/answer.rb
+- proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb
+- proto_docs/google/cloud/discoveryengine/v1/assistant.rb
+- proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb
 - proto_docs/google/cloud/discoveryengine/v1/chunk.rb
 - proto_docs/google/cloud/discoveryengine/v1/cmek_config_service.rb
 - proto_docs/google/cloud/discoveryengine/v1/common.rb