@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240108 → 0.0.20240118

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.
Files changed (2) hide show
  1. package/index.d.ts +356 -11
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
12
- // Revision: 20240108
12
+ // Revision: 20240118
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -122,7 +122,7 @@ declare namespace gapi.client {
122
122
  includeTailSuggestions?: boolean;
123
123
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
124
124
  query?: string;
125
- /** Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
125
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
126
126
  queryModel?: string;
127
127
  /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
128
128
  userPseudoId?: string;
@@ -350,7 +350,7 @@ declare namespace gapi.client {
350
350
  commonConfig?: GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
351
351
  /** Output only. Timestamp the Recommendation Engine was created at. */
352
352
  createTime?: string;
353
- /** 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 can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary intializations. */
353
+ /** 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 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. */
354
354
  dataStoreIds?: string[];
355
355
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
356
356
  displayName?: string;
@@ -392,17 +392,17 @@ declare namespace gapi.client {
392
392
  dialogflowAgent?: string;
393
393
  }
394
394
  interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
395
- /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
395
+ /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
396
396
  companyName?: string;
397
397
  }
398
398
  interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
399
- /** The optimization objective e.g. `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` */
399
+ /** The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` */
400
400
  optimizationObjective?: string;
401
401
  /** Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5). */
402
402
  optimizationObjectiveConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
403
403
  /** The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before. */
404
404
  trainingState?: string;
405
- /** Required. The type of engine e.g. `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. */
405
+ /** Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`. */
406
406
  type?: string;
407
407
  }
408
408
  interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
@@ -1156,16 +1156,19 @@ declare namespace gapi.client {
1156
1156
  providedUriPattern?: string;
1157
1157
  /** Output only. Site ownership and validity verification status. */
1158
1158
  siteVerificationInfo?: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
1159
- /** The type of the target site, e.g. whether the site is to be included or excluded. */
1159
+ /** The type of the target site, e.g., whether the site is to be included or excluded. */
1160
1160
  type?: string;
1161
1161
  /** Output only. The target site's last updated time. */
1162
1162
  updateTime?: string;
1163
1163
  }
1164
1164
  interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason {
1165
1165
  /** Failed due to insufficient quota. */
1166
- quotaFailure?: any;
1166
+ quotaFailure?: GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
1167
+ }
1168
+ interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
1169
+ /** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
1170
+ totalRequiredQuota?: string;
1167
1171
  }
1168
- interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
1169
1172
  interface GoogleCloudDiscoveryengineV1alphaTextInput {
1170
1173
  /** Conversation context of the input. */
1171
1174
  context?: GoogleCloudDiscoveryengineV1alphaConversationContext;
@@ -1335,6 +1338,8 @@ declare namespace gapi.client {
1335
1338
  fieldsUiComponentsMap?: {
1336
1339
  [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
1337
1340
  };
1341
+ /** Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. */
1342
+ industryVertical?: string;
1338
1343
  /** Output only. Whether LLM is enabled in the corresponding data store. */
1339
1344
  llmEnabled?: boolean;
1340
1345
  /** Output only. Whether the customer accepted data use terms. */
@@ -1394,18 +1399,158 @@ declare namespace gapi.client {
1394
1399
  /** The token in response. */
1395
1400
  uToken?: string;
1396
1401
  }
1402
+ interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
1403
+ /** Operation create time. */
1404
+ createTime?: string;
1405
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1406
+ updateTime?: string;
1407
+ }
1408
+ interface GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse {
1409
+ /** TargetSites created. */
1410
+ targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
1411
+ }
1412
+ interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
1413
+ /** Operation create time. */
1414
+ createTime?: string;
1415
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1416
+ updateTime?: string;
1417
+ }
1418
+ interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse {
1419
+ /** TargetSites created. */
1420
+ targetSites?: GoogleCloudDiscoveryengineV1betaTargetSite[];
1421
+ }
1422
+ interface GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata {
1423
+ /** Operation create time. */
1424
+ createTime?: string;
1425
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1426
+ updateTime?: string;
1427
+ }
1428
+ interface GoogleCloudDiscoveryengineV1betaCreateEngineMetadata {
1429
+ /** Operation create time. */
1430
+ createTime?: string;
1431
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1432
+ updateTime?: string;
1433
+ }
1397
1434
  interface GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata {
1398
1435
  /** Operation create time. */
1399
1436
  createTime?: string;
1400
1437
  /** Operation last update time. If the operation is done, this is also the finish time. */
1401
1438
  updateTime?: string;
1402
1439
  }
1440
+ interface GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata {
1441
+ /** Operation create time. */
1442
+ createTime?: string;
1443
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1444
+ updateTime?: string;
1445
+ }
1446
+ interface GoogleCloudDiscoveryengineV1betaDataStore {
1447
+ /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
1448
+ contentConfig?: string;
1449
+ /** Output only. Timestamp the DataStore was created at. */
1450
+ createTime?: string;
1451
+ /** Output only. The id of the default Schema asscociated to this data store. */
1452
+ defaultSchemaId?: string;
1453
+ /** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
1454
+ displayName?: string;
1455
+ /** Immutable. The industry vertical that the data store registers. */
1456
+ industryVertical?: string;
1457
+ /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1458
+ name?: string;
1459
+ /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
1460
+ solutionTypes?: string[];
1461
+ }
1462
+ interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
1463
+ /** Operation create time. */
1464
+ createTime?: string;
1465
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1466
+ updateTime?: string;
1467
+ }
1468
+ interface GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata {
1469
+ /** Operation create time. */
1470
+ createTime?: string;
1471
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1472
+ updateTime?: string;
1473
+ }
1403
1474
  interface GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata {
1404
1475
  /** Operation create time. */
1405
1476
  createTime?: string;
1406
1477
  /** Operation last update time. If the operation is done, this is also the finish time. */
1407
1478
  updateTime?: string;
1408
1479
  }
1480
+ interface GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata {
1481
+ /** Operation create time. */
1482
+ createTime?: string;
1483
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1484
+ updateTime?: string;
1485
+ }
1486
+ interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata {
1487
+ /** Operation create time. */
1488
+ createTime?: string;
1489
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1490
+ updateTime?: string;
1491
+ }
1492
+ interface GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {}
1493
+ interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata {
1494
+ /** Operation create time. */
1495
+ createTime?: string;
1496
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1497
+ updateTime?: string;
1498
+ }
1499
+ interface GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {}
1500
+ interface GoogleCloudDiscoveryengineV1betaEngine {
1501
+ /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
1502
+ chatEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig;
1503
+ /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
1504
+ chatEngineMetadata?: GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata;
1505
+ /** Common config spec that specifies the metadata of the engine. */
1506
+ commonConfig?: GoogleCloudDiscoveryengineV1betaEngineCommonConfig;
1507
+ /** Output only. Timestamp the Recommendation Engine was created at. */
1508
+ createTime?: string;
1509
+ /** 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 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. */
1510
+ dataStoreIds?: string[];
1511
+ /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
1512
+ displayName?: string;
1513
+ /** 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 liniked to the engine. */
1514
+ industryVertical?: string;
1515
+ /** 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_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
1516
+ name?: string;
1517
+ /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
1518
+ searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
1519
+ /** Required. The solutions of the engine. */
1520
+ solutionType?: string;
1521
+ /** Output only. Timestamp the Recommendation Engine was last updated. */
1522
+ updateTime?: string;
1523
+ }
1524
+ interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig {
1525
+ /** 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 EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
1526
+ agentCreationConfig?: GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig;
1527
+ /** 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//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
1528
+ dialogflowAgentToLink?: string;
1529
+ }
1530
+ interface GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig {
1531
+ /** Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */
1532
+ business?: string;
1533
+ /** 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. */
1534
+ defaultLanguageCode?: string;
1535
+ /** 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. */
1536
+ location?: string;
1537
+ /** 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. */
1538
+ timeZone?: string;
1539
+ }
1540
+ interface GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata {
1541
+ /** The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */
1542
+ dialogflowAgent?: string;
1543
+ }
1544
+ interface GoogleCloudDiscoveryengineV1betaEngineCommonConfig {
1545
+ /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
1546
+ companyName?: string;
1547
+ }
1548
+ interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
1549
+ /** The add-on that this search engine enables. */
1550
+ searchAddOns?: string[];
1551
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
1552
+ searchTier?: string;
1553
+ }
1409
1554
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
1410
1555
  /** Operation create time. */
1411
1556
  createTime?: string;
@@ -1496,24 +1641,184 @@ declare namespace gapi.client {
1496
1641
  /** The structured representation of the schema. */
1497
1642
  structSchema?: {[P in string]: any};
1498
1643
  }
1644
+ interface GoogleCloudDiscoveryengineV1betaSiteVerificationInfo {
1645
+ /** Site verification state indicating the ownership and validity. */
1646
+ siteVerificationState?: string;
1647
+ /** Latest site verification time. */
1648
+ verifyTime?: string;
1649
+ }
1650
+ interface GoogleCloudDiscoveryengineV1betaTargetSite {
1651
+ /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
1652
+ exactMatch?: boolean;
1653
+ /** Output only. Failure reason. */
1654
+ failureReason?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason;
1655
+ /** Output only. This is system-generated based on the provided_uri_pattern. */
1656
+ generatedUriPattern?: string;
1657
+ /** Output only. Indexing status. */
1658
+ indexingStatus?: string;
1659
+ /** Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. */
1660
+ name?: string;
1661
+ /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
1662
+ providedUriPattern?: string;
1663
+ /** Output only. Site ownership and validity verification status. */
1664
+ siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
1665
+ /** The type of the target site, e.g., whether the site is to be included or excluded. */
1666
+ type?: string;
1667
+ /** Output only. The target site's last updated time. */
1668
+ updateTime?: string;
1669
+ }
1670
+ interface GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason {
1671
+ /** Failed due to insufficient quota. */
1672
+ quotaFailure?: GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure;
1673
+ }
1674
+ interface GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure {
1675
+ /** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
1676
+ totalRequiredQuota?: string;
1677
+ }
1499
1678
  interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
1500
1679
  /** Operation create time. */
1501
1680
  createTime?: string;
1502
1681
  /** Operation last update time. If the operation is done, this is also the finish time. */
1503
1682
  updateTime?: string;
1504
1683
  }
1684
+ interface GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata {
1685
+ /** Operation create time. */
1686
+ createTime?: string;
1687
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1688
+ updateTime?: string;
1689
+ }
1690
+ interface GoogleCloudDiscoveryengineV1CreateDataStoreMetadata {
1691
+ /** Operation create time. */
1692
+ createTime?: string;
1693
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1694
+ updateTime?: string;
1695
+ }
1696
+ interface GoogleCloudDiscoveryengineV1CreateEngineMetadata {
1697
+ /** Operation create time. */
1698
+ createTime?: string;
1699
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1700
+ updateTime?: string;
1701
+ }
1505
1702
  interface GoogleCloudDiscoveryengineV1CreateSchemaMetadata {
1506
1703
  /** Operation create time. */
1507
1704
  createTime?: string;
1508
1705
  /** Operation last update time. If the operation is done, this is also the finish time. */
1509
1706
  updateTime?: string;
1510
1707
  }
1708
+ interface GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata {
1709
+ /** Operation create time. */
1710
+ createTime?: string;
1711
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1712
+ updateTime?: string;
1713
+ }
1714
+ interface GoogleCloudDiscoveryengineV1DataStore {
1715
+ /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
1716
+ contentConfig?: string;
1717
+ /** Output only. Timestamp the DataStore was created at. */
1718
+ createTime?: string;
1719
+ /** Output only. The id of the default Schema asscociated to this data store. */
1720
+ defaultSchemaId?: string;
1721
+ /** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
1722
+ displayName?: string;
1723
+ /** Immutable. The industry vertical that the data store registers. */
1724
+ industryVertical?: string;
1725
+ /** Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
1726
+ name?: string;
1727
+ /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
1728
+ solutionTypes?: string[];
1729
+ }
1730
+ interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
1731
+ /** Operation create time. */
1732
+ createTime?: string;
1733
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1734
+ updateTime?: string;
1735
+ }
1736
+ interface GoogleCloudDiscoveryengineV1DeleteEngineMetadata {
1737
+ /** Operation create time. */
1738
+ createTime?: string;
1739
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1740
+ updateTime?: string;
1741
+ }
1511
1742
  interface GoogleCloudDiscoveryengineV1DeleteSchemaMetadata {
1512
1743
  /** Operation create time. */
1513
1744
  createTime?: string;
1514
1745
  /** Operation last update time. If the operation is done, this is also the finish time. */
1515
1746
  updateTime?: string;
1516
1747
  }
1748
+ interface GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata {
1749
+ /** Operation create time. */
1750
+ createTime?: string;
1751
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1752
+ updateTime?: string;
1753
+ }
1754
+ interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata {
1755
+ /** Operation create time. */
1756
+ createTime?: string;
1757
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1758
+ updateTime?: string;
1759
+ }
1760
+ interface GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {}
1761
+ interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata {
1762
+ /** Operation create time. */
1763
+ createTime?: string;
1764
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1765
+ updateTime?: string;
1766
+ }
1767
+ interface GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {}
1768
+ interface GoogleCloudDiscoveryengineV1Engine {
1769
+ /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
1770
+ chatEngineConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfig;
1771
+ /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
1772
+ chatEngineMetadata?: GoogleCloudDiscoveryengineV1EngineChatEngineMetadata;
1773
+ /** Common config spec that specifies the metadata of the engine. */
1774
+ commonConfig?: GoogleCloudDiscoveryengineV1EngineCommonConfig;
1775
+ /** Output only. Timestamp the Recommendation Engine was created at. */
1776
+ createTime?: string;
1777
+ /** 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 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. */
1778
+ dataStoreIds?: string[];
1779
+ /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
1780
+ displayName?: string;
1781
+ /** 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 liniked to the engine. */
1782
+ industryVertical?: string;
1783
+ /** 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_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
1784
+ name?: string;
1785
+ /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
1786
+ searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
1787
+ /** Required. The solutions of the engine. */
1788
+ solutionType?: string;
1789
+ /** Output only. Timestamp the Recommendation Engine was last updated. */
1790
+ updateTime?: string;
1791
+ }
1792
+ interface GoogleCloudDiscoveryengineV1EngineChatEngineConfig {
1793
+ /** 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 EngineService.GetEngine or EngineService.ListEngines API after engine creation. */
1794
+ agentCreationConfig?: GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig;
1795
+ /** 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//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */
1796
+ dialogflowAgentToLink?: string;
1797
+ }
1798
+ interface GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig {
1799
+ /** Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */
1800
+ business?: string;
1801
+ /** 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. */
1802
+ defaultLanguageCode?: string;
1803
+ /** 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. */
1804
+ location?: string;
1805
+ /** 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. */
1806
+ timeZone?: string;
1807
+ }
1808
+ interface GoogleCloudDiscoveryengineV1EngineChatEngineMetadata {
1809
+ /** The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */
1810
+ dialogflowAgent?: string;
1811
+ }
1812
+ interface GoogleCloudDiscoveryengineV1EngineCommonConfig {
1813
+ /** Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
1814
+ companyName?: string;
1815
+ }
1816
+ interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
1817
+ /** The add-on that this search engine enables. */
1818
+ searchAddOns?: string[];
1819
+ /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
1820
+ searchTier?: string;
1821
+ }
1517
1822
  interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
1518
1823
  /** Operation create time. */
1519
1824
  createTime?: string;
@@ -1604,12 +1909,52 @@ declare namespace gapi.client {
1604
1909
  /** The structured representation of the schema. */
1605
1910
  structSchema?: {[P in string]: any};
1606
1911
  }
1912
+ interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
1913
+ /** Site verification state indicating the ownership and validity. */
1914
+ siteVerificationState?: string;
1915
+ /** Latest site verification time. */
1916
+ verifyTime?: string;
1917
+ }
1918
+ interface GoogleCloudDiscoveryengineV1TargetSite {
1919
+ /** Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine. */
1920
+ exactMatch?: boolean;
1921
+ /** Output only. Failure reason. */
1922
+ failureReason?: GoogleCloudDiscoveryengineV1TargetSiteFailureReason;
1923
+ /** Output only. This is system-generated based on the provided_uri_pattern. */
1924
+ generatedUriPattern?: string;
1925
+ /** Output only. Indexing status. */
1926
+ indexingStatus?: string;
1927
+ /** Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. */
1928
+ name?: string;
1929
+ /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
1930
+ providedUriPattern?: string;
1931
+ /** Output only. Site ownership and validity verification status. */
1932
+ siteVerificationInfo?: GoogleCloudDiscoveryengineV1SiteVerificationInfo;
1933
+ /** The type of the target site, e.g., whether the site is to be included or excluded. */
1934
+ type?: string;
1935
+ /** Output only. The target site's last updated time. */
1936
+ updateTime?: string;
1937
+ }
1938
+ interface GoogleCloudDiscoveryengineV1TargetSiteFailureReason {
1939
+ /** Failed due to insufficient quota. */
1940
+ quotaFailure?: GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure;
1941
+ }
1942
+ interface GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure {
1943
+ /** This number is an estimation on how much total quota this project needs to successfully complete indexing. */
1944
+ totalRequiredQuota?: string;
1945
+ }
1607
1946
  interface GoogleCloudDiscoveryengineV1UpdateSchemaMetadata {
1608
1947
  /** Operation create time. */
1609
1948
  createTime?: string;
1610
1949
  /** Operation last update time. If the operation is done, this is also the finish time. */
1611
1950
  updateTime?: string;
1612
1951
  }
1952
+ interface GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata {
1953
+ /** Operation create time. */
1954
+ createTime?: string;
1955
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1956
+ updateTime?: string;
1957
+ }
1613
1958
  interface GoogleLongrunningListOperationsResponse {
1614
1959
  /** The standard List next-page token. */
1615
1960
  nextPageToken?: string;
@@ -4130,7 +4475,7 @@ declare namespace gapi.client {
4130
4475
  prettyPrint?: boolean;
4131
4476
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
4132
4477
  query?: string;
4133
- /** Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
4478
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
4134
4479
  queryModel?: string;
4135
4480
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
4136
4481
  quotaUser?: string;
@@ -7355,7 +7700,7 @@ declare namespace gapi.client {
7355
7700
  prettyPrint?: boolean;
7356
7701
  /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
7357
7702
  query?: string;
7358
- /** Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
7703
+ /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
7359
7704
  queryModel?: string;
7360
7705
  /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
7361
7706
  quotaUser?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20240108",
3
+ "version": "0.0.20240118",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",