google-cloud-discovery_engine-v1 0.1.0 → 0.3.0

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

@@ -57,7 +57,7 @@ module Google
         #     quality.
         #
         #     The field must be a UTF-8 encoded string with a length limit of 128
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         #
         #     The field should not contain PII or user-data. We recommend to use Google
         #     Analytics [Client
@@ -110,20 +110,17 @@ module Google
         #
         #     The value must be one of:
         #
-        #     * [PredictResponse.attribution_token][] for events that are the result of
+        #     * [RecommendResponse.attribution_token][] for events that are the result of
         #     [RecommendationService.Recommend][].
         #     * {::Google::Cloud::DiscoveryEngine::V1::SearchResponse#attribution_token SearchResponse.attribution_token} for events that are the result of
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}.
-        #     * [CompleteQueryResponse.attribution_token][] for events that are the
-        #     result of
-        #     {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#complete_query CompletionService.CompleteQuery}.
         #
         #     This token enables us to accurately attribute page view or conversion
         #     completion back to the event and the particular predict response containing
         #     this clicked/purchased product. If user clicks on product K in the
-        #     recommendation results, pass [PredictResponse.attribution_token][] as a URL
-        #     parameter to product K's page. When recording events on product K's page,
-        #     log the [PredictResponse.attribution_token][] to this field.
+        #     recommendation results, pass [RecommendResponse.attribution_token][] as a
+        #     URL parameter to product K's page. When recording events on product K's
+        #     page, log the [RecommendResponse.attribution_token][] to this field.
         # @!attribute [rw] filter
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
@@ -131,8 +128,9 @@ module Google
         #
         #     One example is for `search` events, the associated
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} may contain
-        #     a filter expression in [SearchRequest.filter][] conforming to
-        #     https://google.aip.dev/160#filtering.
+        #     a filter expression in
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}
+        #     conforming to https://google.aip.dev/160#filtering.
         #
         #     Similarly, for `view-item-list` events that are generated from a
         #     [RecommendationService.RecommendRequest][], this field may be populated
@@ -140,10 +138,11 @@ module Google
         #     to https://google.aip.dev/160#filtering.
         #
         #     The value must be a UTF-8 encoded string with a length limit of 1,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] documents
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::DocumentInfo>]
-        #     List of Documents associated with this user event.
+        #     List of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s associated
+        #     with this user event.
         #
         #     This field is optional except for the following event types:
         #
@@ -165,12 +164,14 @@ module Google
         #     Panel metadata associated with this user event.
         # @!attribute [rw] search_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchInfo]
-        #     Search API details related to the event.
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Client#search SearchService.Search}
+        #     details related to the event.
         #
         #     This field should be set for `search` event.
         # @!attribute [rw] completion_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::CompletionInfo]
-        #     CompleteQuery API details related to the event.
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#complete_query CompletionService.CompleteQuery}
+        #     details related to the event.
         #
         #     This field should be set for `search` event when autocomplete function is
         #     enabled and the user clicks a suggestion for search.
@@ -210,7 +211,7 @@ module Google
         #     * For number attributes, at most 400 values are allowed.
         #
         #     For product recommendations, an example of extra user information is
-        #     ` traffic_channel`, which is how a user arrives at the site. Users can
+        #     `traffic_channel`, which is how a user arrives at the site. Users can
         #     arrive
         #     at the site by coming to the site directly, coming through Google
         #     search, or in other ways.
@@ -238,7 +239,7 @@ module Google
         #
         #     This should be kept the same for all user events triggered from the same
         #     pageview. For example, an item detail page view could trigger multiple
-        #     events as the user is browsing the page. The `pageViewId` property should
+        #     events as the user is browsing the page. The `pageview_id` property should
         #     be kept the same for all these events so that they can be grouped together
         #     properly.
         #
@@ -254,10 +255,10 @@ module Google
         #
         #     Category pages include special pages such as sales or promotions. For
         #     instance, a special sale page may have the category hierarchy:
-        #     "pageCategory" : "Sales > 2017 Black Friday Deals".
+        #     `"pageCategory" : "Sales > 2017 Black Friday Deals"`.
         #
         #     Required for `view-category-page` events. Other event types should not set
-        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] uri
         #   @return [::String]
         #     Complete URL (window.location.href) of the user's current page.
@@ -287,24 +288,26 @@ module Google
         #     for definition.
         #
         #     The value must be a UTF-8 encoded string with a length limit of 5,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         #
         #     At least one of
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchInfo#search_query search_query} or
         #     {::Google::Cloud::DiscoveryEngine::V1::PageInfo#page_category PageInfo.page_category}
         #     is required for `search` events. Other event types should not set this
-        #     field. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     field. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     The order in which products are returned, if applicable.
         #
-        #     See [SearchRequest.order_by][] for definition and syntax.
+        #     See
+        #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#order_by SearchRequest.order_by}
+        #     for definition and syntax.
         #
         #     The value must be a UTF-8 encoded string with a length limit of 1,000
-        #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
         #
         #     This can only be set for `search` events. Other event types should not set
-        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] offset
         #   @return [::Integer]
         #     An integer that specifies the current offset for pagination (the 0-indexed
@@ -314,10 +317,10 @@ module Google
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#offset SearchRequest.offset}
         #     for definition.
         #
-        #     If this field is negative, an INVALID_ARGUMENT is returned.
+        #     If this field is negative, an `INVALID_ARGUMENT` is returned.
         #
         #     This can only be set for `search` events. Other event types should not set
-        #     this field. Otherwise, an INVALID_ARGUMENT error is returned.
+        #     this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
         class SearchInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -327,10 +330,12 @@ module Google
         # clicked completion info.
         # @!attribute [rw] selected_suggestion
         #   @return [::String]
-        #     End user selected [CompleteQueryResponse.CompletionResult.suggestion][].
+        #     End user selected
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}.
         # @!attribute [rw] selected_position
         #   @return [::Integer]
-        #     End user selected [CompleteQueryResponse.CompletionResult.suggestion][]
+        #     End user selected
+        #     {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}
         #     position, starting from 0.
         class CompletionInfo
           include ::Google::Protobuf::MessageExts
@@ -391,11 +396,16 @@ module Google
         # Detailed document information associated with a user event.
         # @!attribute [rw] id
         #   @return [::String]
-        #     Required. The Document resource ID.
+        #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document} resource ID.
         # @!attribute [rw] name
         #   @return [::String]
-        #     Required. The Document resource full name, of the form:
+        #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document} resource full
+        #     name, of the form:
         #     `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
+        # @!attribute [rw] uri
+        #   @return [::String]
+        #     The {::Google::Cloud::DiscoveryEngine::V1::Document Document} URI - only
+        #     allowed for website data stores.
         # @!attribute [rw] quantity
         #   @return [::Integer]
         #     Quantity of the Document associated with the user event. Defaults to 1.
@@ -445,11 +455,13 @@ module Google
         #   @return [::Google::Protobuf::Duration]
         #     The media progress time in seconds, if applicable.
         #     For example, if the end user has finished 90 seconds of a playback video,
-        #     then [MediaInfo.media_progress_duration.seconds][Duration.seconds] should
-        #     be set to 90.
+        #     then
+        #     {::Google::Protobuf::Duration#seconds MediaInfo.media_progress_duration.seconds}
+        #     should be set to 90.
         # @!attribute [rw] media_progress_percentage
         #   @return [::Float]
-        #     Media progress should be computed using only the media_progress_duration
+        #     Media progress should be computed using only the
+        #     {::Google::Cloud::DiscoveryEngine::V1::MediaInfo#media_progress_duration media_progress_duration}
         #     relative to the media total length.
         #
         #     This value must be between `[0, 1.0]` inclusive.

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

@@ -47,7 +47,7 @@ module Google
         #   @return [::String]
         #     The URL including cgi-parameters but excluding the hash fragment with a
         #     length limit of 5,000 characters. This is often more useful than the
-        #     referer URL, because many browsers only send the domain for 3rd party
+        #     referer URL, because many browsers only send the domain for third-party
         #     requests.
         # @!attribute [rw] ets
         #   @return [::Integer]

data/proto_docs/google/protobuf/field_mask.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # # Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # # Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # ## Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # # JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # # Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # ## Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is unmappable.
+    # @!attribute [rw] paths
+    #   @return [::Array<::String>]
+    #     The set of field mask paths.
+    class FieldMask
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-discovery_engine-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-12 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +197,13 @@ files:
 - lib/google/cloud/discovery_engine/v1/completion_service/rest.rb
 - lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb
 - lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/credentials.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/rest.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb
+- lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb
 - lib/google/cloud/discovery_engine/v1/document_service.rb
 - lib/google/cloud/discovery_engine/v1/document_service/client.rb
 - lib/google/cloud/discovery_engine/v1/document_service/credentials.rb
@@ -216,6 +243,9 @@ files:
 - lib/google/cloud/discoveryengine/v1/common_pb.rb
 - lib/google/cloud/discoveryengine/v1/completion_service_pb.rb
 - lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb
+- lib/google/cloud/discoveryengine/v1/conversation_pb.rb
+- lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb
+- lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb
 - lib/google/cloud/discoveryengine/v1/document_pb.rb
 - lib/google/cloud/discoveryengine/v1/document_service_pb.rb
 - lib/google/cloud/discoveryengine/v1/document_service_services_pb.rb
@@ -237,6 +267,8 @@ files:
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/discoveryengine/v1/common.rb
 - proto_docs/google/cloud/discoveryengine/v1/completion_service.rb
+- proto_docs/google/cloud/discoveryengine/v1/conversation.rb
+- proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb
 - proto_docs/google/cloud/discoveryengine/v1/document.rb
 - proto_docs/google/cloud/discoveryengine/v1/document_service.rb
 - proto_docs/google/cloud/discoveryengine/v1/import_config.rb
@@ -250,6 +282,7 @@ files:
 - proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
+- proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/struct.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
@@ -273,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Discovery Engine API.