Class: Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb

Overview

Specification of tools that are used to serve the request.

Defined Under Namespace

Classes: ImageGenerationSpec, VertexAiSearchSpec, VideoGenerationSpec, WebGroundingSpec

Instance Attribute Summary collapse

Instance Attribute Details

#image_generation_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::ImageGenerationSpec

Returns Optional. Specification of the image generation tool.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 93

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

#vertex_ai_search_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VertexAiSearchSpec

Returns Optional. Specification of the Vertex AI Search tool.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 93

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

#video_generation_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::VideoGenerationSpec

Returns Optional. Specification of the video generation tool.

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 93

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

#web_grounding_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec::WebGroundingSpec

Returns 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][].

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 93

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