@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240312 → 0.0.20240323
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.
- package/index.d.ts +316 -4
- 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:
|
|
12
|
+
// Revision: 20240323
|
|
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
|
}
|
|
@@ -898,12 +918,22 @@ declare namespace gapi.client {
|
|
|
898
918
|
/** The total number of items matching the request. This will always be populated in the response. */
|
|
899
919
|
totalSize?: number;
|
|
900
920
|
}
|
|
921
|
+
interface GoogleCloudDiscoveryengineV1betaFhirStoreSource {
|
|
922
|
+
/** 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}`. */
|
|
923
|
+
fhirStore?: string;
|
|
924
|
+
/** 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. */
|
|
925
|
+
gcsStagingDir?: string;
|
|
926
|
+
}
|
|
901
927
|
interface GoogleCloudDiscoveryengineV1betaGcsSource {
|
|
902
928
|
/** 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
929
|
dataSchema?: string;
|
|
904
930
|
/** 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
931
|
inputUris?: string[];
|
|
906
932
|
}
|
|
933
|
+
interface GoogleCloudDiscoveryengineV1betaGroundingConfig {
|
|
934
|
+
/** Required. Name of the GroundingConfig, of the form `projects/{project}/locations/{location}/groundingConfig`. */
|
|
935
|
+
name?: string;
|
|
936
|
+
}
|
|
907
937
|
interface GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata {
|
|
908
938
|
/** Operation create time. */
|
|
909
939
|
createTime?: string;
|
|
@@ -915,15 +945,17 @@ declare namespace gapi.client {
|
|
|
915
945
|
updateTime?: string;
|
|
916
946
|
}
|
|
917
947
|
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.
|
|
948
|
+
/** 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
949
|
autoGenerateIds?: boolean;
|
|
920
950
|
/** BigQuery input source. */
|
|
921
951
|
bigquerySource?: GoogleCloudDiscoveryengineV1betaBigQuerySource;
|
|
922
952
|
/** The desired location of errors incurred during the Import. */
|
|
923
953
|
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
954
|
+
/** FhirStore input source. */
|
|
955
|
+
fhirStoreSource?: GoogleCloudDiscoveryengineV1betaFhirStoreSource;
|
|
924
956
|
/** Cloud Storage location for the input content. */
|
|
925
957
|
gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
926
|
-
/** The field
|
|
958
|
+
/** 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
959
|
idField?: string;
|
|
928
960
|
/** The Inline source for the input content for documents. */
|
|
929
961
|
inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
|
|
@@ -1082,6 +1114,7 @@ declare namespace gapi.client {
|
|
|
1082
1114
|
/** The total number of panels, including this one, shown to the user. Must be set if panel_position is set. */
|
|
1083
1115
|
totalPanels?: number;
|
|
1084
1116
|
}
|
|
1117
|
+
interface GoogleCloudDiscoveryengineV1betaPauseEngineRequest {}
|
|
1085
1118
|
interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
|
|
1086
1119
|
/** Operation create time. */
|
|
1087
1120
|
createTime?: string;
|
|
@@ -1119,6 +1152,32 @@ declare namespace gapi.client {
|
|
|
1119
1152
|
/** Number of suggestion deny list entries purged. */
|
|
1120
1153
|
purgeCount?: string;
|
|
1121
1154
|
}
|
|
1155
|
+
interface GoogleCloudDiscoveryengineV1betaRankingRecord {
|
|
1156
|
+
/** 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. */
|
|
1157
|
+
content?: string;
|
|
1158
|
+
/** The unique ID to represent the record. */
|
|
1159
|
+
id?: string;
|
|
1160
|
+
/** The score of this record based on the given query and selected model. */
|
|
1161
|
+
score?: number;
|
|
1162
|
+
/** 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. */
|
|
1163
|
+
title?: string;
|
|
1164
|
+
}
|
|
1165
|
+
interface GoogleCloudDiscoveryengineV1betaRankRequest {
|
|
1166
|
+
/** If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */
|
|
1167
|
+
ignoreRecordDetailsInResponse?: boolean;
|
|
1168
|
+
/** 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. */
|
|
1169
|
+
model?: string;
|
|
1170
|
+
/** The query to use. */
|
|
1171
|
+
query?: string;
|
|
1172
|
+
/** Required. A list of records to rank. */
|
|
1173
|
+
records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
1174
|
+
/** The number of results to return. If this is unset or no bigger than zero, returns all results. */
|
|
1175
|
+
topN?: number;
|
|
1176
|
+
}
|
|
1177
|
+
interface GoogleCloudDiscoveryengineV1betaRankResponse {
|
|
1178
|
+
/** A list of records sorted by descending score. */
|
|
1179
|
+
records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
|
|
1180
|
+
}
|
|
1122
1181
|
interface GoogleCloudDiscoveryengineV1betaRecommendRequest {
|
|
1123
1182
|
/** 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
1183
|
filter?: string;
|
|
@@ -1173,6 +1232,7 @@ declare namespace gapi.client {
|
|
|
1173
1232
|
/** URI link reference. */
|
|
1174
1233
|
uri?: string;
|
|
1175
1234
|
}
|
|
1235
|
+
interface GoogleCloudDiscoveryengineV1betaResumeEngineRequest {}
|
|
1176
1236
|
interface GoogleCloudDiscoveryengineV1betaSchema {
|
|
1177
1237
|
/** The JSON representation of the schema. */
|
|
1178
1238
|
jsonSchema?: string;
|
|
@@ -1240,7 +1300,7 @@ declare namespace gapi.client {
|
|
|
1240
1300
|
conditionBoostSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[];
|
|
1241
1301
|
}
|
|
1242
1302
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec {
|
|
1243
|
-
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
1303
|
+
/** Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */
|
|
1244
1304
|
boost?: number;
|
|
1245
1305
|
/** An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */
|
|
1246
1306
|
condition?: string;
|
|
@@ -1288,6 +1348,8 @@ declare namespace gapi.client {
|
|
|
1288
1348
|
modelSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
1289
1349
|
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results can be used to generate a summary. */
|
|
1290
1350
|
summaryResultCount?: number;
|
|
1351
|
+
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Please note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
|
|
1352
|
+
useSemanticChunks?: boolean;
|
|
1291
1353
|
}
|
|
1292
1354
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
1293
1355
|
/** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
|
|
@@ -1451,6 +1513,8 @@ declare namespace gapi.client {
|
|
|
1451
1513
|
referenceIndex?: string;
|
|
1452
1514
|
}
|
|
1453
1515
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference {
|
|
1516
|
+
/** List of cited chunk contents derived from document content. */
|
|
1517
|
+
chunkContents?: GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[];
|
|
1454
1518
|
/** Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. */
|
|
1455
1519
|
document?: string;
|
|
1456
1520
|
/** Title of the document. */
|
|
@@ -1458,6 +1522,12 @@ declare namespace gapi.client {
|
|
|
1458
1522
|
/** Cloud Storage or HTTP uri for the document. */
|
|
1459
1523
|
uri?: string;
|
|
1460
1524
|
}
|
|
1525
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent {
|
|
1526
|
+
/** Chunk textual content. */
|
|
1527
|
+
content?: string;
|
|
1528
|
+
/** Page identifier. */
|
|
1529
|
+
pageIdentifier?: string;
|
|
1530
|
+
}
|
|
1461
1531
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes {
|
|
1462
1532
|
/** The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. */
|
|
1463
1533
|
categories?: string[];
|
|
@@ -1605,6 +1675,8 @@ declare namespace gapi.client {
|
|
|
1605
1675
|
errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
|
|
1606
1676
|
/** A sample of errors encountered while processing the data. */
|
|
1607
1677
|
errorSamples?: GoogleRpcStatus[];
|
|
1678
|
+
/** The metrics of the trained model. */
|
|
1679
|
+
metrics?: {[P in string]: number};
|
|
1608
1680
|
/** 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. */
|
|
1609
1681
|
modelStatus?: string;
|
|
1610
1682
|
}
|
|
@@ -1622,6 +1694,11 @@ declare namespace gapi.client {
|
|
|
1622
1694
|
/** 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. */
|
|
1623
1695
|
value?: number;
|
|
1624
1696
|
}
|
|
1697
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineMetadata {
|
|
1698
|
+
/** 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}` */
|
|
1699
|
+
engine?: string;
|
|
1700
|
+
}
|
|
1701
|
+
interface GoogleCloudDiscoveryengineV1betaTuneEngineRequest {}
|
|
1625
1702
|
interface GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata {
|
|
1626
1703
|
/** Operation create time. */
|
|
1627
1704
|
createTime?: string;
|
|
@@ -5427,6 +5504,180 @@ declare namespace gapi.client {
|
|
|
5427
5504
|
},
|
|
5428
5505
|
body: GoogleCloudDiscoveryengineV1betaEngine
|
|
5429
5506
|
): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5507
|
+
/** Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
5508
|
+
pause(request: {
|
|
5509
|
+
/** V1 error format. */
|
|
5510
|
+
'$.xgafv'?: string;
|
|
5511
|
+
/** OAuth access token. */
|
|
5512
|
+
access_token?: string;
|
|
5513
|
+
/** Data format for response. */
|
|
5514
|
+
alt?: string;
|
|
5515
|
+
/** JSONP */
|
|
5516
|
+
callback?: string;
|
|
5517
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5518
|
+
fields?: string;
|
|
5519
|
+
/** 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. */
|
|
5520
|
+
key?: string;
|
|
5521
|
+
/** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5522
|
+
name: string;
|
|
5523
|
+
/** OAuth 2.0 token for the current user. */
|
|
5524
|
+
oauth_token?: string;
|
|
5525
|
+
/** Returns response with indentations and line breaks. */
|
|
5526
|
+
prettyPrint?: boolean;
|
|
5527
|
+
/** 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. */
|
|
5528
|
+
quotaUser?: string;
|
|
5529
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5530
|
+
upload_protocol?: string;
|
|
5531
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5532
|
+
uploadType?: string;
|
|
5533
|
+
/** Request body */
|
|
5534
|
+
resource: GoogleCloudDiscoveryengineV1betaPauseEngineRequest;
|
|
5535
|
+
}): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5536
|
+
pause(
|
|
5537
|
+
request: {
|
|
5538
|
+
/** V1 error format. */
|
|
5539
|
+
'$.xgafv'?: string;
|
|
5540
|
+
/** OAuth access token. */
|
|
5541
|
+
access_token?: string;
|
|
5542
|
+
/** Data format for response. */
|
|
5543
|
+
alt?: string;
|
|
5544
|
+
/** JSONP */
|
|
5545
|
+
callback?: string;
|
|
5546
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5547
|
+
fields?: string;
|
|
5548
|
+
/** 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. */
|
|
5549
|
+
key?: string;
|
|
5550
|
+
/** Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5551
|
+
name: string;
|
|
5552
|
+
/** OAuth 2.0 token for the current user. */
|
|
5553
|
+
oauth_token?: string;
|
|
5554
|
+
/** Returns response with indentations and line breaks. */
|
|
5555
|
+
prettyPrint?: boolean;
|
|
5556
|
+
/** 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. */
|
|
5557
|
+
quotaUser?: string;
|
|
5558
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5559
|
+
upload_protocol?: string;
|
|
5560
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5561
|
+
uploadType?: string;
|
|
5562
|
+
},
|
|
5563
|
+
body: GoogleCloudDiscoveryengineV1betaPauseEngineRequest
|
|
5564
|
+
): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5565
|
+
/** Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
5566
|
+
resume(request: {
|
|
5567
|
+
/** V1 error format. */
|
|
5568
|
+
'$.xgafv'?: string;
|
|
5569
|
+
/** OAuth access token. */
|
|
5570
|
+
access_token?: string;
|
|
5571
|
+
/** Data format for response. */
|
|
5572
|
+
alt?: string;
|
|
5573
|
+
/** JSONP */
|
|
5574
|
+
callback?: string;
|
|
5575
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5576
|
+
fields?: string;
|
|
5577
|
+
/** 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. */
|
|
5578
|
+
key?: string;
|
|
5579
|
+
/** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5580
|
+
name: string;
|
|
5581
|
+
/** OAuth 2.0 token for the current user. */
|
|
5582
|
+
oauth_token?: string;
|
|
5583
|
+
/** Returns response with indentations and line breaks. */
|
|
5584
|
+
prettyPrint?: boolean;
|
|
5585
|
+
/** 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. */
|
|
5586
|
+
quotaUser?: string;
|
|
5587
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5588
|
+
upload_protocol?: string;
|
|
5589
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5590
|
+
uploadType?: string;
|
|
5591
|
+
/** Request body */
|
|
5592
|
+
resource: GoogleCloudDiscoveryengineV1betaResumeEngineRequest;
|
|
5593
|
+
}): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5594
|
+
resume(
|
|
5595
|
+
request: {
|
|
5596
|
+
/** V1 error format. */
|
|
5597
|
+
'$.xgafv'?: string;
|
|
5598
|
+
/** OAuth access token. */
|
|
5599
|
+
access_token?: string;
|
|
5600
|
+
/** Data format for response. */
|
|
5601
|
+
alt?: string;
|
|
5602
|
+
/** JSONP */
|
|
5603
|
+
callback?: string;
|
|
5604
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5605
|
+
fields?: string;
|
|
5606
|
+
/** 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. */
|
|
5607
|
+
key?: string;
|
|
5608
|
+
/** Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5609
|
+
name: string;
|
|
5610
|
+
/** OAuth 2.0 token for the current user. */
|
|
5611
|
+
oauth_token?: string;
|
|
5612
|
+
/** Returns response with indentations and line breaks. */
|
|
5613
|
+
prettyPrint?: boolean;
|
|
5614
|
+
/** 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. */
|
|
5615
|
+
quotaUser?: string;
|
|
5616
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5617
|
+
upload_protocol?: string;
|
|
5618
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5619
|
+
uploadType?: string;
|
|
5620
|
+
},
|
|
5621
|
+
body: GoogleCloudDiscoveryengineV1betaResumeEngineRequest
|
|
5622
|
+
): Request<GoogleCloudDiscoveryengineV1betaEngine>;
|
|
5623
|
+
/** Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
5624
|
+
tune(request: {
|
|
5625
|
+
/** V1 error format. */
|
|
5626
|
+
'$.xgafv'?: string;
|
|
5627
|
+
/** OAuth access token. */
|
|
5628
|
+
access_token?: string;
|
|
5629
|
+
/** Data format for response. */
|
|
5630
|
+
alt?: string;
|
|
5631
|
+
/** JSONP */
|
|
5632
|
+
callback?: string;
|
|
5633
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5634
|
+
fields?: string;
|
|
5635
|
+
/** 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. */
|
|
5636
|
+
key?: string;
|
|
5637
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5638
|
+
name: string;
|
|
5639
|
+
/** OAuth 2.0 token for the current user. */
|
|
5640
|
+
oauth_token?: string;
|
|
5641
|
+
/** Returns response with indentations and line breaks. */
|
|
5642
|
+
prettyPrint?: boolean;
|
|
5643
|
+
/** 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. */
|
|
5644
|
+
quotaUser?: string;
|
|
5645
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5646
|
+
upload_protocol?: string;
|
|
5647
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5648
|
+
uploadType?: string;
|
|
5649
|
+
/** Request body */
|
|
5650
|
+
resource: GoogleCloudDiscoveryengineV1betaTuneEngineRequest;
|
|
5651
|
+
}): Request<GoogleLongrunningOperation>;
|
|
5652
|
+
tune(
|
|
5653
|
+
request: {
|
|
5654
|
+
/** V1 error format. */
|
|
5655
|
+
'$.xgafv'?: string;
|
|
5656
|
+
/** OAuth access token. */
|
|
5657
|
+
access_token?: string;
|
|
5658
|
+
/** Data format for response. */
|
|
5659
|
+
alt?: string;
|
|
5660
|
+
/** JSONP */
|
|
5661
|
+
callback?: string;
|
|
5662
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
5663
|
+
fields?: string;
|
|
5664
|
+
/** 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. */
|
|
5665
|
+
key?: string;
|
|
5666
|
+
/** Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
|
|
5667
|
+
name: string;
|
|
5668
|
+
/** OAuth 2.0 token for the current user. */
|
|
5669
|
+
oauth_token?: string;
|
|
5670
|
+
/** Returns response with indentations and line breaks. */
|
|
5671
|
+
prettyPrint?: boolean;
|
|
5672
|
+
/** 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. */
|
|
5673
|
+
quotaUser?: string;
|
|
5674
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
5675
|
+
upload_protocol?: string;
|
|
5676
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5677
|
+
uploadType?: string;
|
|
5678
|
+
},
|
|
5679
|
+
body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest
|
|
5680
|
+
): Request<GoogleLongrunningOperation>;
|
|
5430
5681
|
conversations: ConversationsResource;
|
|
5431
5682
|
operations: OperationsResource;
|
|
5432
5683
|
servingConfigs: ServingConfigsResource;
|
|
@@ -7794,10 +8045,71 @@ declare namespace gapi.client {
|
|
|
7794
8045
|
uploadType?: string;
|
|
7795
8046
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
7796
8047
|
}
|
|
8048
|
+
interface RankingConfigsResource {
|
|
8049
|
+
/** Ranks a list of text records based on the given input query. */
|
|
8050
|
+
rank(request: {
|
|
8051
|
+
/** V1 error format. */
|
|
8052
|
+
'$.xgafv'?: string;
|
|
8053
|
+
/** OAuth access token. */
|
|
8054
|
+
access_token?: string;
|
|
8055
|
+
/** Data format for response. */
|
|
8056
|
+
alt?: string;
|
|
8057
|
+
/** JSONP */
|
|
8058
|
+
callback?: string;
|
|
8059
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8060
|
+
fields?: string;
|
|
8061
|
+
/** 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. */
|
|
8062
|
+
key?: string;
|
|
8063
|
+
/** OAuth 2.0 token for the current user. */
|
|
8064
|
+
oauth_token?: string;
|
|
8065
|
+
/** Returns response with indentations and line breaks. */
|
|
8066
|
+
prettyPrint?: boolean;
|
|
8067
|
+
/** 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. */
|
|
8068
|
+
quotaUser?: string;
|
|
8069
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
8070
|
+
rankingConfig: string;
|
|
8071
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8072
|
+
upload_protocol?: string;
|
|
8073
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8074
|
+
uploadType?: string;
|
|
8075
|
+
/** Request body */
|
|
8076
|
+
resource: GoogleCloudDiscoveryengineV1betaRankRequest;
|
|
8077
|
+
}): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
8078
|
+
rank(
|
|
8079
|
+
request: {
|
|
8080
|
+
/** V1 error format. */
|
|
8081
|
+
'$.xgafv'?: string;
|
|
8082
|
+
/** OAuth access token. */
|
|
8083
|
+
access_token?: string;
|
|
8084
|
+
/** Data format for response. */
|
|
8085
|
+
alt?: string;
|
|
8086
|
+
/** JSONP */
|
|
8087
|
+
callback?: string;
|
|
8088
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8089
|
+
fields?: string;
|
|
8090
|
+
/** 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. */
|
|
8091
|
+
key?: string;
|
|
8092
|
+
/** OAuth 2.0 token for the current user. */
|
|
8093
|
+
oauth_token?: string;
|
|
8094
|
+
/** Returns response with indentations and line breaks. */
|
|
8095
|
+
prettyPrint?: boolean;
|
|
8096
|
+
/** 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. */
|
|
8097
|
+
quotaUser?: string;
|
|
8098
|
+
/** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
|
|
8099
|
+
rankingConfig: string;
|
|
8100
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8101
|
+
upload_protocol?: string;
|
|
8102
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8103
|
+
uploadType?: string;
|
|
8104
|
+
},
|
|
8105
|
+
body: GoogleCloudDiscoveryengineV1betaRankRequest
|
|
8106
|
+
): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
8107
|
+
}
|
|
7797
8108
|
interface LocationsResource {
|
|
7798
8109
|
collections: CollectionsResource;
|
|
7799
8110
|
dataStores: DataStoresResource;
|
|
7800
8111
|
operations: OperationsResource;
|
|
8112
|
+
rankingConfigs: RankingConfigsResource;
|
|
7801
8113
|
}
|
|
7802
8114
|
interface OperationsResource {
|
|
7803
8115
|
/** 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. */
|