google-apis-discoveryengine_v1alpha 0.26.0 → 0.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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,393 @@ 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
+ # The industry vertical that the engine registers. The restriction of the Engine
1563
+ # industry vertical is based on DataStore: If unspecified, default to `GENERIC`.
1564
+ # Vertical on Engine has to match vertical of the DataStore liniked to the
1565
+ # engine.
1566
+ # Corresponds to the JSON property `industryVertical`
1567
+ # @return [String]
1568
+ attr_accessor :industry_vertical
1569
+
1570
+ # Additional config specs for a Media Recommendation engine.
1571
+ # Corresponds to the JSON property `mediaRecommendationEngineConfig`
1572
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig]
1573
+ attr_accessor :media_recommendation_engine_config
1574
+
1575
+ # Immutable. The fully qualified resource name of the engine. This field must be
1576
+ # a UTF-8 encoded string with a length limit of 1024 characters. Format: `
1577
+ # projects/`project_number`/locations/`location`/collections/`collection`/
1578
+ # engines/`engine`` engine should be 1-63 characters, and valid characters are /
1579
+ # a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.
1580
+ # Corresponds to the JSON property `name`
1581
+ # @return [String]
1582
+ attr_accessor :name
1583
+
1584
+ # Additional information of a recommendation engine.
1585
+ # Corresponds to the JSON property `recommendationMetadata`
1586
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata]
1587
+ attr_accessor :recommendation_metadata
1588
+
1589
+ # Configurations for a Search Engine.
1590
+ # Corresponds to the JSON property `searchEngineConfig`
1591
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig]
1592
+ attr_accessor :search_engine_config
1593
+
1594
+ # Additional config specs for a `similar-items` engine.
1595
+ # Corresponds to the JSON property `similarDocumentsConfig`
1596
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig]
1597
+ attr_accessor :similar_documents_config
1598
+
1599
+ # Required. The solutions of the engine.
1600
+ # Corresponds to the JSON property `solutionType`
1601
+ # @return [String]
1602
+ attr_accessor :solution_type
1603
+
1604
+ # Output only. Timestamp the Recommendation Engine was last updated.
1605
+ # Corresponds to the JSON property `updateTime`
1606
+ # @return [String]
1607
+ attr_accessor :update_time
1608
+
1609
+ def initialize(**args)
1610
+ update!(**args)
1611
+ end
1612
+
1613
+ # Update properties of this object
1614
+ def update!(**args)
1615
+ @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
1616
+ @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
1617
+ @common_config = args[:common_config] if args.key?(:common_config)
1618
+ @create_time = args[:create_time] if args.key?(:create_time)
1619
+ @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
1620
+ @display_name = args[:display_name] if args.key?(:display_name)
1621
+ @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
1622
+ @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
1623
+ @name = args[:name] if args.key?(:name)
1624
+ @recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
1625
+ @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
1626
+ @similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
1627
+ @solution_type = args[:solution_type] if args.key?(:solution_type)
1628
+ @update_time = args[:update_time] if args.key?(:update_time)
1629
+ end
1630
+ end
1631
+
1632
+ # Configurations for a Chat Engine.
1633
+ class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig
1634
+ include Google::Apis::Core::Hashable
1635
+
1636
+ # Configurations for generating a Dialogflow agent. Note that these
1637
+ # configurations are one-time consumed by and passed to Dialogflow service. It
1638
+ # means they cannot be retrieved using EngineService.GetEngine or EngineService.
1639
+ # ListEngines API after engine creation.
1640
+ # Corresponds to the JSON property `agentCreationConfig`
1641
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig]
1642
+ attr_accessor :agent_creation_config
1643
+
1644
+ # The resource name of an exist Dialogflow agent to link to this Chat Engine.
1645
+ # Customers can either provide `agent_creation_config` to create agent or
1646
+ # provide an agent name that links the agent with the Chat engine. Format: `
1647
+ # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
1648
+ # one-time consumed by and passed to Dialogflow service. It means they cannot be
1649
+ # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
1650
+ # engine creation. Please use chat_engine_metadata.dialogflow_agent for actual
1651
+ # agent association after Engine is created.
1652
+ # Corresponds to the JSON property `dialogflowAgentToLink`
1653
+ # @return [String]
1654
+ attr_accessor :dialogflow_agent_to_link
1655
+
1656
+ def initialize(**args)
1657
+ update!(**args)
1658
+ end
1659
+
1660
+ # Update properties of this object
1661
+ def update!(**args)
1662
+ @agent_creation_config = args[:agent_creation_config] if args.key?(:agent_creation_config)
1663
+ @dialogflow_agent_to_link = args[:dialogflow_agent_to_link] if args.key?(:dialogflow_agent_to_link)
1664
+ end
1665
+ end
1666
+
1667
+ # Configurations for generating a Dialogflow agent. Note that these
1668
+ # configurations are one-time consumed by and passed to Dialogflow service. It
1669
+ # means they cannot be retrieved using EngineService.GetEngine or EngineService.
1670
+ # ListEngines API after engine creation.
1671
+ class GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig
1672
+ include Google::Apis::Core::Hashable
1673
+
1674
+ # Name of the company, organization or other entity that the agent represents.
1675
+ # Used for knowledge connector LLM prompt and for knowledge search.
1676
+ # Corresponds to the JSON property `business`
1677
+ # @return [String]
1678
+ attr_accessor :business
1679
+
1680
+ # Required. The default language of the agent as a language tag. See [Language
1681
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language) for a
1682
+ # list of the currently supported language codes.
1683
+ # Corresponds to the JSON property `defaultLanguageCode`
1684
+ # @return [String]
1685
+ attr_accessor :default_language_code
1686
+
1687
+ # Required. The time zone of the agent from the [time zone database](https://www.
1688
+ # iana.org/time-zones), e.g., America/New_York, Europe/Paris.
1689
+ # Corresponds to the JSON property `timeZone`
1690
+ # @return [String]
1691
+ attr_accessor :time_zone
1692
+
1693
+ def initialize(**args)
1694
+ update!(**args)
1695
+ end
1696
+
1697
+ # Update properties of this object
1698
+ def update!(**args)
1699
+ @business = args[:business] if args.key?(:business)
1700
+ @default_language_code = args[:default_language_code] if args.key?(:default_language_code)
1701
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
1702
+ end
1703
+ end
1704
+
1705
+ # Additional information of a Chat Engine. Fields in this message are output
1706
+ # only.
1707
+ class GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata
1708
+ include Google::Apis::Core::Hashable
1709
+
1710
+ # The resource name of a Dialogflow agent, that this Chat Engine refers to.
1711
+ # Format: `projects//locations//agents/`.
1712
+ # Corresponds to the JSON property `dialogflowAgent`
1713
+ # @return [String]
1714
+ attr_accessor :dialogflow_agent
1715
+
1716
+ def initialize(**args)
1717
+ update!(**args)
1718
+ end
1719
+
1720
+ # Update properties of this object
1721
+ def update!(**args)
1722
+ @dialogflow_agent = args[:dialogflow_agent] if args.key?(:dialogflow_agent)
1723
+ end
1724
+ end
1725
+
1726
+ # Common configurations for an Engine.
1727
+ class GoogleCloudDiscoveryengineV1alphaEngineCommonConfig
1728
+ include Google::Apis::Core::Hashable
1729
+
1730
+ # The name of the company, business or entity that is associated with the engine.
1731
+ # Setting this may help improve LLM related features.
1732
+ # Corresponds to the JSON property `companyName`
1733
+ # @return [String]
1734
+ attr_accessor :company_name
1735
+
1736
+ def initialize(**args)
1737
+ update!(**args)
1738
+ end
1739
+
1740
+ # Update properties of this object
1741
+ def update!(**args)
1742
+ @company_name = args[:company_name] if args.key?(:company_name)
1743
+ end
1744
+ end
1745
+
1746
+ # Additional config specs for a Media Recommendation engine.
1747
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
1748
+ include Google::Apis::Core::Hashable
1749
+
1750
+ # The optimization objective e.g. `cvr`. This field together with
1751
+ # optimization_objective describe engine metadata to use to control engine
1752
+ # training and serving. Currently supported values: `ctr`, `cvr`. If not
1753
+ # specified, we choose default based on engine type. Default depends on type of
1754
+ # recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
1755
+ # Corresponds to the JSON property `optimizationObjective`
1756
+ # @return [String]
1757
+ attr_accessor :optimization_objective
1758
+
1759
+ # Custom threshold for `cvr` optimization_objective.
1760
+ # Corresponds to the JSON property `optimizationObjectiveConfig`
1761
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig]
1762
+ attr_accessor :optimization_objective_config
1763
+
1764
+ # The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since
1765
+ # part of the cost of running the service is frequency of training - this can be
1766
+ # used to determine when to train engine in order to control cost. If not
1767
+ # specified: the default value for `CreateEngine` method is `TRAINING`. The
1768
+ # default value for `UpdateEngine` method is to keep the state the same as
1769
+ # before.
1770
+ # Corresponds to the JSON property `trainingState`
1771
+ # @return [String]
1772
+ attr_accessor :training_state
1773
+
1774
+ # Required. The type of engine e.g. `recommended-for-you`. This field together
1775
+ # with optimization_objective describe engine metadata to use to control engine
1776
+ # training and serving. Currently supported values: `recommended-for-you`, `
1777
+ # others-you-may-like`, `more-like-this`, `most-popular-items`.
1778
+ # Corresponds to the JSON property `type`
1779
+ # @return [String]
1780
+ attr_accessor :type
1781
+
1782
+ def initialize(**args)
1783
+ update!(**args)
1784
+ end
1785
+
1786
+ # Update properties of this object
1787
+ def update!(**args)
1788
+ @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
1789
+ @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
1790
+ @training_state = args[:training_state] if args.key?(:training_state)
1791
+ @type = args[:type] if args.key?(:type)
1792
+ end
1793
+ end
1794
+
1795
+ # Custom threshold for `cvr` optimization_objective.
1796
+ class GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
1797
+ include Google::Apis::Core::Hashable
1798
+
1799
+ # Required. The name of the field to target. Currently supported values: `watch-
1800
+ # percentage`, `watch-time`.
1801
+ # Corresponds to the JSON property `targetField`
1802
+ # @return [String]
1803
+ attr_accessor :target_field
1804
+
1805
+ # Required. The threshold to be applied to the target (e.g., 0.5).
1806
+ # Corresponds to the JSON property `targetFieldValueFloat`
1807
+ # @return [Float]
1808
+ attr_accessor :target_field_value_float
1809
+
1810
+ def initialize(**args)
1811
+ update!(**args)
1812
+ end
1813
+
1814
+ # Update properties of this object
1815
+ def update!(**args)
1816
+ @target_field = args[:target_field] if args.key?(:target_field)
1817
+ @target_field_value_float = args[:target_field_value_float] if args.key?(:target_field_value_float)
1818
+ end
1819
+ end
1820
+
1821
+ # Additional information of a recommendation engine.
1822
+ class GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata
1823
+ include Google::Apis::Core::Hashable
1824
+
1825
+ # Output only. The state of data requirements for this engine: `DATA_OK` and `
1826
+ # DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state.
1827
+ # Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines
1828
+ # were trained successfully before, but cannot be refreshed because the
1829
+ # underlying engine no longer has sufficient data for training.
1830
+ # Corresponds to the JSON property `dataState`
1831
+ # @return [String]
1832
+ attr_accessor :data_state
1833
+
1834
+ # Output only. The timestamp when the latest successful tune finished. Only
1835
+ # applicable on Media Recommendation engines.
1836
+ # Corresponds to the JSON property `lastTuneTime`
1837
+ # @return [String]
1838
+ attr_accessor :last_tune_time
1839
+
1840
+ # Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
1841
+ # Corresponds to the JSON property `servingState`
1842
+ # @return [String]
1843
+ attr_accessor :serving_state
1844
+
1845
+ # Output only. The latest tune operation id associated with the engine. Only
1846
+ # applicable on Media Recommendation engines. If present, this operation id can
1847
+ # be used to determine if there is an ongoing tune for this engine. To check the
1848
+ # operation status, send the GetOperation request with this operation id in the
1849
+ # engine resource format. If no tuning has happened for this engine, the string
1850
+ # is empty.
1851
+ # Corresponds to the JSON property `tuningOperation`
1852
+ # @return [String]
1853
+ attr_accessor :tuning_operation
1854
+
1855
+ def initialize(**args)
1856
+ update!(**args)
1857
+ end
1858
+
1859
+ # Update properties of this object
1860
+ def update!(**args)
1861
+ @data_state = args[:data_state] if args.key?(:data_state)
1862
+ @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
1863
+ @serving_state = args[:serving_state] if args.key?(:serving_state)
1864
+ @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
1865
+ end
1866
+ end
1867
+
1868
+ # Configurations for a Search Engine.
1869
+ class GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig
1870
+ include Google::Apis::Core::Hashable
1871
+
1872
+ # The add-on that this search engine enables.
1873
+ # Corresponds to the JSON property `searchAddOns`
1874
+ # @return [Array<String>]
1875
+ attr_accessor :search_add_ons
1876
+
1877
+ # The search feature tier of this engine. Different tiers might have different
1878
+ # pricing. To learn more, please check the pricing documentation. Defaults to
1879
+ # SearchTier.SEARCH_TIER_STANDARD if not specified.
1880
+ # Corresponds to the JSON property `searchTier`
1881
+ # @return [String]
1882
+ attr_accessor :search_tier
1883
+
1884
+ def initialize(**args)
1885
+ update!(**args)
1886
+ end
1887
+
1888
+ # Update properties of this object
1889
+ def update!(**args)
1890
+ @search_add_ons = args[:search_add_ons] if args.key?(:search_add_ons)
1891
+ @search_tier = args[:search_tier] if args.key?(:search_tier)
1892
+ end
1893
+ end
1894
+
1895
+ # Additional config specs for a `similar-items` engine.
1896
+ class GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig
1897
+ include Google::Apis::Core::Hashable
1898
+
1899
+ def initialize(**args)
1900
+ update!(**args)
1901
+ end
1902
+
1903
+ # Update properties of this object
1904
+ def update!(**args)
1905
+ end
1906
+ end
1907
+
1347
1908
  # Configurations for fields of a schema. For example, configuring a field is
1348
1909
  # indexable, or searchable.
1349
1910
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
@@ -1882,6 +2443,32 @@ module Google
1882
2443
  end
1883
2444
  end
1884
2445
 
2446
+ # Response message for DataStoreService.ListDataStores method.
2447
+ class GoogleCloudDiscoveryengineV1alphaListDataStoresResponse
2448
+ include Google::Apis::Core::Hashable
2449
+
2450
+ # All the customer's DataStores.
2451
+ # Corresponds to the JSON property `dataStores`
2452
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDataStore>]
2453
+ attr_accessor :data_stores
2454
+
2455
+ # A token that can be sent as ListDataStoresRequest.page_token to retrieve the
2456
+ # next page. If this field is omitted, there are no subsequent pages.
2457
+ # Corresponds to the JSON property `nextPageToken`
2458
+ # @return [String]
2459
+ attr_accessor :next_page_token
2460
+
2461
+ def initialize(**args)
2462
+ update!(**args)
2463
+ end
2464
+
2465
+ # Update properties of this object
2466
+ def update!(**args)
2467
+ @data_stores = args[:data_stores] if args.key?(:data_stores)
2468
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2469
+ end
2470
+ end
2471
+
1885
2472
  # Response message for DocumentService.ListDocuments method.
1886
2473
  class GoogleCloudDiscoveryengineV1alphaListDocumentsResponse
1887
2474
  include Google::Apis::Core::Hashable
@@ -1908,6 +2495,31 @@ module Google
1908
2495
  end
1909
2496
  end
1910
2497
 
2498
+ # Response message for EngineService.ListEngines method.
2499
+ class GoogleCloudDiscoveryengineV1alphaListEnginesResponse
2500
+ include Google::Apis::Core::Hashable
2501
+
2502
+ # All the customer's Engines.
2503
+ # Corresponds to the JSON property `engines`
2504
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine>]
2505
+ attr_accessor :engines
2506
+
2507
+ # Not supported.
2508
+ # Corresponds to the JSON property `nextPageToken`
2509
+ # @return [String]
2510
+ attr_accessor :next_page_token
2511
+
2512
+ def initialize(**args)
2513
+ update!(**args)
2514
+ end
2515
+
2516
+ # Update properties of this object
2517
+ def update!(**args)
2518
+ @engines = args[:engines] if args.key?(:engines)
2519
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2520
+ end
2521
+ end
2522
+
1911
2523
  # Response message for SchemaService.ListSchemas method.
1912
2524
  class GoogleCloudDiscoveryengineV1alphaListSchemasResponse
1913
2525
  include Google::Apis::Core::Hashable
@@ -2096,6 +2708,19 @@ module Google
2096
2708
  end
2097
2709
  end
2098
2710
 
2711
+ # Request for pausing training of an engine.
2712
+ class GoogleCloudDiscoveryengineV1alphaPauseEngineRequest
2713
+ include Google::Apis::Core::Hashable
2714
+
2715
+ def initialize(**args)
2716
+ update!(**args)
2717
+ end
2718
+
2719
+ # Update properties of this object
2720
+ def update!(**args)
2721
+ end
2722
+ end
2723
+
2099
2724
  # Metadata related to the progress of the PurgeDocuments operation. This will be
2100
2725
  # returned by the google.longrunning.Operation.metadata field.
2101
2726
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -2689,6 +3314,19 @@ module Google
2689
3314
  end
2690
3315
  end
2691
3316
 
3317
+ # Request for resuming training of an engine.
3318
+ class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
3319
+ include Google::Apis::Core::Hashable
3320
+
3321
+ def initialize(**args)
3322
+ update!(**args)
3323
+ end
3324
+
3325
+ # Update properties of this object
3326
+ def update!(**args)
3327
+ end
3328
+ end
3329
+
2692
3330
  # Defines the structure and layout of a type of document data.
2693
3331
  class GoogleCloudDiscoveryengineV1alphaSchema
2694
3332
  include Google::Apis::Core::Hashable
@@ -2791,6 +3429,18 @@ module Google
2791
3429
  # @return [String]
2792
3430
  attr_accessor :branch
2793
3431
 
3432
+ # The default filter that is applied when a user performs a search without
3433
+ # checking any filters on the search page. The filter applied to every search
3434
+ # request when quality improvement such as query expansion is needed. In the
3435
+ # case a query does not have a sufficient amount of results this filter will be
3436
+ # used to determine whether or not to enable the query expansion flow. The
3437
+ # original filter will still be used for the query expanded search. This field
3438
+ # is strongly recommended to achieve high search quality. For more information
3439
+ # about filter syntax, see SearchRequest.filter.
3440
+ # Corresponds to the JSON property `canonicalFilter`
3441
+ # @return [String]
3442
+ attr_accessor :canonical_filter
3443
+
2794
3444
  # A specification for configuring the behavior of content search.
2795
3445
  # Corresponds to the JSON property `contentSearchSpec`
2796
3446
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec]
@@ -2905,9 +3555,11 @@ module Google
2905
3555
  alias_method :safe_search?, :safe_search
2906
3556
 
2907
3557
  # Required. The resource name of the Search serving config, such as `projects/*/
2908
- # locations/global/collections/default_collection/dataStores/default_data_store/
2909
- # servingConfigs/default_serving_config`. This field is used to identify the
2910
- # serving configuration name, set of models used to make the search.
3558
+ # locations/global/collections/default_collection/engines/*/servingConfigs/
3559
+ # default_serving_config`, or `projects/*/locations/global/collections/
3560
+ # default_collection/dataStores/default_data_store/servingConfigs/
3561
+ # default_serving_config`. This field is used to identify the serving
3562
+ # configuration name, set of models used to make the search.
2911
3563
  # Corresponds to the JSON property `servingConfig`
2912
3564
  # @return [String]
2913
3565
  attr_accessor :serving_config
@@ -2957,6 +3609,7 @@ module Google
2957
3609
  def update!(**args)
2958
3610
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2959
3611
  @branch = args[:branch] if args.key?(:branch)
3612
+ @canonical_filter = args[:canonical_filter] if args.key?(:canonical_filter)
2960
3613
  @content_search_spec = args[:content_search_spec] if args.key?(:content_search_spec)
2961
3614
  @embedding_spec = args[:embedding_spec] if args.key?(:embedding_spec)
2962
3615
  @facet_specs = args[:facet_specs] if args.key?(:facet_specs)
@@ -4066,6 +4719,54 @@ module Google
4066
4719
  end
4067
4720
  end
4068
4721
 
4722
+ # Metadata associated with a tune operation.
4723
+ class GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata
4724
+ include Google::Apis::Core::Hashable
4725
+
4726
+ # Required. The resource name of the engine that this tune applies to. Format: `
4727
+ # projects/`project_number`/locations/`location_id`/collections/`collection_id`/
4728
+ # engines/`engine_id``
4729
+ # Corresponds to the JSON property `engine`
4730
+ # @return [String]
4731
+ attr_accessor :engine
4732
+
4733
+ def initialize(**args)
4734
+ update!(**args)
4735
+ end
4736
+
4737
+ # Update properties of this object
4738
+ def update!(**args)
4739
+ @engine = args[:engine] if args.key?(:engine)
4740
+ end
4741
+ end
4742
+
4743
+ # Request to manually start a tuning process now (instead of waiting for the
4744
+ # periodically scheduled tuning to happen).
4745
+ class GoogleCloudDiscoveryengineV1alphaTuneEngineRequest
4746
+ include Google::Apis::Core::Hashable
4747
+
4748
+ def initialize(**args)
4749
+ update!(**args)
4750
+ end
4751
+
4752
+ # Update properties of this object
4753
+ def update!(**args)
4754
+ end
4755
+ end
4756
+
4757
+ # Response associated with a tune operation.
4758
+ class GoogleCloudDiscoveryengineV1alphaTuneEngineResponse
4759
+ include Google::Apis::Core::Hashable
4760
+
4761
+ def initialize(**args)
4762
+ update!(**args)
4763
+ end
4764
+
4765
+ # Update properties of this object
4766
+ def update!(**args)
4767
+ end
4768
+ end
4769
+
4069
4770
  # Metadata for UpdateSchema LRO.
4070
4771
  class GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata
4071
4772
  include Google::Apis::Core::Hashable