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

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

Request for the AssistantService.StreamAssist method.

Defined Under Namespace

Classes: GenerationSpec, ToolsSpec

Instance Attribute Summary collapse

Instance Attribute Details

#generation_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::GenerationSpec

Returns Optional. Specification of the generation configuration for the request.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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

#name ⇒ ::String

Returns Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}.

Returns:

  • (::String) —

    Required. The resource name of the Assistant. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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

#query ⇒ ::Google::Cloud::DiscoveryEngine::V1::Query

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

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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

#session ⇒ ::String

Returns 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}.

Returns:

  • (::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}



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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

#tools_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::StreamAssistRequest::ToolsSpec

Returns Optional. Specification of tools that are used to serve the request.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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

#user_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::AssistUserMetadata

Returns Optional. Information about the user initiating the query.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assistant_service.rb', line 72

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