@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240318 → 0.0.20240329

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 +395 -3
  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=v1beta
12
- // Revision: 20240318
12
+ // Revision: 20240329
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -339,6 +339,10 @@ declare namespace gapi.client {
339
339
  /** If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error. */
340
340
  searchableOption?: string;
341
341
  }
342
+ interface GoogleCloudDiscoveryengineV1alphaGroundingConfig {
343
+ /** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
344
+ name?: string;
345
+ }
342
346
  interface GoogleCloudDiscoveryengineV1alphaIdpConfig {
343
347
  /** External Identity provider config. */
344
348
  externalIdpConfig?: GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig;
@@ -349,6 +353,20 @@ declare namespace gapi.client {
349
353
  /** Workforce pool name. Example: "locations/global/workforcePools/pool_id" */
350
354
  workforcePoolName?: string;
351
355
  }
356
+ interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata {
357
+ /** Operation create time. */
358
+ createTime?: string;
359
+ /** Operation last update time. If the operation is done, this is also the finish time. */
360
+ updateTime?: string;
361
+ }
362
+ interface GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse {
363
+ /** A sample of errors encountered while processing the request. */
364
+ errorSamples?: GoogleRpcStatus[];
365
+ /** Count of CompletionSuggestions that failed to be imported. */
366
+ failureCount?: string;
367
+ /** Count of CompletionSuggestions successfully imported. */
368
+ successCount?: string;
369
+ }
352
370
  interface GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata {
353
371
  /** Operation create time. */
354
372
  createTime?: string;
@@ -536,6 +554,8 @@ declare namespace gapi.client {
536
554
  errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
537
555
  /** A sample of errors encountered while processing the data. */
538
556
  errorSamples?: GoogleRpcStatus[];
557
+ /** The metrics of the trained model. */
558
+ metrics?: {[P in string]: number};
539
559
  /** 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 is in progress. * **ready**: The model is ready for serving. */
540
560
  modelStatus?: string;
541
561
  }
@@ -595,6 +615,58 @@ declare namespace gapi.client {
595
615
  /** Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */
596
616
  tableId?: string;
597
617
  }
618
+ interface GoogleCloudDiscoveryengineV1betaBigtableOptions {
619
+ /** The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */
620
+ families?: {
621
+ [P in string]: GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily;
622
+ };
623
+ /** The field name used for saving row key value in the UCS document. The name has to match a-zA-Z0-9* */
624
+ keyFieldName?: string;
625
+ }
626
+ interface GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn {
627
+ /** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
628
+ encoding?: string;
629
+ /** The field name to use for this column in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with best effort. However, field name collisions could happen, where parsing behavior is undefined. */
630
+ fieldName?: string;
631
+ /** Required. Qualifier of the column. If cannot decode with utf-8, store a base-64 encoded string. */
632
+ qualifier?: string;
633
+ /** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
634
+ type?: string;
635
+ }
636
+ interface GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily {
637
+ /** The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. */
638
+ columns?: GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[];
639
+ /** Optional. The encoding mode of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it. */
640
+ encoding?: string;
641
+ /** The field name to use for this column family in the UCS document. The name has to match a-zA-Z0-9* If not set, we will parse it from the family name with best effort. However, due to difference naming pattern, there could be field name collisions, where parsing behavior is undefined. */
642
+ fieldName?: string;
643
+ /** Optional. The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY. */
644
+ type?: string;
645
+ }
646
+ interface GoogleCloudDiscoveryengineV1betaBigtableSource {
647
+ /** Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */
648
+ bigtableOptions?: GoogleCloudDiscoveryengineV1betaBigtableOptions;
649
+ /** Required. The instance ID of the Cloud Bigtable that needs to be exported. */
650
+ instanceId?: string;
651
+ /** The project ID (can be project # or 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. */
652
+ projectId?: string;
653
+ /** Required. The table ID of the Cloud Bigtable that needs to be exported. */
654
+ tableId?: string;
655
+ }
656
+ interface GoogleCloudDiscoveryengineV1betaCloudSqlSource {
657
+ /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
658
+ databaseId?: string;
659
+ /** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Please ensure that the Cloud SQL service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
660
+ gcsStagingDir?: string;
661
+ /** Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */
662
+ instanceId?: string;
663
+ /** Optional. Option for serverless export. Enabling this option will incur additional cost. More info: https://cloud.google.com/sql/pricing#serverless */
664
+ offload?: boolean;
665
+ /** Optional. The project ID (can be project # or 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. */
666
+ projectId?: string;
667
+ /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
668
+ tableId?: string;
669
+ }
598
670
  interface GoogleCloudDiscoveryengineV1betaCompleteQueryResponse {
599
671
  /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
600
672
  querySuggestions?: GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion[];
@@ -898,12 +970,32 @@ declare namespace gapi.client {
898
970
  /** The total number of items matching the request. This will always be populated in the response. */
899
971
  totalSize?: number;
900
972
  }
973
+ interface GoogleCloudDiscoveryengineV1betaFhirStoreSource {
974
+ /** Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`. */
975
+ fhirStore?: string;
976
+ /** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */
977
+ gcsStagingDir?: string;
978
+ }
979
+ interface GoogleCloudDiscoveryengineV1betaFirestoreSource {
980
+ /** Required. The Firestore collection to copy the data from with a length limit of 1500 characters. */
981
+ collectionId?: string;
982
+ /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
983
+ databaseId?: string;
984
+ /** Optional. Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Please ensure that the Firestore service account has the necessary GCS Storage Admin permissions to access the specified GCS directory. */
985
+ gcsStagingDir?: string;
986
+ /** Optional. The project ID (can be project # or 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. */
987
+ projectId?: string;
988
+ }
901
989
  interface GoogleCloudDiscoveryengineV1betaGcsSource {
902
990
  /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by Gen App Builder. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
903
991
  dataSchema?: string;
904
992
  /** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
905
993
  inputUris?: string[];
906
994
  }
995
+ interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
996
+ /** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
997
+ name?: string;
998
+ }
907
999
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
908
1000
  /** Operation create time. */
909
1001
  createTime?: string;
@@ -915,20 +1007,30 @@ declare namespace gapi.client {
915
1007
  updateTime?: string;
916
1008
  }
917
1009
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequest {
918
- /** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. */
1010
+ /** Whether to automatically generate IDs for the documents if absent. If set to `true`, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to `false`, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
919
1011
  autoGenerateIds?: boolean;
920
1012
  /** BigQuery input source. */
921
1013
  bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
1014
+ /** Cloud Bigtable input source. */
1015
+ bigtableSource?: GoogleCloudDiscoveryengineV1betaBigtableSource;
1016
+ /** Cloud SQL input source. */
1017
+ cloudSqlSource?: GoogleCloudDiscoveryengineV1betaCloudSqlSource;
922
1018
  /** The desired location of errors incurred during the Import. */
923
1019
  errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
1020
+ /** FhirStore input source. */
1021
+ fhirStoreSource?: GoogleCloudDiscoveryengineV1betaFhirStoreSource;
1022
+ /** Firestore input source. */
1023
+ firestoreSource?: GoogleCloudDiscoveryengineV1betaFirestoreSource;
924
1024
  /** Cloud Storage location for the input content. */
925
1025
  gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
926
- /** The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For BigQuerySource it is the column name of the BigQuery table where the unique ids are stored. The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is `custom`. And only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. */
1026
+ /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource */
927
1027
  idField?: string;
928
1028
  /** The Inline source for the input content for documents. */
929
1029
  inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
930
1030
  /** The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */
931
1031
  reconciliationMode?: string;
1032
+ /** Spanner input source. */
1033
+ spannerSource?: GoogleCloudDiscoveryengineV1betaSpannerSource;
932
1034
  }
933
1035
  interface GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource {
934
1036
  /** Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */
@@ -1082,6 +1184,7 @@ declare namespace gapi.client {
1082
1184
  /** The total number of panels, including this one, shown to the user. Must be set if panel_position is set. */
1083
1185
  totalPanels?: number;
1084
1186
  }
1187
+ interface GoogleCloudDiscoveryengineV1betaPauseEngineRequest {}
1085
1188
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
1086
1189
  /** Operation create time. */
1087
1190
  createTime?: string;
@@ -1119,6 +1222,32 @@ declare namespace gapi.client {
1119
1222
  /** Number of suggestion deny list entries purged. */
1120
1223
  purgeCount?: string;
1121
1224
  }
1225
+ interface GoogleCloudDiscoveryengineV1betaRankingRecord {
1226
+ /** The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
1227
+ content?: string;
1228
+ /** The unique ID to represent the record. */
1229
+ id?: string;
1230
+ /** The score of this record based on the given query and selected model. */
1231
+ score?: number;
1232
+ /** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
1233
+ title?: string;
1234
+ }
1235
+ interface GoogleCloudDiscoveryengineV1betaRankRequest {
1236
+ /** If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */
1237
+ ignoreRecordDetailsInResponse?: boolean;
1238
+ /** The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */
1239
+ model?: string;
1240
+ /** The query to use. */
1241
+ query?: string;
1242
+ /** Required. A list of records to rank. */
1243
+ records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1244
+ /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
1245
+ topN?: number;
1246
+ }
1247
+ interface GoogleCloudDiscoveryengineV1betaRankResponse {
1248
+ /** A list of records sorted by descending score. */
1249
+ records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
1250
+ }
1122
1251
  interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
1123
1252
  /** Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. */
1124
1253
  filter?: string;
@@ -1173,6 +1302,7 @@ declare namespace gapi.client {
1173
1302
  /** URI link reference. */
1174
1303
  uri?: string;
1175
1304
  }
1305
+ interface GoogleCloudDiscoveryengineV1betaResumeEngineRequest {}
1176
1306
  interface GoogleCloudDiscoveryengineV1betaSchema {
1177
1307
  /** The JSON representation of the schema. */
1178
1308
  jsonSchema?: string;
@@ -1453,6 +1583,8 @@ declare namespace gapi.client {
1453
1583
  referenceIndex?: string;
1454
1584
  }
1455
1585
  interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
1586
+ /** List of cited chunk contents derived from document content. */
1587
+ chunkContents?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[];
1456
1588
  /** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*‍/locations/*‍/collections/*‍/dataStores/*‍/branches/*‍/documents/*`. */
1457
1589
  document?: string;
1458
1590
  /** Title of the document. */
@@ -1460,6 +1592,12 @@ declare namespace gapi.client {
1460
1592
  /** Cloud Storage or HTTP uri for the document. */
1461
1593
  uri?: string;
1462
1594
  }
1595
+ interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent {
1596
+ /** Chunk textual content. */
1597
+ content?: string;
1598
+ /** Page identifier. */
1599
+ pageIdentifier?: string;
1600
+ }
1463
1601
  interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
1464
1602
  /** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
1465
1603
  categories?: string[];
@@ -1538,6 +1676,18 @@ declare namespace gapi.client {
1538
1676
  /** Latest site verification time. */
1539
1677
  verifyTime?: string;
1540
1678
  }
1679
+ interface GoogleCloudDiscoveryengineV1betaSpannerSource {
1680
+ /** Required. The database ID of the source Spanner table. */
1681
+ databaseId?: string;
1682
+ /** Optional. Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info: https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas */
1683
+ enableDataBoost?: boolean;
1684
+ /** Required. The instance ID of the source Spanner table. */
1685
+ instanceId?: string;
1686
+ /** 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. */
1687
+ projectId?: string;
1688
+ /** Required. The table name of the Spanner database that needs to be imported. */
1689
+ tableId?: string;
1690
+ }
1541
1691
  interface GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry {
1542
1692
  /** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
1543
1693
  blockPhrase?: string;
@@ -1607,6 +1757,8 @@ declare namespace gapi.client {
1607
1757
  errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
1608
1758
  /** A sample of errors encountered while processing the data. */
1609
1759
  errorSamples?: GoogleRpcStatus[];
1760
+ /** The metrics of the trained model. */
1761
+ metrics?: {[P in string]: number};
1610
1762
  /** 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 is in progress. * **ready**: The model is ready for serving. */
1611
1763
  modelStatus?: string;
1612
1764
  }
@@ -1624,6 +1776,11 @@ declare namespace gapi.client {
1624
1776
  /** Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. */
1625
1777
  value?: number;
1626
1778
  }
1779
+ interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
1780
+ /** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
1781
+ engine?: string;
1782
+ }
1783
+ interface GoogleCloudDiscoveryengineV1betaTuneEngineRequest {}
1627
1784
  interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
1628
1785
  /** Operation create time. */
1629
1786
  createTime?: string;
@@ -5429,6 +5586,180 @@ declare namespace gapi.client {
5429
5586
  },
5430
5587
  body: GoogleCloudDiscoveryengineV1betaEngine
5431
5588
  ): Request<GoogleCloudDiscoveryengineV1betaEngine>;
5589
+ /** Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
5590
+ pause(request: {
5591
+ /** V1 error format. */
5592
+ '$.xgafv'?: string;
5593
+ /** OAuth access token. */
5594
+ access_token?: string;
5595
+ /** Data format for response. */
5596
+ alt?: string;
5597
+ /** JSONP */
5598
+ callback?: string;
5599
+ /** Selector specifying which fields to include in a partial response. */
5600
+ fields?: string;
5601
+ /** 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. */
5602
+ key?: string;
5603
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5604
+ name: string;
5605
+ /** OAuth 2.0 token for the current user. */
5606
+ oauth_token?: string;
5607
+ /** Returns response with indentations and line breaks. */
5608
+ prettyPrint?: boolean;
5609
+ /** 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. */
5610
+ quotaUser?: string;
5611
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5612
+ upload_protocol?: string;
5613
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5614
+ uploadType?: string;
5615
+ /** Request body */
5616
+ resource: GoogleCloudDiscoveryengineV1betaPauseEngineRequest;
5617
+ }): Request<GoogleCloudDiscoveryengineV1betaEngine>;
5618
+ pause(
5619
+ request: {
5620
+ /** V1 error format. */
5621
+ '$.xgafv'?: string;
5622
+ /** OAuth access token. */
5623
+ access_token?: string;
5624
+ /** Data format for response. */
5625
+ alt?: string;
5626
+ /** JSONP */
5627
+ callback?: string;
5628
+ /** Selector specifying which fields to include in a partial response. */
5629
+ fields?: string;
5630
+ /** 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. */
5631
+ key?: string;
5632
+ /** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5633
+ name: string;
5634
+ /** OAuth 2.0 token for the current user. */
5635
+ oauth_token?: string;
5636
+ /** Returns response with indentations and line breaks. */
5637
+ prettyPrint?: boolean;
5638
+ /** 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. */
5639
+ quotaUser?: string;
5640
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5641
+ upload_protocol?: string;
5642
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5643
+ uploadType?: string;
5644
+ },
5645
+ body: GoogleCloudDiscoveryengineV1betaPauseEngineRequest
5646
+ ): Request<GoogleCloudDiscoveryengineV1betaEngine>;
5647
+ /** Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
5648
+ resume(request: {
5649
+ /** V1 error format. */
5650
+ '$.xgafv'?: string;
5651
+ /** OAuth access token. */
5652
+ access_token?: string;
5653
+ /** Data format for response. */
5654
+ alt?: string;
5655
+ /** JSONP */
5656
+ callback?: string;
5657
+ /** Selector specifying which fields to include in a partial response. */
5658
+ fields?: string;
5659
+ /** 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. */
5660
+ key?: string;
5661
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5662
+ name: string;
5663
+ /** OAuth 2.0 token for the current user. */
5664
+ oauth_token?: string;
5665
+ /** Returns response with indentations and line breaks. */
5666
+ prettyPrint?: boolean;
5667
+ /** 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. */
5668
+ quotaUser?: string;
5669
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5670
+ upload_protocol?: string;
5671
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5672
+ uploadType?: string;
5673
+ /** Request body */
5674
+ resource: GoogleCloudDiscoveryengineV1betaResumeEngineRequest;
5675
+ }): Request<GoogleCloudDiscoveryengineV1betaEngine>;
5676
+ resume(
5677
+ request: {
5678
+ /** V1 error format. */
5679
+ '$.xgafv'?: string;
5680
+ /** OAuth access token. */
5681
+ access_token?: string;
5682
+ /** Data format for response. */
5683
+ alt?: string;
5684
+ /** JSONP */
5685
+ callback?: string;
5686
+ /** Selector specifying which fields to include in a partial response. */
5687
+ fields?: string;
5688
+ /** 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. */
5689
+ key?: string;
5690
+ /** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5691
+ name: string;
5692
+ /** OAuth 2.0 token for the current user. */
5693
+ oauth_token?: string;
5694
+ /** Returns response with indentations and line breaks. */
5695
+ prettyPrint?: boolean;
5696
+ /** 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. */
5697
+ quotaUser?: string;
5698
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5699
+ upload_protocol?: string;
5700
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5701
+ uploadType?: string;
5702
+ },
5703
+ body: GoogleCloudDiscoveryengineV1betaResumeEngineRequest
5704
+ ): Request<GoogleCloudDiscoveryengineV1betaEngine>;
5705
+ /** Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
5706
+ tune(request: {
5707
+ /** V1 error format. */
5708
+ '$.xgafv'?: string;
5709
+ /** OAuth access token. */
5710
+ access_token?: string;
5711
+ /** Data format for response. */
5712
+ alt?: string;
5713
+ /** JSONP */
5714
+ callback?: string;
5715
+ /** Selector specifying which fields to include in a partial response. */
5716
+ fields?: string;
5717
+ /** 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. */
5718
+ key?: string;
5719
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5720
+ name: string;
5721
+ /** OAuth 2.0 token for the current user. */
5722
+ oauth_token?: string;
5723
+ /** Returns response with indentations and line breaks. */
5724
+ prettyPrint?: boolean;
5725
+ /** 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. */
5726
+ quotaUser?: string;
5727
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5728
+ upload_protocol?: string;
5729
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5730
+ uploadType?: string;
5731
+ /** Request body */
5732
+ resource: GoogleCloudDiscoveryengineV1betaTuneEngineRequest;
5733
+ }): Request<GoogleLongrunningOperation>;
5734
+ tune(
5735
+ request: {
5736
+ /** V1 error format. */
5737
+ '$.xgafv'?: string;
5738
+ /** OAuth access token. */
5739
+ access_token?: string;
5740
+ /** Data format for response. */
5741
+ alt?: string;
5742
+ /** JSONP */
5743
+ callback?: string;
5744
+ /** Selector specifying which fields to include in a partial response. */
5745
+ fields?: string;
5746
+ /** 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. */
5747
+ key?: string;
5748
+ /** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
5749
+ name: string;
5750
+ /** OAuth 2.0 token for the current user. */
5751
+ oauth_token?: string;
5752
+ /** Returns response with indentations and line breaks. */
5753
+ prettyPrint?: boolean;
5754
+ /** 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. */
5755
+ quotaUser?: string;
5756
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
5757
+ upload_protocol?: string;
5758
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5759
+ uploadType?: string;
5760
+ },
5761
+ body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest
5762
+ ): Request<GoogleLongrunningOperation>;
5432
5763
  conversations: ConversationsResource;
5433
5764
  operations: OperationsResource;
5434
5765
  servingConfigs: ServingConfigsResource;
@@ -7796,10 +8127,71 @@ declare namespace gapi.client {
7796
8127
  uploadType?: string;
7797
8128
  }): Request<GoogleLongrunningListOperationsResponse>;
7798
8129
  }
8130
+ interface RankingConfigsResource {
8131
+ /** Ranks a list of text records based on the given input query. */
8132
+ rank(request: {
8133
+ /** V1 error format. */
8134
+ '$.xgafv'?: string;
8135
+ /** OAuth access token. */
8136
+ access_token?: string;
8137
+ /** Data format for response. */
8138
+ alt?: string;
8139
+ /** JSONP */
8140
+ callback?: string;
8141
+ /** Selector specifying which fields to include in a partial response. */
8142
+ fields?: string;
8143
+ /** 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. */
8144
+ key?: string;
8145
+ /** OAuth 2.0 token for the current user. */
8146
+ oauth_token?: string;
8147
+ /** Returns response with indentations and line breaks. */
8148
+ prettyPrint?: boolean;
8149
+ /** 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. */
8150
+ quotaUser?: string;
8151
+ /** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
8152
+ rankingConfig: string;
8153
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8154
+ upload_protocol?: string;
8155
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8156
+ uploadType?: string;
8157
+ /** Request body */
8158
+ resource: GoogleCloudDiscoveryengineV1betaRankRequest;
8159
+ }): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
8160
+ rank(
8161
+ request: {
8162
+ /** V1 error format. */
8163
+ '$.xgafv'?: string;
8164
+ /** OAuth access token. */
8165
+ access_token?: string;
8166
+ /** Data format for response. */
8167
+ alt?: string;
8168
+ /** JSONP */
8169
+ callback?: string;
8170
+ /** Selector specifying which fields to include in a partial response. */
8171
+ fields?: string;
8172
+ /** 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. */
8173
+ key?: string;
8174
+ /** OAuth 2.0 token for the current user. */
8175
+ oauth_token?: string;
8176
+ /** Returns response with indentations and line breaks. */
8177
+ prettyPrint?: boolean;
8178
+ /** 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. */
8179
+ quotaUser?: string;
8180
+ /** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
8181
+ rankingConfig: string;
8182
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8183
+ upload_protocol?: string;
8184
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8185
+ uploadType?: string;
8186
+ },
8187
+ body: GoogleCloudDiscoveryengineV1betaRankRequest
8188
+ ): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
8189
+ }
7799
8190
  interface LocationsResource {
7800
8191
  collections: CollectionsResource;
7801
8192
  dataStores: DataStoresResource;
7802
8193
  operations: OperationsResource;
8194
+ rankingConfigs: RankingConfigsResource;
7803
8195
  }
7804
8196
  interface OperationsResource {
7805
8197
  /** 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. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20240318",
3
+ "version": "0.0.20240329",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",