@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240801 → 0.0.20240813

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 +257 -9
  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=v1
12
- // Revision: 20240801
12
+ // Revision: 20240813
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -91,7 +91,7 @@ declare namespace gapi.client {
91
91
  gcsStagingDir?: string;
92
92
  /** Required. The AlloyDB location to copy the data from with a length limit of 256 characters. */
93
93
  locationId?: string;
94
- /** The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
94
+ /** The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
95
95
  projectId?: string;
96
96
  /** Required. The AlloyDB table to copy the data from with a length limit of 256 characters. */
97
97
  tableId?: string;
@@ -285,7 +285,7 @@ declare namespace gapi.client {
285
285
  startTime?: string;
286
286
  }
287
287
  interface GoogleCloudDiscoveryengineV1alphaControl {
288
- /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
288
+ /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
289
289
  associatedServingConfigIds?: string[];
290
290
  /** Defines a boost-type control */
291
291
  boostAction?: GoogleCloudDiscoveryengineV1alphaControlBoostAction;
@@ -398,6 +398,8 @@ declare namespace gapi.client {
398
398
  solutionTypes?: string[];
399
399
  /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
400
400
  startingSchema?: GoogleCloudDiscoveryengineV1alphaSchema;
401
+ /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
402
+ workspaceConfig?: GoogleCloudDiscoveryengineV1alphaWorkspaceConfig;
401
403
  }
402
404
  interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
403
405
  /** Operation create time. */
@@ -1237,6 +1239,12 @@ declare namespace gapi.client {
1237
1239
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1238
1240
  userId?: string;
1239
1241
  }
1242
+ interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
1243
+ /** Obfuscated Dasher customer ID. */
1244
+ dasherCustomerId?: string;
1245
+ /** The Google Workspace data source. */
1246
+ type?: string;
1247
+ }
1240
1248
  interface GoogleCloudDiscoveryengineV1Answer {
1241
1249
  /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
1242
1250
  answerSkippedReasons?: string[];
@@ -1551,6 +1559,22 @@ declare namespace gapi.client {
1551
1559
  /** TargetSites created. */
1552
1560
  targetSites?: GoogleCloudDiscoveryengineV1TargetSite[];
1553
1561
  }
1562
+ interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse {
1563
+ /** The metadata of the Documents. */
1564
+ documentsMetadata?: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata[];
1565
+ }
1566
+ interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata {
1567
+ /** The timestamp of the last time the Document was last indexed. */
1568
+ lastRefreshedTime?: string;
1569
+ /** The value of the matcher that was used to match the Document. */
1570
+ matcherValue?: GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue;
1571
+ /** The status of the document. */
1572
+ status?: string;
1573
+ }
1574
+ interface GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue {
1575
+ /** If match by URI, the URI of the Document. */
1576
+ uri?: string;
1577
+ }
1554
1578
  interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
1555
1579
  interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
1556
1580
  /** Operation create time. */
@@ -1581,7 +1605,7 @@ declare namespace gapi.client {
1581
1605
  startTime?: string;
1582
1606
  }
1583
1607
  interface GoogleCloudDiscoveryengineV1betaControl {
1584
- /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
1608
+ /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
1585
1609
  associatedServingConfigIds?: string[];
1586
1610
  /** Defines a boost-type control */
1587
1611
  boostAction?: GoogleCloudDiscoveryengineV1betaControlBoostAction;
@@ -1686,6 +1710,8 @@ declare namespace gapi.client {
1686
1710
  solutionTypes?: string[];
1687
1711
  /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
1688
1712
  startingSchema?: GoogleCloudDiscoveryengineV1betaSchema;
1713
+ /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
1714
+ workspaceConfig?: GoogleCloudDiscoveryengineV1betaWorkspaceConfig;
1689
1715
  }
1690
1716
  interface GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata {
1691
1717
  /** Operation create time. */
@@ -2085,6 +2111,8 @@ declare namespace gapi.client {
2085
2111
  rankingExpression?: string;
2086
2112
  /** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
2087
2113
  regionCode?: string;
2114
+ /** The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */
2115
+ relevanceThreshold?: string;
2088
2116
  /** Whether to turn on safe search. This is only supported for website search. */
2089
2117
  safeSearch?: boolean;
2090
2118
  /** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
@@ -2345,6 +2373,12 @@ declare namespace gapi.client {
2345
2373
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2346
2374
  userId?: string;
2347
2375
  }
2376
+ interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
2377
+ /** Obfuscated Dasher customer ID. */
2378
+ dasherCustomerId?: string;
2379
+ /** The Google Workspace data source. */
2380
+ type?: string;
2381
+ }
2348
2382
  interface GoogleCloudDiscoveryengineV1BigQuerySource {
2349
2383
  /** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. */
2350
2384
  dataSchema?: string;
@@ -2354,7 +2388,7 @@ declare namespace gapi.client {
2354
2388
  gcsStagingDir?: string;
2355
2389
  /** BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */
2356
2390
  partitionDate?: GoogleTypeDate;
2357
- /** The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2391
+ /** The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2358
2392
  projectId?: string;
2359
2393
  /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
2360
2394
  tableId?: string;
@@ -2392,7 +2426,7 @@ declare namespace gapi.client {
2392
2426
  bigtableOptions?: GoogleCloudDiscoveryengineV1BigtableOptions;
2393
2427
  /** Required. The instance ID of the Cloud Bigtable that needs to be imported. */
2394
2428
  instanceId?: string;
2395
- /** The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2429
+ /** The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2396
2430
  projectId?: string;
2397
2431
  /** Required. The table ID of the Cloud Bigtable that needs to be imported. */
2398
2432
  tableId?: string;
@@ -2424,6 +2458,8 @@ declare namespace gapi.client {
2424
2458
  endPos?: number;
2425
2459
  /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
2426
2460
  groundingCheckRequired?: boolean;
2461
+ /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. */
2462
+ score?: number;
2427
2463
  /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
2428
2464
  startPos?: number;
2429
2465
  }
@@ -2478,7 +2514,7 @@ declare namespace gapi.client {
2478
2514
  instanceId?: string;
2479
2515
  /** Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */
2480
2516
  offload?: boolean;
2481
- /** The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2517
+ /** The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
2482
2518
  projectId?: string;
2483
2519
  /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
2484
2520
  tableId?: string;
@@ -2536,7 +2572,7 @@ declare namespace gapi.client {
2536
2572
  startTime?: string;
2537
2573
  }
2538
2574
  interface GoogleCloudDiscoveryengineV1Control {
2539
- /** Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. */
2575
+ /** Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */
2540
2576
  associatedServingConfigIds?: string[];
2541
2577
  /** Defines a boost-type control */
2542
2578
  boostAction?: GoogleCloudDiscoveryengineV1ControlBoostAction;
@@ -2669,6 +2705,22 @@ declare namespace gapi.client {
2669
2705
  /** The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2670
2706
  text?: string[];
2671
2707
  }
2708
+ interface GoogleCloudDiscoveryengineV1CustomTuningModel {
2709
+ /** Timestamp the Model was created at. */
2710
+ createTime?: string;
2711
+ /** The display name of the model. */
2712
+ displayName?: string;
2713
+ /** The metrics of the trained model. */
2714
+ metrics?: {[P in string]: number};
2715
+ /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
2716
+ modelState?: string;
2717
+ /** The version of the model. */
2718
+ modelVersion?: string;
2719
+ /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
2720
+ name?: string;
2721
+ /** Timestamp the model training was initiated. */
2722
+ trainingStartTime?: string;
2723
+ }
2672
2724
  interface GoogleCloudDiscoveryengineV1DataStore {
2673
2725
  /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
2674
2726
  contentConfig?: string;
@@ -2688,6 +2740,8 @@ declare namespace gapi.client {
2688
2740
  solutionTypes?: string[];
2689
2741
  /** The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */
2690
2742
  startingSchema?: GoogleCloudDiscoveryengineV1Schema;
2743
+ /** Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */
2744
+ workspaceConfig?: GoogleCloudDiscoveryengineV1WorkspaceConfig;
2691
2745
  }
2692
2746
  interface GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata {
2693
2747
  /** Operation create time. */
@@ -3077,6 +3131,10 @@ declare namespace gapi.client {
3077
3131
  /** Pagination token, if not returned indicates the last page. */
3078
3132
  nextPageToken?: string;
3079
3133
  }
3134
+ interface GoogleCloudDiscoveryengineV1ListCustomModelsResponse {
3135
+ /** List of custom tuning models. */
3136
+ models?: GoogleCloudDiscoveryengineV1CustomTuningModel[];
3137
+ }
3080
3138
  interface GoogleCloudDiscoveryengineV1ListDataStoresResponse {
3081
3139
  /** All the customer's DataStores. */
3082
3140
  dataStores?: GoogleCloudDiscoveryengineV1DataStore[];
@@ -3663,7 +3721,7 @@ declare namespace gapi.client {
3663
3721
  enableDataBoost?: boolean;
3664
3722
  /** Required. The instance ID of the source Spanner table. */
3665
3723
  instanceId?: string;
3666
- /** The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
3724
+ /** The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */
3667
3725
  projectId?: string;
3668
3726
  /** Required. The table name of the Spanner database that needs to be imported. */
3669
3727
  tableId?: string;
@@ -3710,6 +3768,44 @@ declare namespace gapi.client {
3710
3768
  /** Text input. */
3711
3769
  input?: string;
3712
3770
  }
3771
+ interface GoogleCloudDiscoveryengineV1TrainCustomModelMetadata {
3772
+ /** Operation create time. */
3773
+ createTime?: string;
3774
+ /** Operation last update time. If the operation is done, this is also the finish time. */
3775
+ updateTime?: string;
3776
+ }
3777
+ interface GoogleCloudDiscoveryengineV1TrainCustomModelRequest {
3778
+ /** The desired location of errors incurred during the data ingestion and training. */
3779
+ errorConfig?: GoogleCloudDiscoveryengineV1ImportErrorConfig;
3780
+ /** Cloud Storage training input. */
3781
+ gcsTrainingInput?: GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput;
3782
+ /** If not provided, a UUID will be generated. */
3783
+ modelId?: string;
3784
+ /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
3785
+ modelType?: string;
3786
+ }
3787
+ interface GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput {
3788
+ /** The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}` */
3789
+ corpusDataPath?: string;
3790
+ /** The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"} */
3791
+ queryDataPath?: string;
3792
+ /** Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */
3793
+ testDataPath?: string;
3794
+ /** Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */
3795
+ trainDataPath?: string;
3796
+ }
3797
+ interface GoogleCloudDiscoveryengineV1TrainCustomModelResponse {
3798
+ /** Echoes the destination for the complete errors in the request if set. */
3799
+ errorConfig?: GoogleCloudDiscoveryengineV1ImportErrorConfig;
3800
+ /** A sample of errors encountered while processing the data. */
3801
+ errorSamples?: GoogleRpcStatus[];
3802
+ /** The metrics of the trained model. */
3803
+ metrics?: {[P in string]: number};
3804
+ /** Fully qualified name of the CustomTuningModel. */
3805
+ modelName?: string;
3806
+ /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
3807
+ modelStatus?: string;
3808
+ }
3713
3809
  interface GoogleCloudDiscoveryengineV1TransactionInfo {
3714
3810
  /** All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost */
3715
3811
  cost?: number;
@@ -3784,6 +3880,12 @@ declare namespace gapi.client {
3784
3880
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
3785
3881
  userId?: string;
3786
3882
  }
3883
+ interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
3884
+ /** Obfuscated Dasher customer ID. */
3885
+ dasherCustomerId?: string;
3886
+ /** The Google Workspace data source. */
3887
+ type?: string;
3888
+ }
3787
3889
  interface GoogleLongrunningCancelOperationRequest {}
3788
3890
  interface GoogleLongrunningListOperationsResponse {
3789
3891
  /** The standard List next-page token. */
@@ -4337,6 +4439,35 @@ declare namespace gapi.client {
4337
4439
  }): Request<GoogleLongrunningListOperationsResponse>;
4338
4440
  }
4339
4441
  interface BranchesResource {
4442
+ /** Gets index freshness metadata for Documents. Supported for website search only. */
4443
+ batchGetDocumentsMetadata(request?: {
4444
+ /** V1 error format. */
4445
+ '$.xgafv'?: string;
4446
+ /** OAuth access token. */
4447
+ access_token?: string;
4448
+ /** Data format for response. */
4449
+ alt?: string;
4450
+ /** JSONP */
4451
+ callback?: string;
4452
+ /** Selector specifying which fields to include in a partial response. */
4453
+ fields?: string;
4454
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
4455
+ key?: string;
4456
+ /** The exact URIs to match by. */
4457
+ 'matcher.urisMatcher.uris'?: string | string[];
4458
+ /** OAuth 2.0 token for the current user. */
4459
+ oauth_token?: string;
4460
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
4461
+ parent: string;
4462
+ /** Returns response with indentations and line breaks. */
4463
+ prettyPrint?: boolean;
4464
+ /** 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. */
4465
+ quotaUser?: string;
4466
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4467
+ upload_protocol?: string;
4468
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4469
+ uploadType?: string;
4470
+ }): Request<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>;
4340
4471
  documents: DocumentsResource;
4341
4472
  operations: OperationsResource;
4342
4473
  }
@@ -4940,6 +5071,35 @@ declare namespace gapi.client {
4940
5071
  body: GoogleCloudDiscoveryengineV1Conversation
4941
5072
  ): Request<GoogleCloudDiscoveryengineV1Conversation>;
4942
5073
  }
5074
+ interface CustomModelsResource {
5075
+ /** Gets a list of all the custom models. */
5076
+ list(request?: {
5077
+ /** V1 error format. */
5078
+ '$.xgafv'?: string;
5079
+ /** OAuth access token. */
5080
+ access_token?: string;
5081
+ /** Data format for response. */
5082
+ alt?: string;
5083
+ /** JSONP */
5084
+ callback?: string;
5085
+ /** Required. The resource name of the parent Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. */
5086
+ dataStore: string;
5087
+ /** Selector specifying which fields to include in a partial response. */
5088
+ fields?: string;
5089
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
5090
+ key?: string;
5091
+ /** OAuth 2.0 token for the current user. */
5092
+ oauth_token?: string;
5093
+ /** Returns response with indentations and line breaks. */
5094
+ prettyPrint?: boolean;
5095
+ /** 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. */
5096
+ quotaUser?: string;
5097
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5098
+ upload_protocol?: string;
5099
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5100
+ uploadType?: string;
5101
+ }): Request<GoogleCloudDiscoveryengineV1ListCustomModelsResponse>;
5102
+ }
4943
5103
  interface OperationsResource {
4944
5104
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
4945
5105
  get(request?: {
@@ -7024,10 +7184,69 @@ declare namespace gapi.client {
7024
7184
  },
7025
7185
  body: GoogleCloudDiscoveryengineV1DataStore
7026
7186
  ): Request<GoogleCloudDiscoveryengineV1DataStore>;
7187
+ /** Trains a custom model. */
7188
+ trainCustomModel(request: {
7189
+ /** V1 error format. */
7190
+ '$.xgafv'?: string;
7191
+ /** OAuth access token. */
7192
+ access_token?: string;
7193
+ /** Data format for response. */
7194
+ alt?: string;
7195
+ /** JSONP */
7196
+ callback?: string;
7197
+ /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
7198
+ dataStore: string;
7199
+ /** Selector specifying which fields to include in a partial response. */
7200
+ fields?: string;
7201
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7202
+ key?: string;
7203
+ /** OAuth 2.0 token for the current user. */
7204
+ oauth_token?: string;
7205
+ /** Returns response with indentations and line breaks. */
7206
+ prettyPrint?: boolean;
7207
+ /** 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. */
7208
+ quotaUser?: string;
7209
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7210
+ upload_protocol?: string;
7211
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7212
+ uploadType?: string;
7213
+ /** Request body */
7214
+ resource: GoogleCloudDiscoveryengineV1TrainCustomModelRequest;
7215
+ }): Request<GoogleLongrunningOperation>;
7216
+ trainCustomModel(
7217
+ request: {
7218
+ /** V1 error format. */
7219
+ '$.xgafv'?: string;
7220
+ /** OAuth access token. */
7221
+ access_token?: string;
7222
+ /** Data format for response. */
7223
+ alt?: string;
7224
+ /** JSONP */
7225
+ callback?: string;
7226
+ /** Required. The resource name of the Data Store, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. */
7227
+ dataStore: string;
7228
+ /** Selector specifying which fields to include in a partial response. */
7229
+ fields?: string;
7230
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
7231
+ key?: string;
7232
+ /** OAuth 2.0 token for the current user. */
7233
+ oauth_token?: string;
7234
+ /** Returns response with indentations and line breaks. */
7235
+ prettyPrint?: boolean;
7236
+ /** 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. */
7237
+ quotaUser?: string;
7238
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7239
+ upload_protocol?: string;
7240
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7241
+ uploadType?: string;
7242
+ },
7243
+ body: GoogleCloudDiscoveryengineV1TrainCustomModelRequest
7244
+ ): Request<GoogleLongrunningOperation>;
7027
7245
  branches: BranchesResource;
7028
7246
  completionSuggestions: CompletionSuggestionsResource;
7029
7247
  controls: ControlsResource;
7030
7248
  conversations: ConversationsResource;
7249
+ customModels: CustomModelsResource;
7031
7250
  models: ModelsResource;
7032
7251
  operations: OperationsResource;
7033
7252
  schemas: SchemasResource;
@@ -8736,6 +8955,35 @@ declare namespace gapi.client {
8736
8955
  }): Request<GoogleLongrunningListOperationsResponse>;
8737
8956
  }
8738
8957
  interface BranchesResource {
8958
+ /** Gets index freshness metadata for Documents. Supported for website search only. */
8959
+ batchGetDocumentsMetadata(request?: {
8960
+ /** V1 error format. */
8961
+ '$.xgafv'?: string;
8962
+ /** OAuth access token. */
8963
+ access_token?: string;
8964
+ /** Data format for response. */
8965
+ alt?: string;
8966
+ /** JSONP */
8967
+ callback?: string;
8968
+ /** Selector specifying which fields to include in a partial response. */
8969
+ fields?: string;
8970
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
8971
+ key?: string;
8972
+ /** The exact URIs to match by. */
8973
+ 'matcher.urisMatcher.uris'?: string | string[];
8974
+ /** OAuth 2.0 token for the current user. */
8975
+ oauth_token?: string;
8976
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
8977
+ parent: string;
8978
+ /** Returns response with indentations and line breaks. */
8979
+ prettyPrint?: boolean;
8980
+ /** 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. */
8981
+ quotaUser?: string;
8982
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8983
+ upload_protocol?: string;
8984
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8985
+ uploadType?: string;
8986
+ }): Request<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>;
8739
8987
  documents: DocumentsResource;
8740
8988
  operations: OperationsResource;
8741
8989
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20240801",
3
+ "version": "0.0.20240813",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",