google-cloud-discovery_engine-v1 1.0.2 → 1.2.0

data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb

@@ -10,11 +10,12 @@ require 'google/api/field_behavior_pb'
 require 'google/api/httpbody_pb'
 require 'google/api/resource_pb'
 require 'google/cloud/discoveryengine/v1/import_config_pb'
+require 'google/cloud/discoveryengine/v1/purge_config_pb'
 require 'google/cloud/discoveryengine/v1/user_event_pb'
 require 'google/longrunning/operations_pb'
 
 
-descriptor_data = "\n8google/cloud/discoveryengine/v1/user_event_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/httpbody.proto\x1a\x19google/api/resource.proto\x1a\x33google/cloud/discoveryengine/v1/import_config.proto\x1a\x30google/cloud/discoveryengine/v1/user_event.proto\x1a#google/longrunning/operations.proto\"\xc7\x01\n\x15WriteUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12H\n\nuser_event\x18\x02 \x01(\x0b\x32*.google.cloud.discoveryengine.v1.UserEventB\x03\xe0\x41\x02H\x00\x88\x01\x01\x12\x13\n\x0bwrite_async\x18\x03 \x01(\x08\x42\r\n\x0b_user_event\"\xa8\x01\n\x17\x43ollectUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x17\n\nuser_event\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x10\n\x03uri\x18\x03 \x01(\tH\x00\x88\x01\x01\x12\x10\n\x03\x65ts\x18\x04 \x01(\x03H\x01\x88\x01\x01\x42\x06\n\x04_uriB\x06\n\x04_ets2\xa9\t\n\x10UserEventService\x12\xf0\x02\n\x0eWriteUserEvent\x12\x36.google.cloud.discoveryengine.v1.WriteUserEventRequest\x1a*.google.cloud.discoveryengine.v1.UserEvent\"\xf9\x01\x82\xd3\xe4\x93\x02\xf2\x01\"A/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:write:\nuser_eventZ]\"O/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write:\nuser_eventZB\"4/v1/{parent=projects/*/locations/*}/userEvents:write:\nuser_event\x12\xc0\x02\n\x10\x43ollectUserEvent\x12\x38.google.cloud.discoveryengine.v1.CollectUserEventRequest\x1a\x14.google.api.HttpBody\"\xdb\x01\x82\xd3\xe4\x93\x02\xd4\x01\x12\x43/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:collectZS\x12Q/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collectZ8\x12\x36/v1/{parent=projects/*/locations/*}/userEvents:collect\x12\x8a\x03\n\x10ImportUserEvents\x12\x38.google.cloud.discoveryengine.v1.ImportUserEventsRequest\x1a\x1d.google.longrunning.Operation\"\x9c\x02\xca\x41t\n8google.cloud.discoveryengine.v1.ImportUserEventsResponse\x12\x38google.cloud.discoveryengine.v1.ImportUserEventsMetadata\x82\xd3\xe4\x93\x02\x9e\x01\"B/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:import:\x01*ZU\"P/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x88\x02\n#com.google.cloud.discoveryengine.v1B\x15UserEventServiceProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
+descriptor_data = "\n8google/cloud/discoveryengine/v1/user_event_service.proto\x12\x1fgoogle.cloud.discoveryengine.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/httpbody.proto\x1a\x19google/api/resource.proto\x1a\x33google/cloud/discoveryengine/v1/import_config.proto\x1a\x32google/cloud/discoveryengine/v1/purge_config.proto\x1a\x30google/cloud/discoveryengine/v1/user_event.proto\x1a#google/longrunning/operations.proto\"\xc7\x01\n\x15WriteUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12H\n\nuser_event\x18\x02 \x01(\x0b\x32*.google.cloud.discoveryengine.v1.UserEventB\x03\xe0\x41\x02H\x00\x88\x01\x01\x12\x13\n\x0bwrite_async\x18\x03 \x01(\x08\x42\r\n\x0b_user_event\"\xa8\x01\n\x17\x43ollectUserEventRequest\x12@\n\x06parent\x18\x01 \x01(\tB0\xe0\x41\x02\xfa\x41*\n(discoveryengine.googleapis.com/DataStore\x12\x17\n\nuser_event\x18\x02 \x01(\tB\x03\xe0\x41\x02\x12\x10\n\x03uri\x18\x03 \x01(\tH\x00\x88\x01\x01\x12\x10\n\x03\x65ts\x18\x04 \x01(\x03H\x01\x88\x01\x01\x42\x06\n\x04_uriB\x06\n\x04_ets2\xb0\x0c\n\x10UserEventService\x12\xf0\x02\n\x0eWriteUserEvent\x12\x36.google.cloud.discoveryengine.v1.WriteUserEventRequest\x1a*.google.cloud.discoveryengine.v1.UserEvent\"\xf9\x01\x82\xd3\xe4\x93\x02\xf2\x01\"A/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:write:\nuser_eventZ]\"O/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:write:\nuser_eventZB\"4/v1/{parent=projects/*/locations/*}/userEvents:write:\nuser_event\x12\xc0\x02\n\x10\x43ollectUserEvent\x12\x38.google.cloud.discoveryengine.v1.CollectUserEventRequest\x1a\x14.google.api.HttpBody\"\xdb\x01\x82\xd3\xe4\x93\x02\xd4\x01\x12\x43/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:collectZS\x12Q/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collectZ8\x12\x36/v1/{parent=projects/*/locations/*}/userEvents:collect\x12\x84\x03\n\x0fPurgeUserEvents\x12\x37.google.cloud.discoveryengine.v1.PurgeUserEventsRequest\x1a\x1d.google.longrunning.Operation\"\x98\x02\xca\x41r\n7google.cloud.discoveryengine.v1.PurgeUserEventsResponse\x12\x37google.cloud.discoveryengine.v1.PurgeUserEventsMetadata\x82\xd3\xe4\x93\x02\x9c\x01\"A/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:purge:\x01*ZT\"O/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:purge:\x01*\x12\x8a\x03\n\x10ImportUserEvents\x12\x38.google.cloud.discoveryengine.v1.ImportUserEventsRequest\x1a\x1d.google.longrunning.Operation\"\x9c\x02\xca\x41t\n8google.cloud.discoveryengine.v1.ImportUserEventsResponse\x12\x38google.cloud.discoveryengine.v1.ImportUserEventsMetadata\x82\xd3\xe4\x93\x02\x9e\x01\"B/v1/{parent=projects/*/locations/*/dataStores/*}/userEvents:import:\x01*ZU\"P/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:import:\x01*\x1aR\xca\x41\x1e\x64iscoveryengine.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x88\x02\n#com.google.cloud.discoveryengine.v1B\x15UserEventServiceProtoP\x01ZMcloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb\xa2\x02\x0f\x44ISCOVERYENGINE\xaa\x02\x1fGoogle.Cloud.DiscoveryEngine.V1\xca\x02\x1fGoogle\\Cloud\\DiscoveryEngine\\V1\xea\x02\"Google::Cloud::DiscoveryEngine::V1b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 

data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb

@@ -41,6 +41,11 @@ module Google
             # This method is used only by the Discovery Engine API JavaScript pixel and
             # Google Tag Manager. Users should not call this method directly.
             rpc :CollectUserEvent, ::Google::Cloud::DiscoveryEngine::V1::CollectUserEventRequest, ::Google::Api::HttpBody
+            # Deletes permanently all user events specified by the filter provided.
+            # Depending on the number of events specified by the filter, this operation
+            # could take hours or days to complete. To test a filter, use the list
+            # command first.
+            rpc :PurgeUserEvents, ::Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest, ::Google::Longrunning::Operation
             # Bulk import of user events. Request processing might be
             # synchronous. Events that already exist are skipped.
             # Use this method for backfilling historical user events.

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

@@ -93,6 +93,9 @@ module Google
           # @!attribute [rw] chunk_info
           #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo]
           #     Chunk information.
+          # @!attribute [rw] structured_document_info
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::StructuredDocumentInfo]
+          #     Structured document information.
           class Reference
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -125,6 +128,13 @@ module Google
               # @!attribute [rw] page_identifier
               #   @return [::String]
               #     Page identifier.
+              # @!attribute [rw] relevance_score
+              #   @return [::Float]
+              #     The relevance of the chunk for a given query. Values range from 0.0
+              #     (completely irrelevant) to 1.0 (completely relevant).
+              #     This value is for informational purpose only. It may change for
+              #     the same query and chunk at any time due to a model retraining or
+              #     change in implementation.
               class ChunkContent
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -140,7 +150,11 @@ module Google
             #     Chunk textual content.
             # @!attribute [rw] relevance_score
             #   @return [::Float]
-            #     Relevance score.
+            #     The relevance of the chunk for a given query. Values range from 0.0
+            #     (completely irrelevant) to 1.0 (completely relevant).
+            #     This value is for informational purpose only. It may change for
+            #     the same query and chunk at any time due to a model retraining or
+            #     change in implementation.
             # @!attribute [rw] document_metadata
             #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata]
             #     Document metadata.
@@ -170,6 +184,18 @@ module Google
                 extend ::Google::Protobuf::MessageExts::ClassMethods
               end
             end
+
+            # Structured search information.
+            # @!attribute [rw] document
+            #   @return [::String]
+            #     Document resource name.
+            # @!attribute [rw] struct_data
+            #   @return [::Google::Protobuf::Struct]
+            #     Structured search data.
+            class StructuredDocumentInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # Step information.
@@ -239,9 +265,8 @@ module Google
                 #   @return [::Google::Protobuf::Struct]
                 #     Data representation.
                 #     The structured JSON data for the document.
-                #     It's populated from the struct data from the Document (code
-                #     pointer: http://shortn/_objzAfIiHq), or the Chunk in search result
-                #     (code pointer: http://shortn/_Ipo6KFFGBL).
+                #     It's populated from the struct data from the Document, or the
+                #     Chunk in search result.
                 class SearchResult
                   include ::Google::Protobuf::MessageExts
                   extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -267,7 +292,11 @@ module Google
                   #     Chunk textual content.
                   # @!attribute [rw] relevance_score
                   #   @return [::Float]
-                  #     Relevance score.
+                  #     The relevance of the chunk for a given query. Values range from
+                  #     0.0 (completely irrelevant) to 1.0 (completely relevant).
+                  #     This value is for informational purpose only. It may change for
+                  #     the same query and chunk at any time due to a model retraining or
+                  #     change in implementation.
                   class ChunkInfo
                     include ::Google::Protobuf::MessageExts
                     extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,8 +348,14 @@ module Google
                 # Adversarial query classification type.
                 ADVERSARIAL_QUERY = 1
 
-                # Non-answer-seeking query classification type.
+                # Non-answer-seeking query classification type, for chit chat.
                 NON_ANSWER_SEEKING_QUERY = 2
+
+                # Jail-breaking query classification type.
+                JAIL_BREAKING_QUERY = 3
+
+                # Non-answer-seeking query classification type, for no clear intent.
+                NON_ANSWER_SEEKING_QUERY_V2 = 4
               end
             end
           end
@@ -348,7 +383,9 @@ module Google
             # The adversarial query ignored case.
             ADVERSARIAL_QUERY_IGNORED = 1
 
-            # The non-answer seeking query ignored case.
+            # The non-answer seeking query ignored case
+            #
+            # Google skips the answer if the query is chit chat.
             NON_ANSWER_SEEKING_QUERY_IGNORED = 2
 
             # The out-of-domain query ignored case.
@@ -367,6 +404,24 @@ module Google
             # Google skips the answer if there is no relevant content in the
             # retrieved search results.
             NO_RELEVANT_CONTENT = 5
+
+            # The jail-breaking query ignored case.
+            #
+            # For example, "Reply in the tone of a competing company's CEO".
+            # Google skips the answer if the query is classified as a jail-breaking
+            # query.
+            JAIL_BREAKING_QUERY_IGNORED = 6
+
+            # The customer policy violation case.
+            #
+            # Google skips the summary if there is a customer policy violation
+            # detected. The policy is defined by the customer.
+            CUSTOMER_POLICY_VIOLATION = 7
+
+            # The non-answer seeking query ignored case.
+            #
+            # Google skips the answer if the query doesn't have clear intent.
+            NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8
           end
         end
       end

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

@@ -73,8 +73,9 @@ module Google
         end
 
         # Defines a conditioned behavior to employ during serving.
-        # Must be attached to a [ServingConfig][] to be considered at serving time.
-        # Permitted actions dependent on `SolutionType`.
+        # Must be attached to a
+        # [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to be
+        # considered at serving time. Permitted actions dependent on `SolutionType`.
         # @!attribute [rw] boost_action
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction]
         #     Defines a boost-type control
@@ -100,8 +101,9 @@ module Google
         #     Otherwise an INVALID ARGUMENT error is thrown.
         # @!attribute [r] associated_serving_config_ids
         #   @return [::Array<::String>]
-        #     Output only. List of all [ServingConfig][] ids this control is attached to.
-        #     May take up to 10 minutes to update after changes.
+        #     Output only. List of all
+        #     [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] IDs this
+        #     control is attached to. May take up to 10 minutes to update after changes.
         # @!attribute [rw] solution_type
         #   @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
         #     Required. Immutable. What solution the control belongs to.

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

@@ -25,9 +25,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Full resource name of parent data store. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
         #     or
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
         # @!attribute [rw] control
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Control]
         #     Required. The Control to create.
@@ -66,7 +66,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Control to delete. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
         class DeleteControlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,7 +76,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Control to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
         class GetControlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -86,9 +86,9 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The data store resource name. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
         #     or
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return. If unspecified, defaults

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

@@ -27,9 +27,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Conversation to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
         #     Use
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
         #     to activate auto session mode, which automatically creates a new
         #     conversation inside a ConverseConversation session.
         # @!attribute [rw] query
@@ -38,7 +38,7 @@ module Google
         # @!attribute [rw] serving_config
         #   @return [::String]
         #     The resource name of the Serving Config to use. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
         #     If this is not set, the default serving config will be used.
         # @!attribute [rw] conversation
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
@@ -128,7 +128,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Full resource name of parent data store. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
         # @!attribute [rw] conversation
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
         #     Required. The conversation to create.
@@ -159,7 +159,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Conversation to delete. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
         class DeleteConversationRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -169,7 +169,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Conversation to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
         class GetConversationRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -179,7 +179,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The data store resource name. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of results to return. If unspecified, defaults
@@ -262,7 +262,11 @@ module Google
         #   @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec]
         #     Query understanding specification.
         # @!attribute [rw] asynchronous_mode
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::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
@@ -370,6 +374,19 @@ module Google
           #     If this field is set to `false`, all search results are used regardless
           #     of relevance to generate answers. If set to `true` or unset, the behavior
           #     will be determined automatically by the service.
+          # @!attribute [rw] ignore_jail_breaking_query
+          #   @return [::Boolean]
+          #     Optional. Specifies whether to filter out jail-breaking queries. The
+          #     default value is `false`.
+          #
+          #     Google employs search-query classification to detect jail-breaking
+          #     queries. No summary is returned if the search query is classified as a
+          #     jail-breaking query. A user might add instructions to the query to
+          #     change the tone, style, language, content of the answer, or ask the
+          #     model to act as a different entity, e.g. "Reply in the tone of a
+          #     competing company's CEO". If this field is set to `true`, we skip
+          #     generating summaries for jail-breaking queries and return fallback
+          #     messages instead.
           class AnswerGenerationSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -446,12 +463,7 @@ module Google
             # @!attribute [rw] search_result_mode
             #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode]
             #     Specifies the search result mode. If unspecified, the
-            #     search result mode is based on
-            #     [DataStore.DocumentProcessingConfig.chunking_config][]:
-            #     * If [DataStore.DocumentProcessingConfig.chunking_config][] is
-            #     specified,
-            #       it defaults to `CHUNKS`.
-            #     * Otherwise, it defaults to `DOCUMENTS`.
+            #     search result mode defaults to `DOCUMENTS`.
             #     See [parse and chunk
             #     documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
             # @!attribute [rw] data_store_specs
@@ -496,12 +508,18 @@ module Google
                 #     Title.
                 # @!attribute [rw] document_contexts
                 #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
-                #     List of document contexts.
+                #     List of document contexts. The content will be used for Answer
+                #     Generation. This is supposed to be the main content of the document
+                #     that can be long and comprehensive.
                 # @!attribute [rw] extractive_segments
                 #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
                 #     List of extractive segments.
                 # @!attribute [rw] extractive_answers
+                #   @deprecated This field is deprecated and may be removed in the next major version update.
                 #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
+                #     Deprecated: This field is deprecated and will have no effect on
+                #     the Answer generation.
+                #     Please use document_contexts and extractive_segments fields.
                 #     List of extractive answers.
                 class UnstructuredDocumentInfo
                   include ::Google::Protobuf::MessageExts
@@ -513,7 +531,7 @@ module Google
                   #     Page identifier.
                   # @!attribute [rw] content
                   #   @return [::String]
-                  #     Document content.
+                  #     Document content to be used for answer generation.
                   class DocumentContext
                     include ::Google::Protobuf::MessageExts
                     extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -521,6 +539,8 @@ module Google
 
                   # Extractive segment.
                   # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+                  # Answer generation will only use it if document_contexts is empty.
+                  # This is supposed to be shorter snippets.
                   # @!attribute [rw] page_identifier
                   #   @return [::String]
                   #     Page identifier.
@@ -553,9 +573,25 @@ module Google
                 # @!attribute [rw] content
                 #   @return [::String]
                 #     Chunk textual content.
+                # @!attribute [rw] document_metadata
+                #   @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo::DocumentMetadata]
+                #     Metadata of the document from the current chunk.
                 class ChunkInfo
                   include ::Google::Protobuf::MessageExts
                   extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                  # Document metadata contains the information of the document of the
+                  # current chunk.
+                  # @!attribute [rw] uri
+                  #   @return [::String]
+                  #     Uri of the document.
+                  # @!attribute [rw] title
+                  #   @return [::String]
+                  #     Title of the document.
+                  class DocumentMetadata
+                    include ::Google::Protobuf::MessageExts
+                    extend ::Google::Protobuf::MessageExts::ClassMethods
+                  end
                 end
               end
             end
@@ -588,8 +624,14 @@ module Google
                 # Adversarial query classification type.
                 ADVERSARIAL_QUERY = 1
 
-                # Non-answer-seeking query classification type.
+                # Non-answer-seeking query classification type, for chit chat.
                 NON_ANSWER_SEEKING_QUERY = 2
+
+                # Jail-breaking query classification type.
+                JAIL_BREAKING_QUERY = 3
+
+                # Non-answer-seeking query classification type, for no clear intent.
+                NON_ANSWER_SEEKING_QUERY_V2 = 4
               end
             end
 
@@ -624,9 +666,11 @@ module Google
         # @!attribute [rw] answer
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer]
         #     Answer resource object.
-        #     If [AnswerQueryRequest.StepSpec.max_step_count][] is greater than 1,
-        #     use {::Google::Cloud::DiscoveryEngine::V1::Answer#name Answer.name} to fetch
-        #     answer information using
+        #     If
+        #     {::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec#max_rephrase_steps AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps}
+        #     is greater than 1, use
+        #     {::Google::Cloud::DiscoveryEngine::V1::Answer#name Answer.name} to fetch answer
+        #     information using
         #     {::Google::Cloud::DiscoveryEngine::V1::ConversationalSearchService::Client#get_answer ConversationalSearchService.GetAnswer}
         #     API.
         # @!attribute [rw] session
@@ -647,7 +691,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Answer to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
         class GetAnswerRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -657,7 +701,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. Full resource name of parent data store. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
         # @!attribute [rw] session
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Session]
         #     Required. The session to create.
@@ -688,7 +732,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Session to delete. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
         class DeleteSessionRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -698,7 +742,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the Session to get. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
         class GetSessionRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -708,7 +752,7 @@ module Google
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The data store resource name. Format:
-        #     `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of results to return. If unspecified, defaults

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2024 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
+        # Metadata that describes a custom tuned model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified resource name of the model.
+        #
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
+        #
+        #     Model must be an alpha-numerical string with limit of 40 characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the model.
+        # @!attribute [rw] model_version
+        #   @return [::Integer]
+        #     The version of the model.
+        # @!attribute [rw] model_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::CustomTuningModel::ModelState]
+        #     The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
+        # @!attribute [rw] create_time
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Deprecated: Timestamp the Model was created at.
+        # @!attribute [rw] training_start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp the model training was initiated.
+        # @!attribute [rw] metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Float}]
+        #     The metrics of the trained model.
+        # @!attribute [rw] error_message
+        #   @return [::String]
+        #     Currently this is only populated if the model state is
+        #     `INPUT_VALIDATION_FAILED`.
+        class CustomTuningModel
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Float]
+          class MetricsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The state of the model.
+          module ModelState
+            # Default value.
+            MODEL_STATE_UNSPECIFIED = 0
+
+            # The model is in a paused training state.
+            TRAINING_PAUSED = 1
+
+            # The model is currently training.
+            TRAINING = 2
+
+            # The model has successfully completed training.
+            TRAINING_COMPLETE = 3
+
+            # The model is ready for serving.
+            READY_FOR_SERVING = 4
+
+            # The model training failed.
+            TRAINING_FAILED = 5
+
+            # The model training finished successfully but metrics did not improve.
+            NO_IMPROVEMENT = 6
+
+            # Input data validation failed. Model training didn't start.
+            INPUT_VALIDATION_FAILED = 7
+          end
+        end
+      end
+    end
+  end
+end