@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20240621 → 0.0.20240704
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 +190 -6
- 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: 20240704
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -207,6 +207,8 @@ declare namespace gapi.client {
|
|
|
207
207
|
document?: string;
|
|
208
208
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
209
209
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
210
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). */
|
|
211
|
+
structData?: {[P in string]: any};
|
|
210
212
|
/** Title. */
|
|
211
213
|
title?: string;
|
|
212
214
|
/** URI for the document. */
|
|
@@ -331,6 +333,8 @@ declare namespace gapi.client {
|
|
|
331
333
|
createTime?: string;
|
|
332
334
|
/** The display name of the model. */
|
|
333
335
|
displayName?: string;
|
|
336
|
+
/** The metrics of the trained model. */
|
|
337
|
+
metrics?: {[P in string]: number};
|
|
334
338
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
335
339
|
modelState?: string;
|
|
336
340
|
/** The version of the model. */
|
|
@@ -404,7 +408,7 @@ declare namespace gapi.client {
|
|
|
404
408
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
405
409
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
406
410
|
name?: string;
|
|
407
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and
|
|
411
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
408
412
|
parsingConfigOverrides?: {
|
|
409
413
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
410
414
|
};
|
|
@@ -539,6 +543,18 @@ declare namespace gapi.client {
|
|
|
539
543
|
/** Total number of documents. */
|
|
540
544
|
documentCount?: string;
|
|
541
545
|
}
|
|
546
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
|
|
547
|
+
/** Operation create time. */
|
|
548
|
+
createTime?: string;
|
|
549
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
550
|
+
updateTime?: string;
|
|
551
|
+
}
|
|
552
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
|
|
553
|
+
/** Output result indicating where the data were exported to. */
|
|
554
|
+
outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
|
|
555
|
+
/** The status of the export operation. */
|
|
556
|
+
status?: GoogleRpcStatus;
|
|
557
|
+
}
|
|
542
558
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
543
559
|
/** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
|
|
544
560
|
advancedSiteSearchDataSources?: string[];
|
|
@@ -659,6 +675,16 @@ declare namespace gapi.client {
|
|
|
659
675
|
/** List of custom tuning models. */
|
|
660
676
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
661
677
|
}
|
|
678
|
+
interface GoogleCloudDiscoveryengineV1alphaOutputResult {
|
|
679
|
+
/** The BigQuery location where the result is stored. */
|
|
680
|
+
bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
|
|
681
|
+
}
|
|
682
|
+
interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
|
|
683
|
+
/** The ID of a BigQuery Dataset. */
|
|
684
|
+
datasetId?: string;
|
|
685
|
+
/** The ID of a BigQuery Table. */
|
|
686
|
+
tableId?: string;
|
|
687
|
+
}
|
|
662
688
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
663
689
|
/** Output only. The timestamp when this project is created. */
|
|
664
690
|
createTime?: string;
|
|
@@ -1170,6 +1196,8 @@ declare namespace gapi.client {
|
|
|
1170
1196
|
document?: string;
|
|
1171
1197
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
1172
1198
|
snippetInfo?: GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
1199
|
+
/** Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). */
|
|
1200
|
+
structData?: {[P in string]: any};
|
|
1173
1201
|
/** Title. */
|
|
1174
1202
|
title?: string;
|
|
1175
1203
|
/** URI for the document. */
|
|
@@ -1539,6 +1567,8 @@ declare namespace gapi.client {
|
|
|
1539
1567
|
createTime?: string;
|
|
1540
1568
|
/** The display name of the model. */
|
|
1541
1569
|
displayName?: string;
|
|
1570
|
+
/** The metrics of the trained model. */
|
|
1571
|
+
metrics?: {[P in string]: number};
|
|
1542
1572
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
1543
1573
|
modelState?: string;
|
|
1544
1574
|
/** The version of the model. */
|
|
@@ -1649,7 +1679,7 @@ declare namespace gapi.client {
|
|
|
1649
1679
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1650
1680
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1651
1681
|
name?: string;
|
|
1652
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and
|
|
1682
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
1653
1683
|
parsingConfigOverrides?: {
|
|
1654
1684
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1655
1685
|
};
|
|
@@ -2242,6 +2272,8 @@ declare namespace gapi.client {
|
|
|
2242
2272
|
imageQuery?: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery;
|
|
2243
2273
|
/** The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */
|
|
2244
2274
|
languageCode?: string;
|
|
2275
|
+
/** If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
|
|
2276
|
+
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
2245
2277
|
/** 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. */
|
|
2246
2278
|
offset?: number;
|
|
2247
2279
|
/** 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 for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
@@ -2256,12 +2288,18 @@ declare namespace gapi.client {
|
|
|
2256
2288
|
query?: string;
|
|
2257
2289
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
2258
2290
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
2259
|
-
/** The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are
|
|
2291
|
+
/** The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
|
|
2260
2292
|
rankingExpression?: string;
|
|
2261
2293
|
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
2262
2294
|
regionCode?: string;
|
|
2263
2295
|
/** Whether to turn on safe search. This is only supported for website search. */
|
|
2264
2296
|
safeSearch?: boolean;
|
|
2297
|
+
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
2298
|
+
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
|
|
2299
|
+
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
|
|
2300
|
+
session?: string;
|
|
2301
|
+
/** Session specification. Can be used only when `session` is set. */
|
|
2302
|
+
sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
|
|
2265
2303
|
/** The spell correction specification that specifies the mode under which spell correction takes effect. */
|
|
2266
2304
|
spellCorrectionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec;
|
|
2267
2305
|
/** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
|
|
@@ -2407,12 +2445,28 @@ declare namespace gapi.client {
|
|
|
2407
2445
|
/** Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */
|
|
2408
2446
|
imageBytes?: string;
|
|
2409
2447
|
}
|
|
2448
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
2449
|
+
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
2450
|
+
filterExtractionCondition?: string;
|
|
2451
|
+
/** Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. */
|
|
2452
|
+
geoSearchQueryDetectionFieldNames?: string[];
|
|
2453
|
+
}
|
|
2410
2454
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec {
|
|
2411
2455
|
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
2412
2456
|
condition?: string;
|
|
2413
2457
|
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
2414
2458
|
pinUnexpandedResults?: boolean;
|
|
2415
2459
|
}
|
|
2460
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec {
|
|
2461
|
+
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
2462
|
+
condition?: string;
|
|
2463
|
+
}
|
|
2464
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec {
|
|
2465
|
+
/** If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */
|
|
2466
|
+
queryId?: string;
|
|
2467
|
+
/** The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */
|
|
2468
|
+
searchResultPersistenceCount?: number;
|
|
2469
|
+
}
|
|
2416
2470
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec {
|
|
2417
2471
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
2418
2472
|
mode?: string;
|
|
@@ -2429,6 +2483,8 @@ declare namespace gapi.client {
|
|
|
2429
2483
|
geoSearchDebugInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[];
|
|
2430
2484
|
/** Guided search result. */
|
|
2431
2485
|
guidedSearchResult?: GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult;
|
|
2486
|
+
/** Natural language query understanding information for the returned results. */
|
|
2487
|
+
naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo;
|
|
2432
2488
|
/** A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
2433
2489
|
nextPageToken?: string;
|
|
2434
2490
|
/** Query expansion information for the returned results. */
|
|
@@ -2437,6 +2493,8 @@ declare namespace gapi.client {
|
|
|
2437
2493
|
redirectUri?: string;
|
|
2438
2494
|
/** A list of matched documents. The order represents the ranking. */
|
|
2439
2495
|
results?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
|
|
2496
|
+
/** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
|
|
2497
|
+
sessionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo;
|
|
2440
2498
|
/** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
|
|
2441
2499
|
summary?: GoogleCloudDiscoveryengineV1betaSearchResponseSummary;
|
|
2442
2500
|
/** The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */
|
|
@@ -2476,6 +2534,60 @@ declare namespace gapi.client {
|
|
|
2476
2534
|
/** Attribute value used to refine the results. For example, `"drama"`. */
|
|
2477
2535
|
attributeValue?: string;
|
|
2478
2536
|
}
|
|
2537
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo {
|
|
2538
|
+
/** The filters that were extracted from the input query. */
|
|
2539
|
+
extractedFilters?: string;
|
|
2540
|
+
/** Rewritten input query minus the extracted filters. */
|
|
2541
|
+
rewrittenQuery?: string;
|
|
2542
|
+
/** The filters that were extracted from the input query represented in a structured form. */
|
|
2543
|
+
structuredExtractedFilter?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
|
|
2544
|
+
}
|
|
2545
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
|
|
2546
|
+
/** The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. */
|
|
2547
|
+
expression?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
|
|
2548
|
+
}
|
|
2549
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression {
|
|
2550
|
+
/** The expressions that were ANDed together. */
|
|
2551
|
+
expressions?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
|
|
2552
|
+
}
|
|
2553
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression {
|
|
2554
|
+
/** Logical "And" compound operator connecting multiple expressions. */
|
|
2555
|
+
andExpr?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression;
|
|
2556
|
+
/** Geolocation constraint expression. */
|
|
2557
|
+
geolocationConstraint?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint;
|
|
2558
|
+
/** Numerical constraint expression. */
|
|
2559
|
+
numberConstraint?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint;
|
|
2560
|
+
/** Logical "Or" compound operator connecting multiple expressions. */
|
|
2561
|
+
orExpr?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression;
|
|
2562
|
+
/** String constraint expression. */
|
|
2563
|
+
stringConstraint?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint;
|
|
2564
|
+
}
|
|
2565
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint {
|
|
2566
|
+
/** The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. */
|
|
2567
|
+
address?: string;
|
|
2568
|
+
/** The name of the geolocation field as defined in the schema. */
|
|
2569
|
+
fieldName?: string;
|
|
2570
|
+
/** The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. */
|
|
2571
|
+
radiusInMeters?: number;
|
|
2572
|
+
}
|
|
2573
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint {
|
|
2574
|
+
/** The comparison operation performed between the field value and the value specified in the constraint. */
|
|
2575
|
+
comparison?: string;
|
|
2576
|
+
/** Name of the numerical field as defined in the schema. */
|
|
2577
|
+
fieldName?: string;
|
|
2578
|
+
/** The value specified in the numerical constraint. */
|
|
2579
|
+
value?: number;
|
|
2580
|
+
}
|
|
2581
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression {
|
|
2582
|
+
/** The expressions that were ORed together. */
|
|
2583
|
+
expressions?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
|
|
2584
|
+
}
|
|
2585
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint {
|
|
2586
|
+
/** Name of the string field as defined in the schema. */
|
|
2587
|
+
fieldName?: string;
|
|
2588
|
+
/** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
|
|
2589
|
+
values?: string[];
|
|
2590
|
+
}
|
|
2479
2591
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo {
|
|
2480
2592
|
/** Bool describing whether query expansion has occurred. */
|
|
2481
2593
|
expandedQuery?: boolean;
|
|
@@ -2492,6 +2604,12 @@ declare namespace gapi.client {
|
|
|
2492
2604
|
/** Google provided available scores. */
|
|
2493
2605
|
modelScores?: {[P in string]: GoogleCloudDiscoveryengineV1betaDoubleList};
|
|
2494
2606
|
}
|
|
2607
|
+
interface GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo {
|
|
2608
|
+
/** Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */
|
|
2609
|
+
name?: string;
|
|
2610
|
+
/** Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. */
|
|
2611
|
+
queryId?: string;
|
|
2612
|
+
}
|
|
2495
2613
|
interface GoogleCloudDiscoveryengineV1betaSearchResponseSummary {
|
|
2496
2614
|
/** A collection of Safety Attribute categories and their associated confidence scores. */
|
|
2497
2615
|
safetyAttributes?: GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes;
|
|
@@ -2575,7 +2693,7 @@ declare namespace gapi.client {
|
|
|
2575
2693
|
name?: string;
|
|
2576
2694
|
/** Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
2577
2695
|
onewaySynonymsControlIds?: string[];
|
|
2578
|
-
/** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score
|
|
2696
|
+
/** The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */
|
|
2579
2697
|
rankingExpression?: string;
|
|
2580
2698
|
/** IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
2581
2699
|
redirectControlIds?: string[];
|
|
@@ -2950,7 +3068,7 @@ declare namespace gapi.client {
|
|
|
2950
3068
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2951
3069
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2952
3070
|
name?: string;
|
|
2953
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and
|
|
3071
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
2954
3072
|
parsingConfigOverrides?: {
|
|
2955
3073
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2956
3074
|
};
|
|
@@ -11109,6 +11227,38 @@ declare namespace gapi.client {
|
|
|
11109
11227
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
11110
11228
|
userEvents: UserEventsResource;
|
|
11111
11229
|
}
|
|
11230
|
+
interface OperationsResource {
|
|
11231
|
+
/** 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. */
|
|
11232
|
+
get(request?: {
|
|
11233
|
+
/** V1 error format. */
|
|
11234
|
+
'$.xgafv'?: string;
|
|
11235
|
+
/** OAuth access token. */
|
|
11236
|
+
access_token?: string;
|
|
11237
|
+
/** Data format for response. */
|
|
11238
|
+
alt?: string;
|
|
11239
|
+
/** JSONP */
|
|
11240
|
+
callback?: string;
|
|
11241
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11242
|
+
fields?: string;
|
|
11243
|
+
/** 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. */
|
|
11244
|
+
key?: string;
|
|
11245
|
+
/** The name of the operation resource. */
|
|
11246
|
+
name: string;
|
|
11247
|
+
/** OAuth 2.0 token for the current user. */
|
|
11248
|
+
oauth_token?: string;
|
|
11249
|
+
/** Returns response with indentations and line breaks. */
|
|
11250
|
+
prettyPrint?: boolean;
|
|
11251
|
+
/** 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. */
|
|
11252
|
+
quotaUser?: string;
|
|
11253
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11254
|
+
upload_protocol?: string;
|
|
11255
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11256
|
+
uploadType?: string;
|
|
11257
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11258
|
+
}
|
|
11259
|
+
interface EvaluationsResource {
|
|
11260
|
+
operations: OperationsResource;
|
|
11261
|
+
}
|
|
11112
11262
|
interface GroundingConfigsResource {
|
|
11113
11263
|
/** Performs a grounding check. */
|
|
11114
11264
|
check(request: {
|
|
@@ -11291,6 +11441,38 @@ declare namespace gapi.client {
|
|
|
11291
11441
|
body: GoogleCloudDiscoveryengineV1betaRankRequest
|
|
11292
11442
|
): Request<GoogleCloudDiscoveryengineV1betaRankResponse>;
|
|
11293
11443
|
}
|
|
11444
|
+
interface OperationsResource {
|
|
11445
|
+
/** 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. */
|
|
11446
|
+
get(request?: {
|
|
11447
|
+
/** V1 error format. */
|
|
11448
|
+
'$.xgafv'?: string;
|
|
11449
|
+
/** OAuth access token. */
|
|
11450
|
+
access_token?: string;
|
|
11451
|
+
/** Data format for response. */
|
|
11452
|
+
alt?: string;
|
|
11453
|
+
/** JSONP */
|
|
11454
|
+
callback?: string;
|
|
11455
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
11456
|
+
fields?: string;
|
|
11457
|
+
/** 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. */
|
|
11458
|
+
key?: string;
|
|
11459
|
+
/** The name of the operation resource. */
|
|
11460
|
+
name: string;
|
|
11461
|
+
/** OAuth 2.0 token for the current user. */
|
|
11462
|
+
oauth_token?: string;
|
|
11463
|
+
/** Returns response with indentations and line breaks. */
|
|
11464
|
+
prettyPrint?: boolean;
|
|
11465
|
+
/** 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. */
|
|
11466
|
+
quotaUser?: string;
|
|
11467
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
11468
|
+
upload_protocol?: string;
|
|
11469
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
11470
|
+
uploadType?: string;
|
|
11471
|
+
}): Request<GoogleLongrunningOperation>;
|
|
11472
|
+
}
|
|
11473
|
+
interface SampleQuerySetsResource {
|
|
11474
|
+
operations: OperationsResource;
|
|
11475
|
+
}
|
|
11294
11476
|
interface UserEventsResource {
|
|
11295
11477
|
/** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
|
|
11296
11478
|
collect(request?: {
|
|
@@ -11391,9 +11573,11 @@ declare namespace gapi.client {
|
|
|
11391
11573
|
interface LocationsResource {
|
|
11392
11574
|
collections: CollectionsResource;
|
|
11393
11575
|
dataStores: DataStoresResource;
|
|
11576
|
+
evaluations: EvaluationsResource;
|
|
11394
11577
|
groundingConfigs: GroundingConfigsResource;
|
|
11395
11578
|
operations: OperationsResource;
|
|
11396
11579
|
rankingConfigs: RankingConfigsResource;
|
|
11580
|
+
sampleQuerySets: SampleQuerySetsResource;
|
|
11397
11581
|
userEvents: UserEventsResource;
|
|
11398
11582
|
}
|
|
11399
11583
|
interface OperationsResource {
|