google-cloud-discovery_engine-v1beta 0.27.0 → 0.28.0

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

@@ -840,7 +840,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil)
+            # @overload answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil, end_user_spec: nil)
             #   Pass arguments to `answer_query` 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).
@@ -850,6 +850,12 @@ module Google
             #     `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
             #     or
             #     `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
+            #
+            #     Or the resource name of the agent engine serving config, such as:
+            #     `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
+            #     (use when `enable_agent_invocation` set to true, and you have custom
+            #     `AI_MODE` agent engine configured)
+            #
             #     This field is used to identify the serving configuration name, set
             #     of models used to make the search.
             #   @param query [::Google::Cloud::DiscoveryEngine::V1beta::Query, ::Hash]
@@ -914,6 +920,8 @@ module Google
             #     See [Google Cloud
             #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
             #     for more details.
+            #   @param end_user_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec, ::Hash]
+            #     Optional. End user specification.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse]
@@ -979,6 +987,175 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Answer query method (streaming).
+            #
+            # It takes one
+            # {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest AnswerQueryRequest}
+            # and returns multiple
+            # {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse AnswerQueryResponse}
+            # messages in a stream.
+            #
+            # @overload stream_answer_query(request, options = nil)
+            #   Pass arguments to `stream_answer_query` via a request object, either of type
+            #   {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload stream_answer_query(serving_config: nil, query: nil, session: nil, safety_spec: nil, related_questions_spec: nil, grounding_spec: nil, answer_generation_spec: nil, search_spec: nil, query_understanding_spec: nil, asynchronous_mode: nil, user_pseudo_id: nil, user_labels: nil, end_user_spec: nil)
+            #   Pass arguments to `stream_answer_query` 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).
+            #
+            #   @param serving_config [::String]
+            #     Required. The resource name of the Search serving config, such as
+            #     `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
+            #     or
+            #     `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`.
+            #
+            #     Or the resource name of the agent engine serving config, such as:
+            #     `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer`.
+            #     (use when `enable_agent_invocation` set to true, and you have custom
+            #     `AI_MODE` agent engine configured)
+            #
+            #     This field is used to identify the serving configuration name, set
+            #     of models used to make the search.
+            #   @param query [::Google::Cloud::DiscoveryEngine::V1beta::Query, ::Hash]
+            #     Required. Current user query.
+            #   @param session [::String]
+            #     The session resource name. Not required.
+            #
+            #     When session field is not set, the API is in sessionless mode.
+            #
+            #     We support auto session mode: users can use the wildcard symbol `-` as
+            #     session ID.  A new ID will be automatically generated and assigned.
+            #   @param safety_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec, ::Hash]
+            #     Model specification.
+            #   @param related_questions_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec, ::Hash]
+            #     Related questions specification.
+            #   @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec, ::Hash]
+            #     Optional. Grounding specification.
+            #   @param answer_generation_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec, ::Hash]
+            #     Answer generation specification.
+            #   @param search_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec, ::Hash]
+            #     Search specification.
+            #   @param query_understanding_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec, ::Hash]
+            #     Query understanding specification.
+            #   @param asynchronous_mode [::Boolean]
+            #     Deprecated: This field is deprecated. Streaming Answer API will be
+            #     supported.
+            #
+            #     Asynchronous mode control.
+            #
+            #     If enabled, the response will be returned with answer/session resource
+            #     name without final answer. The API users need to do the polling to get
+            #     the latest status of answer/session by calling
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_answer ConversationalSearchService.GetAnswer}
+            #     or
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_session ConversationalSearchService.GetSession}
+            #     method.
+            #   @param user_pseudo_id [::String]
+            #     A unique identifier for tracking visitors. For example, this could be
+            #     implemented with an HTTP cookie, which should be able to uniquely identify
+            #     a visitor on a single device. This unique identifier should not change if
+            #     the visitor logs in or out of the website.
+            #
+            #     This field should NOT have a fixed value such as `unknown_visitor`.
+            #
+            #     The field must be a UTF-8 encoded string with a length limit of 128
+            #     characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
+            #   @param user_labels [::Hash{::String => ::String}]
+            #     The user labels applied to a resource must meet the following requirements:
+            #
+            #     * Each resource can have multiple labels, up to a maximum of 64.
+            #     * Each label must be a key-value pair.
+            #     * Keys have a minimum length of 1 character and a maximum length of 63
+            #       characters and cannot be empty. Values can be empty and have a maximum
+            #       length of 63 characters.
+            #     * Keys and values can contain only lowercase letters, numeric characters,
+            #       underscores, and dashes. All characters must use UTF-8 encoding, and
+            #       international characters are allowed.
+            #     * The key portion of a label must be unique. However, you can use the same
+            #       key with multiple resources.
+            #     * Keys must start with a lowercase letter or international character.
+            #
+            #     See [Google Cloud
+            #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+            #     for more details.
+            #   @param end_user_spec [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::EndUserSpec, ::Hash]
+            #     Optional. End user specification.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/discovery_engine/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest.new
+            #
+            #   # Call the stream_answer_query method to start streaming.
+            #   output = client.stream_answer_query request
+            #
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryResponse
+            #   output.each do |current_response|
+            #     p current_response
+            #   end
+            #
+            def stream_answer_query request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.stream_answer_query.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::DiscoveryEngine::V1beta::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.serving_config
+                header_params["serving_config"] = request.serving_config
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.stream_answer_query.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.stream_answer_query.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @conversational_search_service_stub.call_rpc :stream_answer_query, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Gets a Answer.
             #
@@ -1081,7 +1258,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload create_session(parent: nil, session: nil)
+            # @overload create_session(parent: nil, session: nil, session_id: nil)
             #   Pass arguments to `create_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).
@@ -1091,6 +1268,13 @@ module Google
             #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
             #   @param session [::Google::Cloud::DiscoveryEngine::V1beta::Session, ::Hash]
             #     Required. The session to create.
+            #   @param session_id [::String]
+            #     Optional. The ID to use for the session, which will become the final
+            #     component of the session's resource name.
+            #
+            #     This value should be 1-63 characters, and valid characters
+            #     are /[a-z0-9][a-z0-9-]\\{0,61}[a-z0-9]/. If not specified, a unique ID will
+            #     be generated.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Session]
@@ -1461,7 +1645,9 @@ module Google
             #     Provide this to retrieve the subsequent page.
             #   @param filter [::String]
             #     A comma-separated list of fields to filter by, in EBNF grammar.
+            #
             #     The supported fields are:
+            #
             #     * `user_pseudo_id`
             #     * `state`
             #     * `display_name`
@@ -1470,28 +1656,35 @@ module Google
             #     * `labels`
             #     * `create_time`
             #     * `update_time`
+            #     * `collaborative_project`
             #
             #     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\""
+            #
+            #     * `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"`
+            #     * `collaborative_project =
+            #          "projects/123/locations/global/collections/default_collection/engines/"
+            #          "default_engine/collaborative_projects/cp1"`
             #   @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`
+            #       * `display_name`
             #
             #     Example:
             #
-            #     * "update_time desc"
-            #     * "create_time"
-            #     * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+            #     * `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
@@ -1785,6 +1978,11 @@ module Google
                 #
                 attr_reader :answer_query
                 ##
+                # RPC-specific configuration for `stream_answer_query`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :stream_answer_query
+                ##
                 # RPC-specific configuration for `get_answer`
                 # @return [::Gapic::Config::Method]
                 #
@@ -1831,6 +2029,8 @@ module Google
                   @list_conversations = ::Gapic::Config::Method.new list_conversations_config
                   answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query
                   @answer_query = ::Gapic::Config::Method.new answer_query_config
+                  stream_answer_query_config = parent_rpcs.stream_answer_query if parent_rpcs.respond_to? :stream_answer_query
+                  @stream_answer_query = ::Gapic::Config::Method.new stream_answer_query_config
                   get_answer_config = parent_rpcs.get_answer if parent_rpcs.respond_to? :get_answer
                   @get_answer = ::Gapic::Config::Method.new get_answer_config
                   create_session_config = parent_rpcs.create_session if parent_rpcs.respond_to? :create_session

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

@@ -26,7 +26,9 @@ module Google
           # Credentials for the ConversationalSearchService API.
           class Credentials < ::Google::Auth::Credentials
             self.scope = [
-              "https://www.googleapis.com/auth/cloud-platform"
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/discoveryengine.readwrite",
+              "https://www.googleapis.com/auth/discoveryengine.serving.readwrite"
             ]
             self.env_vars = [
               "GOOGLE_CLOUD_CREDENTIALS",

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

@@ -98,6 +98,31 @@ module Google
               resource.call(**args)
             end
 
+            ##
+            # Create a fully-qualified AssistAnswer resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param collection [String]
+            # @param engine [String]
+            # @param session [String]
+            # @param assist_answer [String]
+            #
+            # @return [::String]
+            def assist_answer_path project:, location:, collection:, engine:, session:, assist_answer:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+              raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
+              raise ::ArgumentError, "session cannot contain /" if session.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/sessions/#{session}/assistAnswers/#{assist_answer}"
+            end
+
             ##
             # Create a fully-qualified Chunk resource string.
             #
@@ -424,6 +449,18 @@ module Google
             #   @param engine [String]
             #   @param session [String]
             #
+            # @overload session_path(project:, location:, collection:, engine:, collaborative_project:, session:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/collaborativeProjects/{collaborative_project}/sessions/{session}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param engine [String]
+            #   @param collaborative_project [String]
+            #   @param session [String]
+            #
             # @return [::String]
             def session_path **args
               resources = {
@@ -449,6 +486,15 @@ module Google
                   raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
 
                   "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/sessions/#{session}"
+                end),
+                "collaborative_project:collection:engine:location:project:session" => (proc do |project:, location:, collection:, engine:, collaborative_project:, session:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+                  raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
+                  raise ::ArgumentError, "collaborative_project cannot contain /" if collaborative_project.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/collaborativeProjects/#{collaborative_project}/sessions/#{session}"
                 end)
               }