Class: Google::Cloud::DiscoveryEngine::V1::Engine

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

Overview

Metadata that describes the training and serving parameters of an Engine.

Defined Under Namespace

Classes: ChatEngineConfig, ChatEngineMetadata, CommonConfig, SearchEngineConfig

Instance Attribute Summary collapse

Instance Attribute Details

#chat_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig

Returns Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#chat_engine_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata (readonly)

Returns Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#common_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig

Returns Common config spec that specifies the metadata of the engine.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Recommendation Engine was created at.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#data_store_ids ⇒ ::Array<::String>

Returns The data stores associated with this engine.

For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same [Collection][google.cloud.discoveryengine.v1.Collection] can be associated here.

Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_analytics ⇒ ::Boolean

Returns Optional. Whether to disable analytics for searches performed on this engine.

Returns:

  • (::Boolean) —

    Optional. Whether to disable analytics for searches performed on this engine.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Returns:

  • (::String) —

    Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#industry_vertical ⇒ ::Google::Cloud::DiscoveryEngine::V1::IndustryVertical

Returns The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore linked to the engine.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. The fully qualified resource name of the engine.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    Immutable. The fully qualified resource name of the engine.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

    Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#search_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig

Returns Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#solution_type ⇒ ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Returns Required. The solutions of the engine.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Recommendation Engine was last updated.

Returns:



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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/engine.rb', line 100

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::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. Use
  #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::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.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     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
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end