google-apis-discoveryengine_v1alpha 0.26.0 → 0.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1alpha/classes.rb +682 -3
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +327 -0
- data/lib/google/apis/discoveryengine_v1alpha/service.rb +742 -21
- metadata +3 -3
@@ -1076,6 +1076,61 @@ module Google
|
|
1076
1076
|
end
|
1077
1077
|
end
|
1078
1078
|
|
1079
|
+
# Metadata related to the progress of the DataStoreService.CreateDataStore
|
1080
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1081
|
+
# field.
|
1082
|
+
class GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata
|
1083
|
+
include Google::Apis::Core::Hashable
|
1084
|
+
|
1085
|
+
# Operation create time.
|
1086
|
+
# Corresponds to the JSON property `createTime`
|
1087
|
+
# @return [String]
|
1088
|
+
attr_accessor :create_time
|
1089
|
+
|
1090
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1091
|
+
# time.
|
1092
|
+
# Corresponds to the JSON property `updateTime`
|
1093
|
+
# @return [String]
|
1094
|
+
attr_accessor :update_time
|
1095
|
+
|
1096
|
+
def initialize(**args)
|
1097
|
+
update!(**args)
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Update properties of this object
|
1101
|
+
def update!(**args)
|
1102
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1103
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1104
|
+
end
|
1105
|
+
end
|
1106
|
+
|
1107
|
+
# Metadata related to the progress of the EngineService.CreateEngine operation.
|
1108
|
+
# This will be returned by the google.longrunning.Operation.metadata field.
|
1109
|
+
class GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata
|
1110
|
+
include Google::Apis::Core::Hashable
|
1111
|
+
|
1112
|
+
# Operation create time.
|
1113
|
+
# Corresponds to the JSON property `createTime`
|
1114
|
+
# @return [String]
|
1115
|
+
attr_accessor :create_time
|
1116
|
+
|
1117
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1118
|
+
# time.
|
1119
|
+
# Corresponds to the JSON property `updateTime`
|
1120
|
+
# @return [String]
|
1121
|
+
attr_accessor :update_time
|
1122
|
+
|
1123
|
+
def initialize(**args)
|
1124
|
+
update!(**args)
|
1125
|
+
end
|
1126
|
+
|
1127
|
+
# Update properties of this object
|
1128
|
+
def update!(**args)
|
1129
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1130
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1131
|
+
end
|
1132
|
+
end
|
1133
|
+
|
1079
1134
|
# Metadata for Create Schema LRO.
|
1080
1135
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
1081
1136
|
include Google::Apis::Core::Hashable
|
@@ -1135,6 +1190,125 @@ module Google
|
|
1135
1190
|
end
|
1136
1191
|
end
|
1137
1192
|
|
1193
|
+
# DataStore captures global settings and configs at the DataStore level.
|
1194
|
+
class GoogleCloudDiscoveryengineV1alphaDataStore
|
1195
|
+
include Google::Apis::Core::Hashable
|
1196
|
+
|
1197
|
+
# Immutable. The content config of the data store. If this field is unset, the
|
1198
|
+
# server behavior defaults to ContentConfig.NO_CONTENT.
|
1199
|
+
# Corresponds to the JSON property `contentConfig`
|
1200
|
+
# @return [String]
|
1201
|
+
attr_accessor :content_config
|
1202
|
+
|
1203
|
+
# Output only. Timestamp the DataStore was created at.
|
1204
|
+
# Corresponds to the JSON property `createTime`
|
1205
|
+
# @return [String]
|
1206
|
+
attr_accessor :create_time
|
1207
|
+
|
1208
|
+
# Output only. The id of the default Schema asscociated to this data store.
|
1209
|
+
# Corresponds to the JSON property `defaultSchemaId`
|
1210
|
+
# @return [String]
|
1211
|
+
attr_accessor :default_schema_id
|
1212
|
+
|
1213
|
+
# Required. The data store display name. This field must be a UTF-8 encoded
|
1214
|
+
# string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT
|
1215
|
+
# error is returned.
|
1216
|
+
# Corresponds to the JSON property `displayName`
|
1217
|
+
# @return [String]
|
1218
|
+
attr_accessor :display_name
|
1219
|
+
|
1220
|
+
# Immutable. The industry vertical that the data store registers.
|
1221
|
+
# Corresponds to the JSON property `industryVertical`
|
1222
|
+
# @return [String]
|
1223
|
+
attr_accessor :industry_vertical
|
1224
|
+
|
1225
|
+
# Immutable. The full resource name of the data store. Format: `projects/`
|
1226
|
+
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
1227
|
+
# data_store_id``. This field must be a UTF-8 encoded string with a length limit
|
1228
|
+
# of 1024 characters.
|
1229
|
+
# Corresponds to the JSON property `name`
|
1230
|
+
# @return [String]
|
1231
|
+
attr_accessor :name
|
1232
|
+
|
1233
|
+
# The solutions that the data store enrolls. Available solutions for each
|
1234
|
+
# industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `
|
1235
|
+
# SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is
|
1236
|
+
# automatically enrolled. Other solutions cannot be enrolled.
|
1237
|
+
# Corresponds to the JSON property `solutionTypes`
|
1238
|
+
# @return [Array<String>]
|
1239
|
+
attr_accessor :solution_types
|
1240
|
+
|
1241
|
+
def initialize(**args)
|
1242
|
+
update!(**args)
|
1243
|
+
end
|
1244
|
+
|
1245
|
+
# Update properties of this object
|
1246
|
+
def update!(**args)
|
1247
|
+
@content_config = args[:content_config] if args.key?(:content_config)
|
1248
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1249
|
+
@default_schema_id = args[:default_schema_id] if args.key?(:default_schema_id)
|
1250
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
1251
|
+
@industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
|
1252
|
+
@name = args[:name] if args.key?(:name)
|
1253
|
+
@solution_types = args[:solution_types] if args.key?(:solution_types)
|
1254
|
+
end
|
1255
|
+
end
|
1256
|
+
|
1257
|
+
# Metadata related to the progress of the DataStoreService.DeleteDataStore
|
1258
|
+
# operation. This will be returned by the google.longrunning.Operation.metadata
|
1259
|
+
# field.
|
1260
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata
|
1261
|
+
include Google::Apis::Core::Hashable
|
1262
|
+
|
1263
|
+
# Operation create time.
|
1264
|
+
# Corresponds to the JSON property `createTime`
|
1265
|
+
# @return [String]
|
1266
|
+
attr_accessor :create_time
|
1267
|
+
|
1268
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1269
|
+
# time.
|
1270
|
+
# Corresponds to the JSON property `updateTime`
|
1271
|
+
# @return [String]
|
1272
|
+
attr_accessor :update_time
|
1273
|
+
|
1274
|
+
def initialize(**args)
|
1275
|
+
update!(**args)
|
1276
|
+
end
|
1277
|
+
|
1278
|
+
# Update properties of this object
|
1279
|
+
def update!(**args)
|
1280
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1281
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1282
|
+
end
|
1283
|
+
end
|
1284
|
+
|
1285
|
+
# Metadata related to the progress of the EngineService.DeleteEngine operation.
|
1286
|
+
# This will be returned by the google.longrunning.Operation.metadata field.
|
1287
|
+
class GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata
|
1288
|
+
include Google::Apis::Core::Hashable
|
1289
|
+
|
1290
|
+
# Operation create time.
|
1291
|
+
# Corresponds to the JSON property `createTime`
|
1292
|
+
# @return [String]
|
1293
|
+
attr_accessor :create_time
|
1294
|
+
|
1295
|
+
# Operation last update time. If the operation is done, this is also the finish
|
1296
|
+
# time.
|
1297
|
+
# Corresponds to the JSON property `updateTime`
|
1298
|
+
# @return [String]
|
1299
|
+
attr_accessor :update_time
|
1300
|
+
|
1301
|
+
def initialize(**args)
|
1302
|
+
update!(**args)
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# Update properties of this object
|
1306
|
+
def update!(**args)
|
1307
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1308
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1309
|
+
end
|
1310
|
+
end
|
1311
|
+
|
1138
1312
|
# Metadata for DeleteSchema LRO.
|
1139
1313
|
class GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata
|
1140
1314
|
include Google::Apis::Core::Hashable
|
@@ -1344,6 +1518,384 @@ module Google
|
|
1344
1518
|
end
|
1345
1519
|
end
|
1346
1520
|
|
1521
|
+
# Metadata that describes the training and serving parameters of an Engine.
|
1522
|
+
class GoogleCloudDiscoveryengineV1alphaEngine
|
1523
|
+
include Google::Apis::Core::Hashable
|
1524
|
+
|
1525
|
+
# Configurations for a Chat Engine.
|
1526
|
+
# Corresponds to the JSON property `chatEngineConfig`
|
1527
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig]
|
1528
|
+
attr_accessor :chat_engine_config
|
1529
|
+
|
1530
|
+
# Additional information of a Chat Engine. Fields in this message are output
|
1531
|
+
# only.
|
1532
|
+
# Corresponds to the JSON property `chatEngineMetadata`
|
1533
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata]
|
1534
|
+
attr_accessor :chat_engine_metadata
|
1535
|
+
|
1536
|
+
# Common configurations for an Engine.
|
1537
|
+
# Corresponds to the JSON property `commonConfig`
|
1538
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig]
|
1539
|
+
attr_accessor :common_config
|
1540
|
+
|
1541
|
+
# Output only. Timestamp the Recommendation Engine was created at.
|
1542
|
+
# Corresponds to the JSON property `createTime`
|
1543
|
+
# @return [String]
|
1544
|
+
attr_accessor :create_time
|
1545
|
+
|
1546
|
+
# The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and
|
1547
|
+
# SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at
|
1548
|
+
# most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple
|
1549
|
+
# DataStores in the same Collection can be associated here. Note that when used
|
1550
|
+
# in CreateEngineRequest, one DataStore id must be provided as the system will
|
1551
|
+
# use it for necessary intializations.
|
1552
|
+
# Corresponds to the JSON property `dataStoreIds`
|
1553
|
+
# @return [Array<String>]
|
1554
|
+
attr_accessor :data_store_ids
|
1555
|
+
|
1556
|
+
# Required. The display name of the engine. Should be human readable. UTF-8
|
1557
|
+
# encoded string with limit of 1024 characters.
|
1558
|
+
# Corresponds to the JSON property `displayName`
|
1559
|
+
# @return [String]
|
1560
|
+
attr_accessor :display_name
|
1561
|
+
|
1562
|
+
# Additional config specs for a Media Recommendation engine.
|
1563
|
+
# Corresponds to the JSON property `mediaRecommendationEngineConfig`
|
1564
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
|
1565
|
+
attr_accessor :media_recommendation_engine_config
|
1566
|
+
|
1567
|
+
# Immutable. The fully qualified resource name of the engine. This field must be
|
1568
|
+
# a UTF-8 encoded string with a length limit of 1024 characters. Format: `
|
1569
|
+
# projects/`project_number`/locations/`location`/collections/`collection`/
|
1570
|
+
# engines/`engine`` engine should be 1-63 characters, and valid characters are /
|
1571
|
+
# a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
|
1572
|
+
# Corresponds to the JSON property `name`
|
1573
|
+
# @return [String]
|
1574
|
+
attr_accessor :name
|
1575
|
+
|
1576
|
+
# Additional information of a recommendation engine.
|
1577
|
+
# Corresponds to the JSON property `recommendationMetadata`
|
1578
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata]
|
1579
|
+
attr_accessor :recommendation_metadata
|
1580
|
+
|
1581
|
+
# Configurations for a Search Engine.
|
1582
|
+
# Corresponds to the JSON property `searchEngineConfig`
|
1583
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig]
|
1584
|
+
attr_accessor :search_engine_config
|
1585
|
+
|
1586
|
+
# Additional config specs for a `similar-items` engine.
|
1587
|
+
# Corresponds to the JSON property `similarDocumentsConfig`
|
1588
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig]
|
1589
|
+
attr_accessor :similar_documents_config
|
1590
|
+
|
1591
|
+
# Required. The solutions of the engine.
|
1592
|
+
# Corresponds to the JSON property `solutionType`
|
1593
|
+
# @return [String]
|
1594
|
+
attr_accessor :solution_type
|
1595
|
+
|
1596
|
+
# Output only. Timestamp the Recommendation Engine was last updated.
|
1597
|
+
# Corresponds to the JSON property `updateTime`
|
1598
|
+
# @return [String]
|
1599
|
+
attr_accessor :update_time
|
1600
|
+
|
1601
|
+
def initialize(**args)
|
1602
|
+
update!(**args)
|
1603
|
+
end
|
1604
|
+
|
1605
|
+
# Update properties of this object
|
1606
|
+
def update!(**args)
|
1607
|
+
@chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
|
1608
|
+
@chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
|
1609
|
+
@common_config = args[:common_config] if args.key?(:common_config)
|
1610
|
+
@create_time = args[:create_time] if args.key?(:create_time)
|
1611
|
+
@data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
|
1612
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
1613
|
+
@media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
|
1614
|
+
@name = args[:name] if args.key?(:name)
|
1615
|
+
@recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
|
1616
|
+
@search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
|
1617
|
+
@similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
|
1618
|
+
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
1619
|
+
@update_time = args[:update_time] if args.key?(:update_time)
|
1620
|
+
end
|
1621
|
+
end
|
1622
|
+
|
1623
|
+
# Configurations for a Chat Engine.
|
1624
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
|
1625
|
+
include Google::Apis::Core::Hashable
|
1626
|
+
|
1627
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
1628
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
1629
|
+
# means they cannot be retrieved using GetEngine or ListEngine API after engine
|
1630
|
+
# creation.
|
1631
|
+
# Corresponds to the JSON property `agentCreationConfig`
|
1632
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
|
1633
|
+
attr_accessor :agent_creation_config
|
1634
|
+
|
1635
|
+
# The resource name of an exist Dialogflow agent to link to this Chat Engine.
|
1636
|
+
# Customers can either provide `agent_creation_config` to create agent or
|
1637
|
+
# provide an agent name that links the agent with the Chat engine. Format: `
|
1638
|
+
# projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
|
1639
|
+
# one-time consumed by and passed to Dialogflow service. It means they cannot be
|
1640
|
+
# retrieved using GetEngine or ListEngine API after engine creation. Please use
|
1641
|
+
# Engine.chat_engine_metadata.dialogflow_agent for actual agent association
|
1642
|
+
# after Engine is created.
|
1643
|
+
# Corresponds to the JSON property `dialogflowAgentToLink`
|
1644
|
+
# @return [String]
|
1645
|
+
attr_accessor :dialogflow_agent_to_link
|
1646
|
+
|
1647
|
+
def initialize(**args)
|
1648
|
+
update!(**args)
|
1649
|
+
end
|
1650
|
+
|
1651
|
+
# Update properties of this object
|
1652
|
+
def update!(**args)
|
1653
|
+
@agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
|
1654
|
+
@dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
|
1655
|
+
end
|
1656
|
+
end
|
1657
|
+
|
1658
|
+
# Configurations for generating a Dialogflow agent. Note that these
|
1659
|
+
# configurations are one-time consumed by and passed to Dialogflow service. It
|
1660
|
+
# means they cannot be retrieved using GetEngine or ListEngine API after engine
|
1661
|
+
# creation.
|
1662
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
|
1663
|
+
include Google::Apis::Core::Hashable
|
1664
|
+
|
1665
|
+
# Name of the company, organization or other entity that the agent represents.
|
1666
|
+
# Used for knowledge connector LLM prompt and for knowledge search.
|
1667
|
+
# Corresponds to the JSON property `business`
|
1668
|
+
# @return [String]
|
1669
|
+
attr_accessor :business
|
1670
|
+
|
1671
|
+
# Required. The default language of the agent as a language tag. See [Language
|
1672
|
+
# Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
|
1673
|
+
# list of the currently supported language codes.
|
1674
|
+
# Corresponds to the JSON property `defaultLanguageCode`
|
1675
|
+
# @return [String]
|
1676
|
+
attr_accessor :default_language_code
|
1677
|
+
|
1678
|
+
# Required. The time zone of the agent from the [time zone database](https://www.
|
1679
|
+
# iana.org/time-zones), e.g., America/New_York, Europe/Paris.
|
1680
|
+
# Corresponds to the JSON property `timeZone`
|
1681
|
+
# @return [String]
|
1682
|
+
attr_accessor :time_zone
|
1683
|
+
|
1684
|
+
def initialize(**args)
|
1685
|
+
update!(**args)
|
1686
|
+
end
|
1687
|
+
|
1688
|
+
# Update properties of this object
|
1689
|
+
def update!(**args)
|
1690
|
+
@business = args[:business] if args.key?(:business)
|
1691
|
+
@default_language_code = args[:default_language_code] if args.key?(:default_language_code)
|
1692
|
+
@time_zone = args[:time_zone] if args.key?(:time_zone)
|
1693
|
+
end
|
1694
|
+
end
|
1695
|
+
|
1696
|
+
# Additional information of a Chat Engine. Fields in this message are output
|
1697
|
+
# only.
|
1698
|
+
class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
|
1699
|
+
include Google::Apis::Core::Hashable
|
1700
|
+
|
1701
|
+
# The resource name of a Dialogflow agent, that this Chat Engine refers to.
|
1702
|
+
# Format: `projects//locations//agents/`.
|
1703
|
+
# Corresponds to the JSON property `dialogflowAgent`
|
1704
|
+
# @return [String]
|
1705
|
+
attr_accessor :dialogflow_agent
|
1706
|
+
|
1707
|
+
def initialize(**args)
|
1708
|
+
update!(**args)
|
1709
|
+
end
|
1710
|
+
|
1711
|
+
# Update properties of this object
|
1712
|
+
def update!(**args)
|
1713
|
+
@dialogflow_agent = args[:dialogflow_agent] if args.key?(:dialogflow_agent)
|
1714
|
+
end
|
1715
|
+
end
|
1716
|
+
|
1717
|
+
# Common configurations for an Engine.
|
1718
|
+
class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
|
1719
|
+
include Google::Apis::Core::Hashable
|
1720
|
+
|
1721
|
+
# The name of the company, business or entity that is associated with the engine.
|
1722
|
+
# Setting this may help improve LLM related features.
|
1723
|
+
# Corresponds to the JSON property `companyName`
|
1724
|
+
# @return [String]
|
1725
|
+
attr_accessor :company_name
|
1726
|
+
|
1727
|
+
def initialize(**args)
|
1728
|
+
update!(**args)
|
1729
|
+
end
|
1730
|
+
|
1731
|
+
# Update properties of this object
|
1732
|
+
def update!(**args)
|
1733
|
+
@company_name = args[:company_name] if args.key?(:company_name)
|
1734
|
+
end
|
1735
|
+
end
|
1736
|
+
|
1737
|
+
# Additional config specs for a Media Recommendation engine.
|
1738
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
|
1739
|
+
include Google::Apis::Core::Hashable
|
1740
|
+
|
1741
|
+
# The optimization objective e.g. `cvr`. This field together with
|
1742
|
+
# optimization_objective describe engine metadata to use to control engine
|
1743
|
+
# training and serving. Currently supported values: `ctr`, `cvr`. If not
|
1744
|
+
# specified, we choose default based on engine type. Default depends on type of
|
1745
|
+
# recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
|
1746
|
+
# Corresponds to the JSON property `optimizationObjective`
|
1747
|
+
# @return [String]
|
1748
|
+
attr_accessor :optimization_objective
|
1749
|
+
|
1750
|
+
# Custom threshold for `cvr` optimization_objective.
|
1751
|
+
# Corresponds to the JSON property `optimizationObjectiveConfig`
|
1752
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
|
1753
|
+
attr_accessor :optimization_objective_config
|
1754
|
+
|
1755
|
+
# The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
|
1756
|
+
# part of the cost of running the service is frequency of training - this can be
|
1757
|
+
# used to determine when to train engine in order to control cost. If not
|
1758
|
+
# specified: the default value for `CreateEngine` method is `TRAINING`. The
|
1759
|
+
# default value for `UpdateEngine` method is to keep the state the same as
|
1760
|
+
# before.
|
1761
|
+
# Corresponds to the JSON property `trainingState`
|
1762
|
+
# @return [String]
|
1763
|
+
attr_accessor :training_state
|
1764
|
+
|
1765
|
+
# Required. The type of engine e.g. `recommended-for-you`. This field together
|
1766
|
+
# with optimization_objective describe engine metadata to use to control engine
|
1767
|
+
# training and serving. Currently supported values: `recommended-for-you`, `
|
1768
|
+
# others-you-may-like`, `more-like-this`, `most-popular-items`.
|
1769
|
+
# Corresponds to the JSON property `type`
|
1770
|
+
# @return [String]
|
1771
|
+
attr_accessor :type
|
1772
|
+
|
1773
|
+
def initialize(**args)
|
1774
|
+
update!(**args)
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# Update properties of this object
|
1778
|
+
def update!(**args)
|
1779
|
+
@optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
|
1780
|
+
@optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
|
1781
|
+
@training_state = args[:training_state] if args.key?(:training_state)
|
1782
|
+
@type = args[:type] if args.key?(:type)
|
1783
|
+
end
|
1784
|
+
end
|
1785
|
+
|
1786
|
+
# Custom threshold for `cvr` optimization_objective.
|
1787
|
+
class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
|
1788
|
+
include Google::Apis::Core::Hashable
|
1789
|
+
|
1790
|
+
# Required. The name of the field to target. Currently supported values: `watch-
|
1791
|
+
# percentage`, `watch-time`.
|
1792
|
+
# Corresponds to the JSON property `targetField`
|
1793
|
+
# @return [String]
|
1794
|
+
attr_accessor :target_field
|
1795
|
+
|
1796
|
+
# Required. The threshold to be applied to the target (e.g., 0.5).
|
1797
|
+
# Corresponds to the JSON property `targetFieldValueFloat`
|
1798
|
+
# @return [Float]
|
1799
|
+
attr_accessor :target_field_value_float
|
1800
|
+
|
1801
|
+
def initialize(**args)
|
1802
|
+
update!(**args)
|
1803
|
+
end
|
1804
|
+
|
1805
|
+
# Update properties of this object
|
1806
|
+
def update!(**args)
|
1807
|
+
@target_field = args[:target_field] if args.key?(:target_field)
|
1808
|
+
@target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
|
1809
|
+
end
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
# Additional information of a recommendation engine.
|
1813
|
+
class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
|
1814
|
+
include Google::Apis::Core::Hashable
|
1815
|
+
|
1816
|
+
# Output only. The state of data requirements for this engine: `DATA_OK` and `
|
1817
|
+
# DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state.
|
1818
|
+
# Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines
|
1819
|
+
# were trained successfully before, but cannot be refreshed because the
|
1820
|
+
# underlying engine no longer has sufficient data for training.
|
1821
|
+
# Corresponds to the JSON property `dataState`
|
1822
|
+
# @return [String]
|
1823
|
+
attr_accessor :data_state
|
1824
|
+
|
1825
|
+
# Output only. The timestamp when the latest successful tune finished. Only
|
1826
|
+
# applicable on Media Recommendation engines.
|
1827
|
+
# Corresponds to the JSON property `lastTuneTime`
|
1828
|
+
# @return [String]
|
1829
|
+
attr_accessor :last_tune_time
|
1830
|
+
|
1831
|
+
# Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
|
1832
|
+
# Corresponds to the JSON property `servingState`
|
1833
|
+
# @return [String]
|
1834
|
+
attr_accessor :serving_state
|
1835
|
+
|
1836
|
+
# Output only. The latest tune operation id associated with the engine. Only
|
1837
|
+
# applicable on Media Recommendation engines. If present, this operation id can
|
1838
|
+
# be used to determine if there is an ongoing tune for this engine. To check the
|
1839
|
+
# operation status, send the GetOperation request with this operation id in the
|
1840
|
+
# engine resource format. If no tuning has happened for this engine, the string
|
1841
|
+
# is empty.
|
1842
|
+
# Corresponds to the JSON property `tuningOperation`
|
1843
|
+
# @return [String]
|
1844
|
+
attr_accessor :tuning_operation
|
1845
|
+
|
1846
|
+
def initialize(**args)
|
1847
|
+
update!(**args)
|
1848
|
+
end
|
1849
|
+
|
1850
|
+
# Update properties of this object
|
1851
|
+
def update!(**args)
|
1852
|
+
@data_state = args[:data_state] if args.key?(:data_state)
|
1853
|
+
@last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
|
1854
|
+
@serving_state = args[:serving_state] if args.key?(:serving_state)
|
1855
|
+
@tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
|
1856
|
+
end
|
1857
|
+
end
|
1858
|
+
|
1859
|
+
# Configurations for a Search Engine.
|
1860
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
|
1861
|
+
include Google::Apis::Core::Hashable
|
1862
|
+
|
1863
|
+
# The add-on that this search engine enables.
|
1864
|
+
# Corresponds to the JSON property `searchAddOns`
|
1865
|
+
# @return [Array<String>]
|
1866
|
+
attr_accessor :search_add_ons
|
1867
|
+
|
1868
|
+
# The search feature tier of this engine. Different tiers might have different
|
1869
|
+
# pricing. To learn more, please check the pricing documentation. Defaults to
|
1870
|
+
# SearchTier.SEARCH_TIER_STANDARD if not specified.
|
1871
|
+
# Corresponds to the JSON property `searchTier`
|
1872
|
+
# @return [String]
|
1873
|
+
attr_accessor :search_tier
|
1874
|
+
|
1875
|
+
def initialize(**args)
|
1876
|
+
update!(**args)
|
1877
|
+
end
|
1878
|
+
|
1879
|
+
# Update properties of this object
|
1880
|
+
def update!(**args)
|
1881
|
+
@search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
|
1882
|
+
@search_tier = args[:search_tier] if args.key?(:search_tier)
|
1883
|
+
end
|
1884
|
+
end
|
1885
|
+
|
1886
|
+
# Additional config specs for a `similar-items` engine.
|
1887
|
+
class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
|
1888
|
+
include Google::Apis::Core::Hashable
|
1889
|
+
|
1890
|
+
def initialize(**args)
|
1891
|
+
update!(**args)
|
1892
|
+
end
|
1893
|
+
|
1894
|
+
# Update properties of this object
|
1895
|
+
def update!(**args)
|
1896
|
+
end
|
1897
|
+
end
|
1898
|
+
|
1347
1899
|
# Configurations for fields of a schema. For example, configuring a field is
|
1348
1900
|
# indexable, or searchable.
|
1349
1901
|
class GoogleCloudDiscoveryengineV1alphaFieldConfig
|
@@ -1882,6 +2434,32 @@ module Google
|
|
1882
2434
|
end
|
1883
2435
|
end
|
1884
2436
|
|
2437
|
+
# Response message for DataStoreService.ListDataStores method.
|
2438
|
+
class GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
|
2439
|
+
include Google::Apis::Core::Hashable
|
2440
|
+
|
2441
|
+
# All the customer's DataStores.
|
2442
|
+
# Corresponds to the JSON property `dataStores`
|
2443
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore>]
|
2444
|
+
attr_accessor :data_stores
|
2445
|
+
|
2446
|
+
# A token that can be sent as ListDataStoresRequest.page_token to retrieve the
|
2447
|
+
# next page. If this field is omitted, there are no subsequent pages.
|
2448
|
+
# Corresponds to the JSON property `nextPageToken`
|
2449
|
+
# @return [String]
|
2450
|
+
attr_accessor :next_page_token
|
2451
|
+
|
2452
|
+
def initialize(**args)
|
2453
|
+
update!(**args)
|
2454
|
+
end
|
2455
|
+
|
2456
|
+
# Update properties of this object
|
2457
|
+
def update!(**args)
|
2458
|
+
@data_stores = args[:data_stores] if args.key?(:data_stores)
|
2459
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2460
|
+
end
|
2461
|
+
end
|
2462
|
+
|
1885
2463
|
# Response message for DocumentService.ListDocuments method.
|
1886
2464
|
class GoogleCloudDiscoveryengineV1alphaListDocumentsResponse
|
1887
2465
|
include Google::Apis::Core::Hashable
|
@@ -1908,6 +2486,31 @@ module Google
|
|
1908
2486
|
end
|
1909
2487
|
end
|
1910
2488
|
|
2489
|
+
# Response message for EngineService.ListEngines method.
|
2490
|
+
class GoogleCloudDiscoveryengineV1alphaListEnginesResponse
|
2491
|
+
include Google::Apis::Core::Hashable
|
2492
|
+
|
2493
|
+
# All the customer's Engines.
|
2494
|
+
# Corresponds to the JSON property `engines`
|
2495
|
+
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine>]
|
2496
|
+
attr_accessor :engines
|
2497
|
+
|
2498
|
+
# Not supported.
|
2499
|
+
# Corresponds to the JSON property `nextPageToken`
|
2500
|
+
# @return [String]
|
2501
|
+
attr_accessor :next_page_token
|
2502
|
+
|
2503
|
+
def initialize(**args)
|
2504
|
+
update!(**args)
|
2505
|
+
end
|
2506
|
+
|
2507
|
+
# Update properties of this object
|
2508
|
+
def update!(**args)
|
2509
|
+
@engines = args[:engines] if args.key?(:engines)
|
2510
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
2511
|
+
end
|
2512
|
+
end
|
2513
|
+
|
1911
2514
|
# Response message for SchemaService.ListSchemas method.
|
1912
2515
|
class GoogleCloudDiscoveryengineV1alphaListSchemasResponse
|
1913
2516
|
include Google::Apis::Core::Hashable
|
@@ -2096,6 +2699,19 @@ module Google
|
|
2096
2699
|
end
|
2097
2700
|
end
|
2098
2701
|
|
2702
|
+
# Request for pausing training of an engine.
|
2703
|
+
class GoogleCloudDiscoveryengineV1alphaPauseEngineRequest
|
2704
|
+
include Google::Apis::Core::Hashable
|
2705
|
+
|
2706
|
+
def initialize(**args)
|
2707
|
+
update!(**args)
|
2708
|
+
end
|
2709
|
+
|
2710
|
+
# Update properties of this object
|
2711
|
+
def update!(**args)
|
2712
|
+
end
|
2713
|
+
end
|
2714
|
+
|
2099
2715
|
# Metadata related to the progress of the PurgeDocuments operation. This will be
|
2100
2716
|
# returned by the google.longrunning.Operation.metadata field.
|
2101
2717
|
class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
|
@@ -2689,6 +3305,19 @@ module Google
|
|
2689
3305
|
end
|
2690
3306
|
end
|
2691
3307
|
|
3308
|
+
# Request for resuming training of an engine.
|
3309
|
+
class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
|
3310
|
+
include Google::Apis::Core::Hashable
|
3311
|
+
|
3312
|
+
def initialize(**args)
|
3313
|
+
update!(**args)
|
3314
|
+
end
|
3315
|
+
|
3316
|
+
# Update properties of this object
|
3317
|
+
def update!(**args)
|
3318
|
+
end
|
3319
|
+
end
|
3320
|
+
|
2692
3321
|
# Defines the structure and layout of a type of document data.
|
2693
3322
|
class GoogleCloudDiscoveryengineV1alphaSchema
|
2694
3323
|
include Google::Apis::Core::Hashable
|
@@ -2905,9 +3534,11 @@ module Google
|
|
2905
3534
|
alias_method :safe_search?, :safe_search
|
2906
3535
|
|
2907
3536
|
# Required. The resource name of the Search serving config, such as `projects/*/
|
2908
|
-
# locations/global/collections/default_collection/
|
2909
|
-
#
|
2910
|
-
#
|
3537
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3538
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3539
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
3540
|
+
# default_serving_config`. This field is used to identify the serving
|
3541
|
+
# configuration name, set of models used to make the search.
|
2911
3542
|
# Corresponds to the JSON property `servingConfig`
|
2912
3543
|
# @return [String]
|
2913
3544
|
attr_accessor :serving_config
|
@@ -4066,6 +4697,54 @@ module Google
|
|
4066
4697
|
end
|
4067
4698
|
end
|
4068
4699
|
|
4700
|
+
# Metadata associated with a tune operation.
|
4701
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
|
4702
|
+
include Google::Apis::Core::Hashable
|
4703
|
+
|
4704
|
+
# Required. The resource name of the engine that this tune applies to. Format: `
|
4705
|
+
# projects/`project_number`/locations/`location_id`/collections/`collection_id`/
|
4706
|
+
# engines/`engine_id``
|
4707
|
+
# Corresponds to the JSON property `engine`
|
4708
|
+
# @return [String]
|
4709
|
+
attr_accessor :engine
|
4710
|
+
|
4711
|
+
def initialize(**args)
|
4712
|
+
update!(**args)
|
4713
|
+
end
|
4714
|
+
|
4715
|
+
# Update properties of this object
|
4716
|
+
def update!(**args)
|
4717
|
+
@engine = args[:engine] if args.key?(:engine)
|
4718
|
+
end
|
4719
|
+
end
|
4720
|
+
|
4721
|
+
# Request to manually start a tuning process now (instead of waiting for the
|
4722
|
+
# periodically scheduled tuning to happen).
|
4723
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineRequest
|
4724
|
+
include Google::Apis::Core::Hashable
|
4725
|
+
|
4726
|
+
def initialize(**args)
|
4727
|
+
update!(**args)
|
4728
|
+
end
|
4729
|
+
|
4730
|
+
# Update properties of this object
|
4731
|
+
def update!(**args)
|
4732
|
+
end
|
4733
|
+
end
|
4734
|
+
|
4735
|
+
# Response associated with a tune operation.
|
4736
|
+
class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
|
4737
|
+
include Google::Apis::Core::Hashable
|
4738
|
+
|
4739
|
+
def initialize(**args)
|
4740
|
+
update!(**args)
|
4741
|
+
end
|
4742
|
+
|
4743
|
+
# Update properties of this object
|
4744
|
+
def update!(**args)
|
4745
|
+
end
|
4746
|
+
end
|
4747
|
+
|
4069
4748
|
# Metadata for UpdateSchema LRO.
|
4070
4749
|
class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
|
4071
4750
|
include Google::Apis::Core::Hashable
|