google-cloud-discovery_engine-v1beta 0.10.0 → 0.12.0

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

@@ -0,0 +1,362 @@
+# 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 V1beta
+        # Defines an answer.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::State]
+        #     The state of the answer generation.
+        # @!attribute [rw] answer_text
+        #   @return [::String]
+        #     The textual answer.
+        # @!attribute [rw] citations
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Citation>]
+        #     Citations.
+        # @!attribute [rw] references
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference>]
+        #     References.
+        # @!attribute [rw] related_questions
+        #   @return [::Array<::String>]
+        #     Suggested related questions.
+        # @!attribute [rw] steps
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step>]
+        #     Answer generation steps.
+        # @!attribute [rw] query_understanding_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::QueryUnderstandingInfo]
+        #     Query understanding information.
+        # @!attribute [rw] answer_skipped_reasons
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::AnswerSkippedReason>]
+        #     Additional answer-skipped reasons. This provides the reason for ignored
+        #     cases. If nothing is skipped, this field is not set.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Answer creation timestamp.
+        # @!attribute [r] complete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Answer completed timestamp.
+        class Answer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Citation info for a segment.
+          # @!attribute [rw] start_index
+          #   @return [::Integer]
+          #     Index indicates the start of the segment, measured in bytes (UTF-8
+          #     unicode).
+          # @!attribute [rw] end_index
+          #   @return [::Integer]
+          #     End of the attributed segment, exclusive.
+          # @!attribute [rw] sources
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::CitationSource>]
+          #     Citation sources for the attributed segment.
+          class Citation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Citation source.
+          # @!attribute [rw] reference_id
+          #   @return [::String]
+          #     ID of the citation source.
+          class CitationSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Reference.
+          # @!attribute [rw] unstructured_document_info
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::UnstructuredDocumentInfo]
+          #     Unstructured document information.
+          # @!attribute [rw] chunk_info
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::ChunkInfo]
+          #     Chunk information.
+          class Reference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Unstructured document information.
+            # @!attribute [rw] document
+            #   @return [::String]
+            #     Document resource name.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     URI for the document.
+            # @!attribute [rw] title
+            #   @return [::String]
+            #     Title.
+            # @!attribute [rw] chunk_contents
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
+            #     List of cited chunk contents derived from document content.
+            # @!attribute [rw] struct_data
+            #   @return [::Google::Protobuf::Struct]
+            #     The structured JSON metadata for the document.
+            #     It is populated from the struct data from the Chunk in search result.
+            class UnstructuredDocumentInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Chunk content.
+              # @!attribute [rw] content
+              #   @return [::String]
+              #     Chunk textual content.
+              # @!attribute [rw] page_identifier
+              #   @return [::String]
+              #     Page identifier.
+              class ChunkContent
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+
+            # Chunk information.
+            # @!attribute [rw] chunk
+            #   @return [::String]
+            #     Chunk resource name.
+            # @!attribute [rw] content
+            #   @return [::String]
+            #     Chunk textual content.
+            # @!attribute [rw] relevance_score
+            #   @return [::Float]
+            #     Relevance score.
+            # @!attribute [rw] document_metadata
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Reference::ChunkInfo::DocumentMetadata]
+            #     Document metadata.
+            class ChunkInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Document metadata.
+              # @!attribute [rw] document
+              #   @return [::String]
+              #     Document resource name.
+              # @!attribute [rw] uri
+              #   @return [::String]
+              #     URI for the document.
+              # @!attribute [rw] title
+              #   @return [::String]
+              #     Title.
+              # @!attribute [rw] page_identifier
+              #   @return [::String]
+              #     Page identifier.
+              # @!attribute [rw] struct_data
+              #   @return [::Google::Protobuf::Struct]
+              #     The structured JSON metadata for the document.
+              #     It is populated from the struct data from the Chunk in search result.
+              class DocumentMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+
+          # Step information.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::State]
+          #     The state of the step.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     The description of the step.
+          # @!attribute [rw] thought
+          #   @return [::String]
+          #     The thought of the step.
+          # @!attribute [rw] actions
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action>]
+          #     Actions.
+          class Step
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Action.
+            # @!attribute [rw] search_action
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::SearchAction]
+            #     Search action.
+            # @!attribute [rw] observation
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation]
+            #     Observation.
+            class Action
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Search action.
+              # @!attribute [rw] query
+              #   @return [::String]
+              #     The query to search.
+              class SearchAction
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+
+              # Observation.
+              # @!attribute [rw] search_results
+              #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult>]
+              #     Search results observed by the search action, it can be snippets info
+              #     or chunk info, depending on the citation type set by the user.
+              class Observation
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # @!attribute [rw] document
+                #   @return [::String]
+                #     Document resource name.
+                # @!attribute [rw] uri
+                #   @return [::String]
+                #     URI for the document.
+                # @!attribute [rw] title
+                #   @return [::String]
+                #     Title.
+                # @!attribute [rw] snippet_info
+                #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult::SnippetInfo>]
+                #     If citation_type is DOCUMENT_LEVEL_CITATION, populate document
+                #     level snippets.
+                # @!attribute [rw] chunk_info
+                #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult::ChunkInfo>]
+                #     If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
+                #     populate chunk info.
+                class SearchResult
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                  # Snippet information.
+                  # @!attribute [rw] snippet
+                  #   @return [::String]
+                  #     Snippet content.
+                  # @!attribute [rw] snippet_status
+                  #   @return [::String]
+                  #     Status of the snippet defined by the search team.
+                  class SnippetInfo
+                    include ::Google::Protobuf::MessageExts
+                    extend ::Google::Protobuf::MessageExts::ClassMethods
+                  end
+
+                  # Chunk information.
+                  # @!attribute [rw] chunk
+                  #   @return [::String]
+                  #     Chunk resource name.
+                  # @!attribute [rw] content
+                  #   @return [::String]
+                  #     Chunk textual content.
+                  # @!attribute [rw] relevance_score
+                  #   @return [::Float]
+                  #     Relevance score.
+                  class ChunkInfo
+                    include ::Google::Protobuf::MessageExts
+                    extend ::Google::Protobuf::MessageExts::ClassMethods
+                  end
+                end
+              end
+            end
+
+            # Enumeration of the state of the step.
+            module State
+              # Unknown.
+              STATE_UNSPECIFIED = 0
+
+              # Step is currently in progress.
+              IN_PROGRESS = 1
+
+              # Step currently failed.
+              FAILED = 2
+
+              # Step has succeeded.
+              SUCCEEDED = 3
+            end
+          end
+
+          # Query understanding information.
+          # @!attribute [rw] query_classification_info
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::QueryUnderstandingInfo::QueryClassificationInfo>]
+          #     Query classification information.
+          class QueryUnderstandingInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Query classification information.
+            # @!attribute [rw] type
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer::QueryUnderstandingInfo::QueryClassificationInfo::Type]
+            #     Query classification type.
+            # @!attribute [rw] positive
+            #   @return [::Boolean]
+            #     Classification output.
+            class QueryClassificationInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Query classification types.
+              module Type
+                # Unspecified query classification type.
+                TYPE_UNSPECIFIED = 0
+
+                # Adversarial query classification type.
+                ADVERSARIAL_QUERY = 1
+
+                # Non-answer-seeking query classification type.
+                NON_ANSWER_SEEKING_QUERY = 2
+              end
+            end
+          end
+
+          # Enumeration of the state of the answer generation.
+          module State
+            # Unknown.
+            STATE_UNSPECIFIED = 0
+
+            # Answer generation is currently in progress.
+            IN_PROGRESS = 1
+
+            # Answer generation currently failed.
+            FAILED = 2
+
+            # Answer generation has succeeded.
+            SUCCEEDED = 3
+          end
+
+          # An enum for answer skipped reasons.
+          module AnswerSkippedReason
+            # Default value. The answer skipped reason is not specified.
+            ANSWER_SKIPPED_REASON_UNSPECIFIED = 0
+
+            # The adversarial query ignored case.
+            ADVERSARIAL_QUERY_IGNORED = 1
+
+            # The non-answer seeking query ignored case.
+            NON_ANSWER_SEEKING_QUERY_IGNORED = 2
+
+            # The out-of-domain query ignored case.
+            #
+            # Google skips the answer if there are no high-relevance search results.
+            OUT_OF_DOMAIN_QUERY_IGNORED = 3
+
+            # The potential policy violation case.
+            #
+            # Google skips the answer if there is a potential policy violation
+            # detected. This includes content that may be violent or toxic.
+            POTENTIAL_POLICY_VIOLATION = 4
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb

@@ -131,6 +131,9 @@ module Google
 
           # The media industry vertical.
           MEDIA = 2
+
+          # The healthcare FHIR vertical.
+          HEALTHCARE_FHIR = 7
         end
 
         # The type of solution.
@@ -146,10 +149,31 @@ module Google
 
           # Used for use cases related to the Generative AI agent.
           SOLUTION_TYPE_CHAT = 3
+
+          # Used for use cases related to the Generative Chat agent.
+          # It's used for Generative chat engine only, the associated data stores
+          # must enrolled with `SOLUTION_TYPE_CHAT` solution.
+          SOLUTION_TYPE_GENERATIVE_CHAT = 4
+        end
+
+        # Defines a further subdivision of `SolutionType`.
+        # Specifically applies to
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        module SearchUseCase
+          # Value used when unset. Will not occur in CSS.
+          SEARCH_USE_CASE_UNSPECIFIED = 0
+
+          # Search use case. Expects the traffic has a non-empty
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query query}.
+          SEARCH_USE_CASE_SEARCH = 1
+
+          # Browse use case. Expects the traffic has an empty
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query query}.
+          SEARCH_USE_CASE_BROWSE = 2
         end
 
         # Tiers of search features. Different tiers might have different
-        # pricing. To learn more, please check the pricing documentation.
+        # pricing. To learn more, check the pricing documentation.
         module SearchTier
           # Default value when the enum is unspecified. This is invalid to use.
           SEARCH_TIER_UNSPECIFIED = 0

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

@@ -0,0 +1,209 @@
+# 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 V1beta
+        # Defines circumstances to be checked before allowing a behavior
+        # @!attribute [rw] query_terms
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::QueryTerm>]
+        #     Search only
+        #     A list of terms to match the query on.
+        #
+        #     Maximum of 10 query terms.
+        # @!attribute [rw] active_time_range
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::TimeRange>]
+        #     Range of time(s) specifying when condition is active.
+        #
+        #     Maximum of 10 time ranges.
+        class Condition
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for search request query
+          # @!attribute [rw] value
+          #   @return [::String]
+          #     The specific query value to match against
+          #
+          #     Must be lowercase, must be UTF-8.
+          #     Can have at most 3 space separated terms if full_match is true.
+          #     Cannot be an empty string.
+          #     Maximum length of 5000 characters.
+          # @!attribute [rw] full_match
+          #   @return [::Boolean]
+          #     Whether the search query needs to exactly match the query term.
+          class QueryTerm
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Used for time-dependent conditions.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Start of time range.
+          #
+          #     Range is inclusive.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     End of time range.
+          #
+          #     Range is inclusive.
+          #     Must be in the future.
+          class TimeRange
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Defines a conditioned behavior to employ during serving.
+        # Must be attached to a
+        # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} to be
+        # considered at serving time. Permitted actions dependent on `SolutionType`.
+        # @!attribute [rw] boost_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction]
+        #     Defines a boost-type control
+        # @!attribute [rw] filter_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction]
+        #     Defines a filter-type control
+        #     Currently not supported by Recommendation
+        # @!attribute [rw] redirect_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction]
+        #     Defines a redirect-type control.
+        # @!attribute [rw] synonyms_action
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction]
+        #     Treats a group of terms as synonyms of one another.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `projects/*/locations/global/dataStore/*/controls/*`
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. Human readable name. The identifier used in UI views.
+        #
+        #     Must be UTF-8 encoded string. Length limit is 128 characters.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        # @!attribute [r] associated_serving_config_ids
+        #   @return [::Array<::String>]
+        #     Output only. List of all
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig 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::V1beta::SolutionType]
+        #     Required. Immutable. What solution the control belongs to.
+        #
+        #     Must be compatible with vertical of resource.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        # @!attribute [rw] use_cases
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>]
+        #     Specifies the use case for the control.
+        #     Affects what condition fields can be set.
+        #     Only applies to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        #     Currently only allow one use case per control.
+        #     Must be set when solution_type is
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SolutionType.SOLUTION_TYPE_SEARCH}.
+        # @!attribute [rw] conditions
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>]
+        #     Determines when the associated action will trigger.
+        #
+        #     Omit to always apply the action.
+        #     Currently only a single condition may be specified.
+        #     Otherwise an INVALID ARGUMENT error is thrown.
+        class Control
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Adjusts order of products in returned list.
+          # @!attribute [rw] boost
+          #   @return [::Float]
+          #     Required. Strength of the boost, which should be in [-1, 1]. Negative
+          #     boost means demotion. Default is 0.0 (No-op).
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Required. Specifies which products to apply the boost to.
+          #
+          #     If no filter is provided all products will be boosted (No-op).
+          #     Syntax documentation:
+          #     https://cloud.google.com/retail/docs/filter-and-order
+          #     Maximum length is 5000 characters.
+          #     Otherwise an INVALID ARGUMENT error is thrown.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Specifies which data store's documents can be boosted by this
+          #     control. Full data store name e.g.
+          #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
+          class BoostAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Specified which products may be included in results.
+          # Uses same filter as boost.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Required. A filter to apply on the matching condition results.
+          #
+          #     Required
+          #     Syntax documentation:
+          #     https://cloud.google.com/retail/docs/filter-and-order
+          #     Maximum length is 5000 characters. Otherwise an INVALID
+          #     ARGUMENT error is thrown.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Specifies which data store's documents can be filtered by this
+          #     control. Full data store name e.g.
+          #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
+          class FilterAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Redirects a shopper to the provided URI.
+          # @!attribute [rw] redirect_uri
+          #   @return [::String]
+          #     Required. The URI to which the shopper will be redirected.
+          #
+          #     Required.
+          #     URI must have length equal or less than 2000 characters.
+          #     Otherwise an INVALID ARGUMENT error is thrown.
+          class RedirectAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Creates a set of terms that will act as synonyms of one another.
+          #
+          # Example: "happy" will also be considered as "glad", "glad" will also be
+          # considered as "happy".
+          # @!attribute [rw] synonyms
+          #   @return [::Array<::String>]
+          #     Defines a set of synonyms.
+          #     Can specify up to 100 synonyms.
+          #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
+          #     thrown.
+          class SynonymsAction
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end