google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb

@@ -99,6 +99,82 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the import_suggestion_deny_list_entries REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def import_suggestion_deny_list_entries request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_import_suggestion_deny_list_entries_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the purge_suggestion_deny_list_entries REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def purge_suggestion_deny_list_entries request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_purge_suggestion_deny_list_entries_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # @private
               #
@@ -126,6 +202,66 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the import_suggestion_deny_list_entries REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_import_suggestion_deny_list_entries_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/suggestionDenyListEntries:import",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/suggestionDenyListEntries:import",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the purge_suggestion_deny_list_entries REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_purge_suggestion_deny_list_entries_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/suggestionDenyListEntries:purge",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/suggestionDenyListEntries:purge",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/dataStores(?:/.*)?$}, true]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb

@@ -24,6 +24,7 @@ require "google/cloud/discovery_engine/v1/version"
 
 require "google/cloud/discovery_engine/v1/completion_service/credentials"
 require "google/cloud/discovery_engine/v1/completion_service/paths"
+require "google/cloud/discovery_engine/v1/completion_service/rest/operations"
 require "google/cloud/discovery_engine/v1/completion_service/rest/client"
 
 module Google

data/lib/google/cloud/discovery_engine/v1/completion_service.rb

@@ -24,6 +24,7 @@ require "google/cloud/discovery_engine/v1/version"
 
 require "google/cloud/discovery_engine/v1/completion_service/credentials"
 require "google/cloud/discovery_engine/v1/completion_service/paths"
+require "google/cloud/discovery_engine/v1/completion_service/operations"
 require "google/cloud/discovery_engine/v1/completion_service/client"
 require "google/cloud/discovery_engine/v1/completion_service/rest"
 

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

@@ -193,7 +193,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil)
+            # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
             #   Pass arguments to `converse_conversation` 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).
@@ -237,6 +237,23 @@ module Google
             #     for more details.
             #   @param summary_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash]
             #     A specification for configuring the summary returned in the response.
+            #   @param filter [::String]
+            #     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. This will be used to filter search results
+            #     which may affect the summary response.
+            #
+            #     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)
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse]
@@ -512,7 +529,7 @@ module Google
             #     {::Google::Cloud::DiscoveryEngine::V1::Conversation Conversation} to update. The
             #     following are NOT supported:
             #
-            #     * [conversation.name][]
+            #     * {::Google::Cloud::DiscoveryEngine::V1::Conversation#name Conversation.name}
             #
             #     If not set or empty, all supported fields are updated.
             #
@@ -668,7 +685,7 @@ module Google
 
             ##
             # Lists all Conversations by their parent
-            # [DataStore][google.cloud.discoveryengine.v1.DataStore].
+            # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}.
             #
             # @overload list_conversations(request, options = nil)
             #   Pass arguments to `list_conversations` via a request object, either of type

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

@@ -48,6 +48,17 @@ module Google
             #   @param data_store [String]
             #   @param conversation [String]
             #
+            # @overload conversation_path(project:, location:, collection:, engine:, conversation:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param engine [String]
+            #   @param conversation [String]
+            #
             # @return [::String]
             def conversation_path **args
               resources = {
@@ -65,6 +76,14 @@ module Google
                   raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
 
                   "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/conversations/#{conversation}"
+                end),
+                "collection:conversation:engine:location:project" => (proc do |project:, location:, collection:, engine:, conversation:|
+                  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? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/conversations/#{conversation}"
                 end)
               }
 
@@ -118,6 +137,59 @@ module Google
               resource.call(**args)
             end
 
+            ##
+            # Create a fully-qualified Document resource string.
+            #
+            # @overload document_path(project:, location:, data_store:, branch:, document:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param data_store [String]
+            #   @param branch [String]
+            #   @param document [String]
+            #
+            # @overload document_path(project:, location:, collection:, data_store:, branch:, document:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param data_store [String]
+            #   @param branch [String]
+            #   @param document [String]
+            #
+            # @return [::String]
+            def document_path **args
+              resources = {
+                "branch:data_store:document:location:project" => (proc do |project:, location:, data_store:, branch:, document:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
+                  raise ::ArgumentError, "branch cannot contain /" if branch.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/dataStores/#{data_store}/branches/#{branch}/documents/#{document}"
+                end),
+                "branch:collection:data_store:document:location:project" => (proc do |project:, location:, collection:, data_store:, branch:, document:|
+                  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, "data_store cannot contain /" if data_store.to_s.include? "/"
+                  raise ::ArgumentError, "branch cannot contain /" if branch.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/branches/#{branch}/documents/#{document}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
             ##
             # Create a fully-qualified ServingConfig resource string.
             #
@@ -142,6 +214,17 @@ module Google
             #   @param data_store [String]
             #   @param serving_config [String]
             #
+            # @overload serving_config_path(project:, location:, collection:, engine:, serving_config:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param engine [String]
+            #   @param serving_config [String]
+            #
             # @return [::String]
             def serving_config_path **args
               resources = {
@@ -159,6 +242,14 @@ module Google
                   raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
 
                   "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/servingConfigs/#{serving_config}"
+                end),
+                "collection:engine:location:project:serving_config" => (proc do |project:, location:, collection:, engine:, serving_config:|
+                  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? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/servingConfigs/#{serving_config}"
                 end)
               }
 

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

@@ -186,7 +186,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil)
+              # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
               #   Pass arguments to `converse_conversation` 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).
@@ -230,6 +230,23 @@ module Google
               #     for more details.
               #   @param summary_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash]
               #     A specification for configuring the summary returned in the response.
+              #   @param filter [::String]
+              #     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. This will be used to filter search results
+              #     which may affect the summary response.
+              #
+              #     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)
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -484,7 +501,7 @@ module Google
               #     {::Google::Cloud::DiscoveryEngine::V1::Conversation Conversation} to update. The
               #     following are NOT supported:
               #
-              #     * [conversation.name][]
+              #     * {::Google::Cloud::DiscoveryEngine::V1::Conversation#name Conversation.name}
               #
               #     If not set or empty, all supported fields are updated.
               # @yield [result, operation] Access the result along with the TransportOperation object
@@ -626,7 +643,7 @@ module Google
 
               ##
               # Lists all Conversations by their parent
-              # [DataStore][google.cloud.discoveryengine.v1.DataStore].
+              # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}.
               #
               # @overload list_conversations(request, options = nil)
               #   Pass arguments to `list_conversations` via a request object, either of type

data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb

@@ -316,6 +316,14 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{name}:converse",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
 
@@ -346,6 +354,14 @@ module Google
                                                             ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{parent}/conversations",
+                                                          body: "conversation",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
 
@@ -374,6 +390,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :delete,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
 
@@ -404,6 +427,14 @@ module Google
                                                             ["conversation.name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :patch,
+                                                          uri_template: "/v1/{conversation.name}",
+                                                          body: "conversation",
+                                                          matches: [
+                                                            ["conversation.name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
 
@@ -432,6 +463,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
 
@@ -460,6 +498,13 @@ module Google
                                                             ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{parent}/conversations",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                 transcoder.transcode request_pb
               end
             end