google-cloud-discovery_engine-v1 0.6.0 → 0.8.0

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

@@ -59,7 +59,7 @@ module Google
         #   @return [::Integer]
         #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to
         #     return. If unspecified, defaults to 100. The maximum allowed value is 1000.
-        #     Values above 1000 will be coerced to 1000.
+        #     Values above 1000 are set to 1000.
         #
         #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] page_token
@@ -110,7 +110,7 @@ module Google
         # @!attribute [rw] document_id
         #   @return [::String]
         #     Required. The ID to use for the
-        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, which will become the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}, which becomes the
         #     final component of the
         #     {::Google::Cloud::DiscoveryEngine::V1::Document#name Document.name}.
         #
@@ -148,9 +148,13 @@ module Google
         #     is not set, a `NOT_FOUND` error is returned.
         # @!attribute [rw] allow_missing
         #   @return [::Boolean]
-        #     If set to true, and the
+        #     If set to `true` and the
         #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not found, a new
-        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} will be created.
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} is be created.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided imported 'document' to update. If
+        #     not set, by default updates all fields.
         class UpdateDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -89,7 +89,7 @@ module Google
         #     The restriction of the Engine industry vertical is based on
         #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}: If unspecified,
         #     default to `GENERIC`. Vertical on Engine has to match vertical of the
-        #     DataStore liniked to the engine.
+        #     DataStore linked to the engine.
         # @!attribute [rw] common_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig]
         #     Common config spec that specifies the metadata of the engine.
@@ -103,7 +103,7 @@ module Google
           #     The search feature tier of this engine.
           #
           #     Different tiers might have different
-          #     pricing. To learn more, please check the pricing documentation.
+          #     pricing. To learn more, check the pricing documentation.
           #
           #     Defaults to
           #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
@@ -142,7 +142,7 @@ module Google
           #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
           #     or
           #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
-          #     API after engine creation. Please use
+          #     API after engine creation. Use
           #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
           #     for actual agent association after Engine is created.
           class ChatEngineConfig
@@ -187,8 +187,8 @@ module Google
           # Common configurations for an Engine.
           # @!attribute [rw] company_name
           #   @return [::String]
-          #     Immutable. The name of the company, business or entity that is associated
-          #     with the engine. Setting this may help improve LLM related features.
+          #     The name of the company, business or entity that is associated with the
+          #     engine. Setting this may help improve LLM related features.
           class CommonConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,144 @@
+# 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
+        # Specification for the grounding check.
+        # @!attribute [rw] citation_threshold
+        #   @return [::Float]
+        #     The threshold (in [0,1]) used for determining whether a fact must be
+        #     cited for a claim in the answer candidate. Choosing a higher threshold
+        #     will lead to fewer but very strong citations, while choosing a lower
+        #     threshold may lead to more but somewhat weaker citations. If unset, the
+        #     threshold will default to 0.6.
+        class CheckGroundingSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client#check_grounding GroundedGenerationService.CheckGrounding}
+        # method.
+        # @!attribute [rw] grounding_config
+        #   @return [::String]
+        #     Required. The resource name of the grounding config, such as
+        #     `projects/*/locations/global/groundingConfigs/default_grounding_config`.
+        # @!attribute [rw] answer_candidate
+        #   @return [::String]
+        #     Answer candidate to check. Can have a maximum length of 1024 characters.
+        # @!attribute [rw] facts
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
+        #     List of facts for the grounding check.
+        #     We support up to 200 facts.
+        # @!attribute [rw] grounding_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::CheckGroundingSpec]
+        #     Configuration of the grounding check.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
+        class CheckGroundingRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for the
+        # {::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Client#check_grounding GroundedGenerationService.CheckGrounding}
+        # method.
+        # @!attribute [rw] support_score
+        #   @return [::Float]
+        #     The support score for the input answer candidate.
+        #     Higher the score, higher is the fraction of claims that are supported by
+        #     the provided facts. This is always set when a response is returned.
+        # @!attribute [rw] cited_chunks
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::FactChunk>]
+        #     List of facts cited across all claims in the answer candidate.
+        #     These are derived from the facts supplied in the request.
+        # @!attribute [rw] claims
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim>]
+        #     Claim texts and citation info across all claims in the answer candidate.
+        class CheckGroundingResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Text and citation info for a claim in the answer candidate.
+          # @!attribute [rw] start_pos
+          #   @return [::Integer]
+          #     Position indicating the start of the claim in the answer candidate,
+          #     measured in bytes.
+          # @!attribute [rw] end_pos
+          #   @return [::Integer]
+          #     Position indicating the end of the claim in the answer candidate,
+          #     exclusive.
+          # @!attribute [rw] claim_text
+          #   @return [::String]
+          #     Text for the claim in the answer candidate. Always provided regardless of
+          #     whether citations or anti-citations are found.
+          # @!attribute [rw] citation_indices
+          #   @return [::Array<::Integer>]
+          #     A list of indices (into 'cited_chunks') specifying the citations
+          #     associated with the claim. For instance [1,3,4] means that
+          #     cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
+          #     supporting for the claim. A citation to a fact indicates that the claim
+          #     is supported by the fact.
+          # @!attribute [rw] grounding_check_required
+          #   @return [::Boolean]
+          #     Indicates that this claim required grounding check. When the system
+          #     decided this claim doesn't require attribution/grounding check, this
+          #     field will be set to false. In that case, no grounding check was done for
+          #     the claim and therefore
+          #     {::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim#citation_indices citation_indices},
+          #     and
+          #     [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices]
+          #     should not be returned.
+          class Claim
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# 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
+        # Grounding Fact.
+        # @!attribute [rw] fact_text
+        #   @return [::String]
+        #     Text content of the fact. Can be at most 10K characters long.
+        # @!attribute [rw] attributes
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Attributes associated with the fact.
+        #     Common attributes include `source` (indicating where the fact was sourced
+        #     from), `author` (indicating the author of the fact), and so on.
+        class GroundingFact
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AttributesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Fact Chunk.
+        # @!attribute [rw] chunk_text
+        #   @return [::String]
+        #     Text content of the fact chunk. Can be at most 10K characters long.
+        # @!attribute [rw] source
+        #   @return [::String]
+        #     Source from which this fact chunk was retrieved. If it was retrieved
+        #     from the GroundingFacts provided in the request then this field will
+        #     contain the index of the specific fact from which this chunk was
+        #     retrieved.
+        # @!attribute [rw] index
+        #   @return [::Integer]
+        #     The index of this chunk. Currently, only used for the streaming mode.
+        # @!attribute [rw] source_metadata
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     More fine-grained information for the source reference.
+        class FactChunk
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class SourceMetadataEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end