google-cloud-discovery_engine-v1 2.3.1 → 2.5.0

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

@@ -0,0 +1,278 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+        # AssistAnswer resource, main part of
+        # [AssistResponse][google.cloud.discoveryengine.v1.AssistResponse].
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Resource name of the `AssistAnswer`.
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::State]
+        #     State of the answer generation.
+        # @!attribute [rw] replies
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::Reply>]
+        #     Replies of the assistant.
+        # @!attribute [rw] assist_skipped_reasons
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistAnswer::AssistSkippedReason>]
+        #     Reasons for not answering the assist call.
+        class AssistAnswer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # One part of the multi-part response of the assist call.
+          # @!attribute [rw] grounded_content
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent]
+          #     Possibly grounded response text or media from the assistant.
+          class Reply
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # State of the answer generation.
+          module State
+            # Unknown.
+            STATE_UNSPECIFIED = 0
+
+            # Assist operation is currently in progress.
+            IN_PROGRESS = 1
+
+            # Assist operation has failed.
+            FAILED = 2
+
+            # Assist operation has succeeded.
+            SUCCEEDED = 3
+
+            # Assist operation has been skipped.
+            SKIPPED = 4
+          end
+
+          # Possible reasons for not answering an assist call.
+          module AssistSkippedReason
+            # Default value. Skip reason is not specified.
+            ASSIST_SKIPPED_REASON_UNSPECIFIED = 0
+
+            # The assistant ignored the query, because it did not appear to be
+            # answer-seeking.
+            NON_ASSIST_SEEKING_QUERY_IGNORED = 1
+
+            # The assistant ignored the query or refused to answer because of a
+            # customer policy violation (e.g., the query or the answer contained a
+            # banned phrase).
+            CUSTOMER_POLICY_VIOLATION = 2
+          end
+        end
+
+        # Multi-modal content.
+        # @!attribute [rw] text
+        #   @return [::String]
+        #     Inline text.
+        #
+        #     Note: The following fields are mutually exclusive: `text`, `inline_data`, `file`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] inline_data
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent::Blob]
+        #     Inline binary data.
+        #
+        #     Note: The following fields are mutually exclusive: `inline_data`, `text`, `file`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] file
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent::File]
+        #     A file, e.g., an audio summary.
+        #
+        #     Note: The following fields are mutually exclusive: `file`, `text`, `inline_data`, `executable_code`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] executable_code
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent::ExecutableCode]
+        #     Code generated by the model that is meant to be executed.
+        #
+        #     Note: The following fields are mutually exclusive: `executable_code`, `text`, `inline_data`, `file`, `code_execution_result`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] code_execution_result
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent::CodeExecutionResult]
+        #     Result of executing an ExecutableCode.
+        #
+        #     Note: The following fields are mutually exclusive: `code_execution_result`, `text`, `inline_data`, `file`, `executable_code`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] role
+        #   @return [::String]
+        #     The producer of the content. Can be "model" or "user".
+        # @!attribute [rw] thought
+        #   @return [::Boolean]
+        #     Optional. Indicates if the part is thought from the model.
+        class AssistantContent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Inline blob.
+          # @!attribute [rw] mime_type
+          #   @return [::String]
+          #     Required. The media type (MIME type) of the generated data.
+          # @!attribute [rw] data
+          #   @return [::String]
+          #     Required. Raw bytes.
+          class Blob
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A file, e.g., an audio summary.
+          # @!attribute [rw] mime_type
+          #   @return [::String]
+          #     Required. The media type (MIME type) of the file.
+          # @!attribute [rw] file_id
+          #   @return [::String]
+          #     Required. The file ID.
+          class File
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Code generated by the model that is meant to be executed by the model.
+          # @!attribute [rw] code
+          #   @return [::String]
+          #     Required. The code content. Currently only supports Python.
+          class ExecutableCode
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Result of executing ExecutableCode.
+          # @!attribute [rw] outcome
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent::CodeExecutionResult::Outcome]
+          #     Required. Outcome of the code execution.
+          # @!attribute [rw] output
+          #   @return [::String]
+          #     Optional. Contains stdout when code execution is successful, stderr or
+          #     other description otherwise.
+          class CodeExecutionResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Enumeration of possible outcomes of the code execution.
+            module Outcome
+              # Unspecified status. This value should not be used.
+              OUTCOME_UNSPECIFIED = 0
+
+              # Code execution completed successfully.
+              OUTCOME_OK = 1
+
+              # Code execution finished but with a failure. `stderr` should contain the
+              # reason.
+              OUTCOME_FAILED = 2
+
+              # Code execution ran for too long, and was cancelled. There may or may
+              # not be a partial output present.
+              OUTCOME_DEADLINE_EXCEEDED = 3
+            end
+          end
+        end
+
+        # A piece of content and possibly its grounding information.
+        #
+        # Not all content needs grounding. Phrases like "Of course, I will gladly
+        # search it for you." do not need grounding.
+        # @!attribute [rw] text_grounding_metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata]
+        #     Metadata for grounding based on text sources.
+        # @!attribute [rw] content
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantContent]
+        #     The content.
+        class AssistantGroundedContent
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Grounding details for text sources.
+          # @!attribute [rw] segments
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Segment>]
+          #     Grounding information for parts of the text.
+          # @!attribute [rw] references
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference>]
+          #     References for the grounded text.
+          class TextGroundingMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Grounding information for a segment of the text.
+            # @!attribute [rw] start_index
+            #   @return [::Integer]
+            #     Zero-based index indicating the start of the segment, measured in bytes
+            #     of a UTF-8 string (i.e. characters encoded on multiple bytes have a
+            #     length of more than one).
+            # @!attribute [rw] end_index
+            #   @return [::Integer]
+            #     End of the segment, exclusive.
+            # @!attribute [rw] reference_indices
+            #   @return [::Array<::Integer>]
+            #     References for the segment.
+            # @!attribute [rw] grounding_score
+            #   @return [::Float]
+            #     Score for the segment.
+            # @!attribute [rw] text
+            #   @return [::String]
+            #     The text segment itself.
+            class Segment
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Referenced content and related document metadata.
+            # @!attribute [rw] content
+            #   @return [::String]
+            #     Referenced text content.
+            # @!attribute [rw] document_metadata
+            #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata]
+            #     Document metadata.
+            class Reference
+              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. It may contain a URL that redirects to the
+              #     actual website.
+              # @!attribute [rw] title
+              #   @return [::String]
+              #     Title.
+              # @!attribute [rw] page_identifier
+              #   @return [::String]
+              #     Page identifier.
+              # @!attribute [rw] domain
+              #   @return [::String]
+              #     Domain name from the document URI. Note that the `uri` field may
+              #     contain a URL that redirects to the actual website, in which case
+              #     this will contain the domain name of the target site.
+              class DocumentMetadata
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+        # Discovery Engine Assistant resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Resource name of the assistant.
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
+        #
+        #     It must be a UTF-8 encoded string with a length limit of 1024 characters.
+        class Assistant
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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
+        # User metadata of the request.
+        # @!attribute [rw] time_zone
+        #   @return [::String]
+        #     Optional. IANA time zone, e.g. Europe/Budapest.
+        # @!attribute [rw] preferred_language_code
+        #   @return [::String]
+        #     Optional. Preferred language to be used for answering if language detection
+        #     fails. Also used as the language of error messages created by actions,
+        #     regardless of language detection results.
+        class AssistUserMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for the
+        # {::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client#stream_assist AssistantService.StreamAssist}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Assistant Assistant}. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Query]
+        #     Optional. Current user query.
+        #
+        #     Empty query is only supported if `file_ids` are provided. In this case, the
+        #     answer will be generated based on those context files.
+        # @!attribute [rw] session
+        #   @return [::String]
+        #     Optional. The session to use for the request. If specified, the assistant
+        #     has access to the session history, and the query and the answer are stored
+        #     there.
+        #
+        #     If `-` is specified as the session ID, or it is left empty, then a new
+        #     session is created with an automatically generated ID.
+        #
+        #     Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
+        # @!attribute [rw] user_metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata]
+        #     Optional. Information about the user initiating the query.
+        # @!attribute [rw] tools_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec]
+        #     Optional. Specification of tools that are used to serve the request.
+        # @!attribute [rw] generation_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec]
+        #     Optional. Specification of the generation configuration for the request.
+        class StreamAssistRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Specification of tools that are used to serve the request.
+          # @!attribute [rw] vertex_ai_search_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec]
+          #     Optional. Specification of the Vertex AI Search tool.
+          # @!attribute [rw] web_grounding_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::WebGroundingSpec]
+          #     Optional. Specification of the web grounding tool.
+          #     If field is present, enables grounding with web search. Works only if
+          #     [Assistant.web_grounding_type][google.cloud.discoveryengine.v1.Assistant.web_grounding_type]
+          #     is [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] or
+          #     [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
+          # @!attribute [rw] image_generation_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::ImageGenerationSpec]
+          #     Optional. Specification of the image generation tool.
+          # @!attribute [rw] video_generation_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VideoGenerationSpec]
+          #     Optional. Specification of the video generation tool.
+          class ToolsSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Specification of the Vertex AI Search tool.
+            # @!attribute [rw] data_store_specs
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec>]
+            #     Optional. Specs defining
+            #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s to filter on in
+            #     a search call and configurations for those data stores. This is only
+            #     considered for {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s with
+            #     multiple data stores.
+            # @!attribute [rw] filter
+            #   @return [::String]
+            #     Optional. The filter syntax consists of an expression language for
+            #     constructing a predicate from one or more fields of the documents being
+            #     filtered. Filter expression is case-sensitive.
+            #
+            #     If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+            #
+            #     Filtering in Vertex AI Search is done by mapping the LHS filter key to
+            #     a key property defined in the Vertex AI Search backend -- this mapping
+            #     is defined by the customer in their schema. For example a media
+            #     customer might have a field 'name' in their schema. In this case the
+            #     filter would look like this: filter --> name:'ANY("king kong")'
+            #
+            #     For more information about filtering including syntax and filter
+            #     operators, see
+            #     [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+            class VertexAiSearchSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the web grounding tool.
+            class WebGroundingSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the image generation tool.
+            class ImageGenerationSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Specification of the video generation tool.
+            class VideoGenerationSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Assistant generation specification for the request.
+          # This allows to override the default generation configuration at the engine
+          # level.
+          # @!attribute [rw] model_id
+          #   @return [::String]
+          #     Optional. The Vertex AI model_id used for the generative model. If not
+          #     set, the default Assistant model will be used.
+          class GenerationSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response for the
+        # {::Google::Cloud::DiscoveryEngine::V1::AssistantService::Client#stream_assist AssistantService.StreamAssist}
+        # method.
+        # @!attribute [rw] answer
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistAnswer]
+        #     Assist answer resource object containing parts of the assistant's final
+        #     answer for the user's query.
+        #
+        #     Not present if the current response doesn't add anything to previously
+        #     sent
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#replies AssistAnswer.replies}.
+        #
+        #     Observe
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#state AssistAnswer.state} to
+        #     see if more parts are to be expected. While the state is `IN_PROGRESS`, the
+        #     {::Google::Cloud::DiscoveryEngine::V1::AssistAnswer#replies AssistAnswer.replies}
+        #     field in each response will contain replies (reply fragments) to be
+        #     appended to the ones received in previous responses. [AssistAnswer.name][]
+        #     won't be filled.
+        #
+        #     If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
+        #     is the last response and [AssistAnswer.name][] will have a value.
+        # @!attribute [rw] session_info
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::StreamAssistResponse::SessionInfo]
+        #     Session information.
+        # @!attribute [rw] assist_token
+        #   @return [::String]
+        #     A global unique ID that identifies the current pair of request and stream
+        #     of responses. Used for feedback and support.
+        class StreamAssistResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about the session.
+          # @!attribute [rw] session
+          #   @return [::String]
+          #     Name of the newly generated or continued session.
+          #
+          #     Format:
+          #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
+          class SessionInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -926,11 +926,23 @@ module Google
         #     Provide this to retrieve the subsequent page.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     A filter to apply on the list results. The supported features are:
-        #     user_pseudo_id, state.
+        #     A comma-separated list of fields to filter by, in EBNF grammar.
+        #     The supported fields are:
+        #     * `user_pseudo_id`
+        #     * `state`
+        #     * `display_name`
+        #     * `starred`
+        #     * `is_pinned`
+        #     * `labels`
+        #     * `create_time`
+        #     * `update_time`
         #
-        #     Example:
+        #     Examples:
         #     "user_pseudo_id = some_id"
+        #     "display_name = \"some_name\""
+        #     "starred = true"
+        #     "is_pinned=true AND (NOT labels:hidden)"
+        #     "create_time > \"1970-01-01T12:00:00Z\""
         # @!attribute [rw] order_by
         #   @return [::String]
         #     A comma-separated list of fields to order by, sorted in ascending order.