@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240715 → 0.0.20240729
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 +180 -22
- 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:
|
|
12
|
+
// Revision: 20240729
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -151,6 +151,8 @@ declare namespace gapi.client {
|
|
|
151
151
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
152
152
|
/** Chunk information. */
|
|
153
153
|
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
154
|
+
/** Structured document information. */
|
|
155
|
+
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
|
|
154
156
|
/** Unstructured document information. */
|
|
155
157
|
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
156
158
|
}
|
|
@@ -161,7 +163,7 @@ declare namespace gapi.client {
|
|
|
161
163
|
content?: string;
|
|
162
164
|
/** Document metadata. */
|
|
163
165
|
documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
164
|
-
/**
|
|
166
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
165
167
|
relevanceScore?: number;
|
|
166
168
|
}
|
|
167
169
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
@@ -176,6 +178,12 @@ declare namespace gapi.client {
|
|
|
176
178
|
/** URI for the document. */
|
|
177
179
|
uri?: string;
|
|
178
180
|
}
|
|
181
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
|
|
182
|
+
/** Document resource name. */
|
|
183
|
+
document?: string;
|
|
184
|
+
/** Structured search data. */
|
|
185
|
+
structData?: {[P in string]: any};
|
|
186
|
+
}
|
|
179
187
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
180
188
|
/** List of cited chunk contents derived from document content. */
|
|
181
189
|
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
@@ -193,6 +201,8 @@ declare namespace gapi.client {
|
|
|
193
201
|
content?: string;
|
|
194
202
|
/** Page identifier. */
|
|
195
203
|
pageIdentifier?: string;
|
|
204
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
205
|
+
relevanceScore?: number;
|
|
196
206
|
}
|
|
197
207
|
interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
198
208
|
/** Actions. */
|
|
@@ -233,7 +243,7 @@ declare namespace gapi.client {
|
|
|
233
243
|
chunk?: string;
|
|
234
244
|
/** Chunk textual content. */
|
|
235
245
|
content?: string;
|
|
236
|
-
/**
|
|
246
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
237
247
|
relevanceScore?: number;
|
|
238
248
|
}
|
|
239
249
|
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
@@ -573,7 +583,7 @@ declare namespace gapi.client {
|
|
|
573
583
|
errorSamples?: GoogleRpcStatus[];
|
|
574
584
|
/** Required. The specification of the evaluation. */
|
|
575
585
|
evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
|
|
576
|
-
/**
|
|
586
|
+
/** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
577
587
|
name?: string;
|
|
578
588
|
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
579
589
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
@@ -597,8 +607,6 @@ declare namespace gapi.client {
|
|
|
597
607
|
updateTime?: string;
|
|
598
608
|
}
|
|
599
609
|
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
|
|
600
|
-
/** Output result indicating where the data were exported to. */
|
|
601
|
-
outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
|
|
602
610
|
/** The status of the export operation. */
|
|
603
611
|
status?: GoogleRpcStatus;
|
|
604
612
|
}
|
|
@@ -754,16 +762,6 @@ declare namespace gapi.client {
|
|
|
754
762
|
/** List of custom tuning models. */
|
|
755
763
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
756
764
|
}
|
|
757
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResult {
|
|
758
|
-
/** The BigQuery location where the result is stored. */
|
|
759
|
-
bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
|
|
760
|
-
}
|
|
761
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
|
|
762
|
-
/** The ID of a BigQuery Dataset. */
|
|
763
|
-
datasetId?: string;
|
|
764
|
-
/** The ID of a BigQuery Table. */
|
|
765
|
-
tableId?: string;
|
|
766
|
-
}
|
|
767
765
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
768
766
|
/** Output only. The timestamp when this project is created. */
|
|
769
767
|
createTime?: string;
|
|
@@ -944,7 +942,7 @@ declare namespace gapi.client {
|
|
|
944
942
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
945
943
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
946
944
|
offset?: number;
|
|
947
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
945
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
948
946
|
orderBy?: string;
|
|
949
947
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
950
948
|
pageSize?: number;
|
|
@@ -1050,6 +1048,8 @@ declare namespace gapi.client {
|
|
|
1050
1048
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
1051
1049
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
1052
1050
|
ignoreAdversarialQuery?: boolean;
|
|
1051
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
1052
|
+
ignoreLowRelevantContent?: boolean;
|
|
1053
1053
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
1054
1054
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
1055
1055
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -1442,6 +1442,8 @@ declare namespace gapi.client {
|
|
|
1442
1442
|
interface GoogleCloudDiscoveryengineV1AnswerReference {
|
|
1443
1443
|
/** Chunk information. */
|
|
1444
1444
|
chunkInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo;
|
|
1445
|
+
/** Structured document information. */
|
|
1446
|
+
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo;
|
|
1445
1447
|
/** Unstructured document information. */
|
|
1446
1448
|
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo;
|
|
1447
1449
|
}
|
|
@@ -1452,7 +1454,7 @@ declare namespace gapi.client {
|
|
|
1452
1454
|
content?: string;
|
|
1453
1455
|
/** Document metadata. */
|
|
1454
1456
|
documentMetadata?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata;
|
|
1455
|
-
/**
|
|
1457
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1456
1458
|
relevanceScore?: number;
|
|
1457
1459
|
}
|
|
1458
1460
|
interface GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata {
|
|
@@ -1467,6 +1469,12 @@ declare namespace gapi.client {
|
|
|
1467
1469
|
/** URI for the document. */
|
|
1468
1470
|
uri?: string;
|
|
1469
1471
|
}
|
|
1472
|
+
interface GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo {
|
|
1473
|
+
/** Document resource name. */
|
|
1474
|
+
document?: string;
|
|
1475
|
+
/** Structured search data. */
|
|
1476
|
+
structData?: {[P in string]: any};
|
|
1477
|
+
}
|
|
1470
1478
|
interface GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo {
|
|
1471
1479
|
/** List of cited chunk contents derived from document content. */
|
|
1472
1480
|
chunkContents?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
@@ -1484,6 +1492,8 @@ declare namespace gapi.client {
|
|
|
1484
1492
|
content?: string;
|
|
1485
1493
|
/** Page identifier. */
|
|
1486
1494
|
pageIdentifier?: string;
|
|
1495
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1496
|
+
relevanceScore?: number;
|
|
1487
1497
|
}
|
|
1488
1498
|
interface GoogleCloudDiscoveryengineV1AnswerStep {
|
|
1489
1499
|
/** Actions. */
|
|
@@ -1524,7 +1534,7 @@ declare namespace gapi.client {
|
|
|
1524
1534
|
chunk?: string;
|
|
1525
1535
|
/** Chunk textual content. */
|
|
1526
1536
|
content?: string;
|
|
1527
|
-
/**
|
|
1537
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1528
1538
|
relevanceScore?: number;
|
|
1529
1539
|
}
|
|
1530
1540
|
interface GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo {
|
|
@@ -1828,7 +1838,7 @@ declare namespace gapi.client {
|
|
|
1828
1838
|
errorSamples?: GoogleRpcStatus[];
|
|
1829
1839
|
/** Required. The specification of the evaluation. */
|
|
1830
1840
|
evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
|
|
1831
|
-
/**
|
|
1841
|
+
/** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1832
1842
|
name?: string;
|
|
1833
1843
|
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
1834
1844
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
@@ -2069,7 +2079,7 @@ declare namespace gapi.client {
|
|
|
2069
2079
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
2070
2080
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
2071
2081
|
offset?: number;
|
|
2072
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
2082
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
2073
2083
|
orderBy?: string;
|
|
2074
2084
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
2075
2085
|
pageSize?: number;
|
|
@@ -2173,6 +2183,8 @@ declare namespace gapi.client {
|
|
|
2173
2183
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
2174
2184
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
2175
2185
|
ignoreAdversarialQuery?: boolean;
|
|
2186
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
2187
|
+
ignoreLowRelevantContent?: boolean;
|
|
2176
2188
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
2177
2189
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
2178
2190
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -3192,10 +3204,20 @@ declare namespace gapi.client {
|
|
|
3192
3204
|
updateTime?: string;
|
|
3193
3205
|
}
|
|
3194
3206
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsRequest {
|
|
3207
|
+
/** The desired location of errors incurred during the purge. */
|
|
3208
|
+
errorConfig?: GoogleCloudDiscoveryengineV1PurgeErrorConfig;
|
|
3195
3209
|
/** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
|
|
3196
3210
|
filter?: string;
|
|
3197
3211
|
/** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
|
|
3198
3212
|
force?: boolean;
|
|
3213
|
+
/** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
|
|
3214
|
+
gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
|
|
3215
|
+
/** Inline source for the input content for purge. */
|
|
3216
|
+
inlineSource?: GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource;
|
|
3217
|
+
}
|
|
3218
|
+
interface GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource {
|
|
3219
|
+
/** Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items. */
|
|
3220
|
+
documents?: string[];
|
|
3199
3221
|
}
|
|
3200
3222
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
|
|
3201
3223
|
/** The total count of documents purged as a result of the operation. */
|
|
@@ -3203,6 +3225,10 @@ declare namespace gapi.client {
|
|
|
3203
3225
|
/** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
|
|
3204
3226
|
purgeSample?: string[];
|
|
3205
3227
|
}
|
|
3228
|
+
interface GoogleCloudDiscoveryengineV1PurgeErrorConfig {
|
|
3229
|
+
/** Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
|
|
3230
|
+
gcsPrefix?: string;
|
|
3231
|
+
}
|
|
3206
3232
|
interface GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
3207
3233
|
/** Operation create time. */
|
|
3208
3234
|
createTime?: string;
|
|
@@ -3216,6 +3242,12 @@ declare namespace gapi.client {
|
|
|
3216
3242
|
/** Number of suggestion deny list entries purged. */
|
|
3217
3243
|
purgeCount?: string;
|
|
3218
3244
|
}
|
|
3245
|
+
interface GoogleCloudDiscoveryengineV1PurgeUserEventsRequest {
|
|
3246
|
+
/** Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. */
|
|
3247
|
+
filter?: string;
|
|
3248
|
+
/** The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. */
|
|
3249
|
+
force?: boolean;
|
|
3250
|
+
}
|
|
3219
3251
|
interface GoogleCloudDiscoveryengineV1Query {
|
|
3220
3252
|
/** Unique Id for the query. */
|
|
3221
3253
|
queryId?: string;
|
|
@@ -3327,7 +3359,7 @@ declare namespace gapi.client {
|
|
|
3327
3359
|
languageCode?: string;
|
|
3328
3360
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
3329
3361
|
offset?: number;
|
|
3330
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
3362
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
3331
3363
|
orderBy?: string;
|
|
3332
3364
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
3333
3365
|
pageSize?: number;
|
|
@@ -3407,6 +3439,8 @@ declare namespace gapi.client {
|
|
|
3407
3439
|
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec {
|
|
3408
3440
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
3409
3441
|
ignoreAdversarialQuery?: boolean;
|
|
3442
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
3443
|
+
ignoreLowRelevantContent?: boolean;
|
|
3410
3444
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
3411
3445
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
3412
3446
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -6593,6 +6627,64 @@ declare namespace gapi.client {
|
|
|
6593
6627
|
},
|
|
6594
6628
|
body: GoogleCloudDiscoveryengineV1ImportUserEventsRequest
|
|
6595
6629
|
): Request<GoogleLongrunningOperation>;
|
|
6630
|
+
/** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
|
|
6631
|
+
purge(request: {
|
|
6632
|
+
/** V1 error format. */
|
|
6633
|
+
'$.xgafv'?: string;
|
|
6634
|
+
/** OAuth access token. */
|
|
6635
|
+
access_token?: string;
|
|
6636
|
+
/** Data format for response. */
|
|
6637
|
+
alt?: string;
|
|
6638
|
+
/** JSONP */
|
|
6639
|
+
callback?: string;
|
|
6640
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6641
|
+
fields?: string;
|
|
6642
|
+
/** 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. */
|
|
6643
|
+
key?: string;
|
|
6644
|
+
/** OAuth 2.0 token for the current user. */
|
|
6645
|
+
oauth_token?: string;
|
|
6646
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
6647
|
+
parent: string;
|
|
6648
|
+
/** Returns response with indentations and line breaks. */
|
|
6649
|
+
prettyPrint?: boolean;
|
|
6650
|
+
/** 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. */
|
|
6651
|
+
quotaUser?: string;
|
|
6652
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6653
|
+
upload_protocol?: string;
|
|
6654
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6655
|
+
uploadType?: string;
|
|
6656
|
+
/** Request body */
|
|
6657
|
+
resource: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
6658
|
+
}): Request<GoogleLongrunningOperation>;
|
|
6659
|
+
purge(
|
|
6660
|
+
request: {
|
|
6661
|
+
/** V1 error format. */
|
|
6662
|
+
'$.xgafv'?: string;
|
|
6663
|
+
/** OAuth access token. */
|
|
6664
|
+
access_token?: string;
|
|
6665
|
+
/** Data format for response. */
|
|
6666
|
+
alt?: string;
|
|
6667
|
+
/** JSONP */
|
|
6668
|
+
callback?: string;
|
|
6669
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6670
|
+
fields?: string;
|
|
6671
|
+
/** 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. */
|
|
6672
|
+
key?: string;
|
|
6673
|
+
/** OAuth 2.0 token for the current user. */
|
|
6674
|
+
oauth_token?: string;
|
|
6675
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
6676
|
+
parent: string;
|
|
6677
|
+
/** Returns response with indentations and line breaks. */
|
|
6678
|
+
prettyPrint?: boolean;
|
|
6679
|
+
/** 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. */
|
|
6680
|
+
quotaUser?: string;
|
|
6681
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6682
|
+
upload_protocol?: string;
|
|
6683
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6684
|
+
uploadType?: string;
|
|
6685
|
+
},
|
|
6686
|
+
body: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
|
6687
|
+
): Request<GoogleLongrunningOperation>;
|
|
6596
6688
|
/** Writes a single user event. */
|
|
6597
6689
|
write(request: {
|
|
6598
6690
|
/** V1 error format. */
|
|
@@ -6718,6 +6810,8 @@ declare namespace gapi.client {
|
|
|
6718
6810
|
prettyPrint?: boolean;
|
|
6719
6811
|
/** 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. */
|
|
6720
6812
|
quotaUser?: string;
|
|
6813
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
6814
|
+
skipDefaultSchemaCreation?: boolean;
|
|
6721
6815
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6722
6816
|
upload_protocol?: string;
|
|
6723
6817
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6751,6 +6845,8 @@ declare namespace gapi.client {
|
|
|
6751
6845
|
prettyPrint?: boolean;
|
|
6752
6846
|
/** 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. */
|
|
6753
6847
|
quotaUser?: string;
|
|
6848
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
6849
|
+
skipDefaultSchemaCreation?: boolean;
|
|
6754
6850
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6755
6851
|
upload_protocol?: string;
|
|
6756
6852
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -10652,6 +10748,64 @@ declare namespace gapi.client {
|
|
|
10652
10748
|
},
|
|
10653
10749
|
body: GoogleCloudDiscoveryengineV1ImportUserEventsRequest
|
|
10654
10750
|
): Request<GoogleLongrunningOperation>;
|
|
10751
|
+
/** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
|
|
10752
|
+
purge(request: {
|
|
10753
|
+
/** V1 error format. */
|
|
10754
|
+
'$.xgafv'?: string;
|
|
10755
|
+
/** OAuth access token. */
|
|
10756
|
+
access_token?: string;
|
|
10757
|
+
/** Data format for response. */
|
|
10758
|
+
alt?: string;
|
|
10759
|
+
/** JSONP */
|
|
10760
|
+
callback?: string;
|
|
10761
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10762
|
+
fields?: string;
|
|
10763
|
+
/** 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. */
|
|
10764
|
+
key?: string;
|
|
10765
|
+
/** OAuth 2.0 token for the current user. */
|
|
10766
|
+
oauth_token?: string;
|
|
10767
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
10768
|
+
parent: string;
|
|
10769
|
+
/** Returns response with indentations and line breaks. */
|
|
10770
|
+
prettyPrint?: boolean;
|
|
10771
|
+
/** 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. */
|
|
10772
|
+
quotaUser?: string;
|
|
10773
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10774
|
+
upload_protocol?: string;
|
|
10775
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10776
|
+
uploadType?: string;
|
|
10777
|
+
/** Request body */
|
|
10778
|
+
resource: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
10779
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10780
|
+
purge(
|
|
10781
|
+
request: {
|
|
10782
|
+
/** V1 error format. */
|
|
10783
|
+
'$.xgafv'?: string;
|
|
10784
|
+
/** OAuth access token. */
|
|
10785
|
+
access_token?: string;
|
|
10786
|
+
/** Data format for response. */
|
|
10787
|
+
alt?: string;
|
|
10788
|
+
/** JSONP */
|
|
10789
|
+
callback?: string;
|
|
10790
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10791
|
+
fields?: string;
|
|
10792
|
+
/** 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. */
|
|
10793
|
+
key?: string;
|
|
10794
|
+
/** OAuth 2.0 token for the current user. */
|
|
10795
|
+
oauth_token?: string;
|
|
10796
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
10797
|
+
parent: string;
|
|
10798
|
+
/** Returns response with indentations and line breaks. */
|
|
10799
|
+
prettyPrint?: boolean;
|
|
10800
|
+
/** 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. */
|
|
10801
|
+
quotaUser?: string;
|
|
10802
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10803
|
+
upload_protocol?: string;
|
|
10804
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10805
|
+
uploadType?: string;
|
|
10806
|
+
},
|
|
10807
|
+
body: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
|
10808
|
+
): Request<GoogleLongrunningOperation>;
|
|
10655
10809
|
/** Writes a single user event. */
|
|
10656
10810
|
write(request: {
|
|
10657
10811
|
/** V1 error format. */
|
|
@@ -10777,6 +10931,8 @@ declare namespace gapi.client {
|
|
|
10777
10931
|
prettyPrint?: boolean;
|
|
10778
10932
|
/** 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. */
|
|
10779
10933
|
quotaUser?: string;
|
|
10934
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
10935
|
+
skipDefaultSchemaCreation?: boolean;
|
|
10780
10936
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10781
10937
|
upload_protocol?: string;
|
|
10782
10938
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -10810,6 +10966,8 @@ declare namespace gapi.client {
|
|
|
10810
10966
|
prettyPrint?: boolean;
|
|
10811
10967
|
/** 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. */
|
|
10812
10968
|
quotaUser?: string;
|
|
10969
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
10970
|
+
skipDefaultSchemaCreation?: boolean;
|
|
10813
10971
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10814
10972
|
upload_protocol?: string;
|
|
10815
10973
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|