@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 +119 -9
- 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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240704
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -433,6 +433,8 @@ declare namespace gapi.client {
|
|
|
433
433
|
document?: string;
|
|
434
434
|
/** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
|
|
435
435
|
snippetInfo?: GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[];
|
|
436
|
+
/** 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). */
|
|
437
|
+
structData?: {[P in string]: any};
|
|
436
438
|
/** Title. */
|
|
437
439
|
title?: string;
|
|
438
440
|
/** URI for the document. */
|
|
@@ -560,7 +562,7 @@ declare namespace gapi.client {
|
|
|
560
562
|
interface GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest {
|
|
561
563
|
/** The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning` */
|
|
562
564
|
requirementType?: string;
|
|
563
|
-
/** The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `
|
|
565
|
+
/** The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` */
|
|
564
566
|
resources?: GoogleApiMonitoredResource[];
|
|
565
567
|
}
|
|
566
568
|
interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse {
|
|
@@ -836,6 +838,8 @@ declare namespace gapi.client {
|
|
|
836
838
|
createTime?: string;
|
|
837
839
|
/** The display name of the model. */
|
|
838
840
|
displayName?: string;
|
|
841
|
+
/** The metrics of the trained model. */
|
|
842
|
+
metrics?: {[P in string]: number};
|
|
839
843
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
840
844
|
modelState?: string;
|
|
841
845
|
/** The version of the model. */
|
|
@@ -960,7 +964,7 @@ declare namespace gapi.client {
|
|
|
960
964
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
961
965
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
962
966
|
name?: string;
|
|
963
|
-
/** 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
|
|
967
|
+
/** 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. */
|
|
964
968
|
parsingConfigOverrides?: {
|
|
965
969
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
966
970
|
};
|
|
@@ -1128,6 +1132,18 @@ declare namespace gapi.client {
|
|
|
1128
1132
|
/** Total number of documents. */
|
|
1129
1133
|
documentCount?: string;
|
|
1130
1134
|
}
|
|
1135
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
|
|
1136
|
+
/** Operation create time. */
|
|
1137
|
+
createTime?: string;
|
|
1138
|
+
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1139
|
+
updateTime?: string;
|
|
1140
|
+
}
|
|
1141
|
+
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
|
|
1142
|
+
/** Output result indicating where the data were exported to. */
|
|
1143
|
+
outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
|
|
1144
|
+
/** The status of the export operation. */
|
|
1145
|
+
status?: GoogleRpcStatus;
|
|
1146
|
+
}
|
|
1131
1147
|
interface GoogleCloudDiscoveryengineV1alphaFactChunk {
|
|
1132
1148
|
/** Text content of the fact chunk. Can be at most 10K characters long. */
|
|
1133
1149
|
chunkText?: string;
|
|
@@ -1452,6 +1468,16 @@ declare namespace gapi.client {
|
|
|
1452
1468
|
/** Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */
|
|
1453
1469
|
mediaProgressPercentage?: number;
|
|
1454
1470
|
}
|
|
1471
|
+
interface GoogleCloudDiscoveryengineV1alphaOutputResult {
|
|
1472
|
+
/** The BigQuery location where the result is stored. */
|
|
1473
|
+
bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
|
|
1474
|
+
}
|
|
1475
|
+
interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
|
|
1476
|
+
/** The ID of a BigQuery Dataset. */
|
|
1477
|
+
datasetId?: string;
|
|
1478
|
+
/** The ID of a BigQuery Table. */
|
|
1479
|
+
tableId?: string;
|
|
1480
|
+
}
|
|
1455
1481
|
interface GoogleCloudDiscoveryengineV1alphaPageInfo {
|
|
1456
1482
|
/** The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned. */
|
|
1457
1483
|
pageCategory?: string;
|
|
@@ -1798,7 +1824,7 @@ declare namespace gapi.client {
|
|
|
1798
1824
|
canonicalFilter?: string;
|
|
1799
1825
|
/** A specification for configuring the behavior of content search. */
|
|
1800
1826
|
contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
|
|
1801
|
-
/** Custom fine tuning configs. */
|
|
1827
|
+
/** Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */
|
|
1802
1828
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
1803
1829
|
/** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
|
|
1804
1830
|
dataStoreSpecs?: GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[];
|
|
@@ -1812,6 +1838,8 @@ declare namespace gapi.client {
|
|
|
1812
1838
|
imageQuery?: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery;
|
|
1813
1839
|
/** 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. */
|
|
1814
1840
|
languageCode?: string;
|
|
1841
|
+
/** If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */
|
|
1842
|
+
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
1815
1843
|
/** 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. */
|
|
1816
1844
|
offset?: number;
|
|
1817
1845
|
/** 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. */
|
|
@@ -1826,7 +1854,7 @@ declare namespace gapi.client {
|
|
|
1826
1854
|
query?: string;
|
|
1827
1855
|
/** The query expansion specification that specifies the conditions under which query expansion occurs. */
|
|
1828
1856
|
queryExpansionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
1829
|
-
/** 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
|
|
1857
|
+
/** 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)`. */
|
|
1830
1858
|
rankingExpression?: string;
|
|
1831
1859
|
/** 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. */
|
|
1832
1860
|
regionCode?: string;
|
|
@@ -1836,6 +1864,10 @@ declare namespace gapi.client {
|
|
|
1836
1864
|
safeSearch?: boolean;
|
|
1837
1865
|
/** Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */
|
|
1838
1866
|
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
|
|
1867
|
+
/** 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. */
|
|
1868
|
+
session?: string;
|
|
1869
|
+
/** Session specification. Can be used only when `session` is set. */
|
|
1870
|
+
sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
|
|
1839
1871
|
/** The spell correction specification that specifies the mode under which spell correction takes effect. */
|
|
1840
1872
|
spellCorrectionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
|
|
1841
1873
|
/** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
|
|
@@ -1981,6 +2013,12 @@ declare namespace gapi.client {
|
|
|
1981
2013
|
/** Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */
|
|
1982
2014
|
imageBytes?: string;
|
|
1983
2015
|
}
|
|
2016
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec {
|
|
2017
|
+
/** The condition under which filter extraction should occur. Default to Condition.DISABLED. */
|
|
2018
|
+
filterExtractionCondition?: string;
|
|
2019
|
+
/** 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. */
|
|
2020
|
+
geoSearchQueryDetectionFieldNames?: string[];
|
|
2021
|
+
}
|
|
1984
2022
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec {
|
|
1985
2023
|
/** The condition under which query expansion should occur. Default to Condition.DISABLED. */
|
|
1986
2024
|
condition?: string;
|
|
@@ -1991,6 +2029,12 @@ declare namespace gapi.client {
|
|
|
1991
2029
|
/** The condition under which search as you type should occur. Default to Condition.DISABLED. */
|
|
1992
2030
|
condition?: string;
|
|
1993
2031
|
}
|
|
2032
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec {
|
|
2033
|
+
/** 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. */
|
|
2034
|
+
queryId?: string;
|
|
2035
|
+
/** 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. */
|
|
2036
|
+
searchResultPersistenceCount?: number;
|
|
2037
|
+
}
|
|
1994
2038
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec {
|
|
1995
2039
|
/** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
|
|
1996
2040
|
mode?: string;
|
|
@@ -2007,6 +2051,8 @@ declare namespace gapi.client {
|
|
|
2007
2051
|
geoSearchDebugInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[];
|
|
2008
2052
|
/** Guided search result. */
|
|
2009
2053
|
guidedSearchResult?: GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
|
|
2054
|
+
/** Natural language query understanding information for the returned results. */
|
|
2055
|
+
naturalLanguageQueryUnderstandingInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo;
|
|
2010
2056
|
/** 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. */
|
|
2011
2057
|
nextPageToken?: string;
|
|
2012
2058
|
/** Query expansion information for the returned results. */
|
|
@@ -2015,6 +2061,8 @@ declare namespace gapi.client {
|
|
|
2015
2061
|
redirectUri?: string;
|
|
2016
2062
|
/** A list of matched documents. The order represents the ranking. */
|
|
2017
2063
|
results?: GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[];
|
|
2064
|
+
/** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
|
|
2065
|
+
sessionInfo?: GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo;
|
|
2018
2066
|
/** A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */
|
|
2019
2067
|
summary?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummary;
|
|
2020
2068
|
/** 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. */
|
|
@@ -2054,6 +2102,60 @@ declare namespace gapi.client {
|
|
|
2054
2102
|
/** Attribute value used to refine the results. For example, `"drama"`. */
|
|
2055
2103
|
attributeValue?: string;
|
|
2056
2104
|
}
|
|
2105
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo {
|
|
2106
|
+
/** The filters that were extracted from the input query. */
|
|
2107
|
+
extractedFilters?: string;
|
|
2108
|
+
/** Rewritten input query minus the extracted filters. */
|
|
2109
|
+
rewrittenQuery?: string;
|
|
2110
|
+
/** The filters that were extracted from the input query represented in a structured form. */
|
|
2111
|
+
structuredExtractedFilter?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
|
|
2112
|
+
}
|
|
2113
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
|
|
2114
|
+
/** 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. */
|
|
2115
|
+
expression?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
|
|
2116
|
+
}
|
|
2117
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression {
|
|
2118
|
+
/** The expressions that were ANDed together. */
|
|
2119
|
+
expressions?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
|
|
2120
|
+
}
|
|
2121
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression {
|
|
2122
|
+
/** Logical "And" compound operator connecting multiple expressions. */
|
|
2123
|
+
andExpr?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression;
|
|
2124
|
+
/** Geolocation constraint expression. */
|
|
2125
|
+
geolocationConstraint?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint;
|
|
2126
|
+
/** Numerical constraint expression. */
|
|
2127
|
+
numberConstraint?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint;
|
|
2128
|
+
/** Logical "Or" compound operator connecting multiple expressions. */
|
|
2129
|
+
orExpr?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression;
|
|
2130
|
+
/** String constraint expression. */
|
|
2131
|
+
stringConstraint?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint;
|
|
2132
|
+
}
|
|
2133
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint {
|
|
2134
|
+
/** 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. */
|
|
2135
|
+
address?: string;
|
|
2136
|
+
/** The name of the geolocation field as defined in the schema. */
|
|
2137
|
+
fieldName?: string;
|
|
2138
|
+
/** The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. */
|
|
2139
|
+
radiusInMeters?: number;
|
|
2140
|
+
}
|
|
2141
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint {
|
|
2142
|
+
/** The comparison operation performed between the field value and the value specified in the constraint. */
|
|
2143
|
+
comparison?: string;
|
|
2144
|
+
/** Name of the numerical field as defined in the schema. */
|
|
2145
|
+
fieldName?: string;
|
|
2146
|
+
/** The value specified in the numerical constraint. */
|
|
2147
|
+
value?: number;
|
|
2148
|
+
}
|
|
2149
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression {
|
|
2150
|
+
/** The expressions that were ORed together. */
|
|
2151
|
+
expressions?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
|
|
2152
|
+
}
|
|
2153
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint {
|
|
2154
|
+
/** Name of the string field as defined in the schema. */
|
|
2155
|
+
fieldName?: string;
|
|
2156
|
+
/** Values of the string field. The record will only be returned if the field value matches one of the values specified here. */
|
|
2157
|
+
values?: string[];
|
|
2158
|
+
}
|
|
2057
2159
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo {
|
|
2058
2160
|
/** Bool describing whether query expansion has occurred. */
|
|
2059
2161
|
expandedQuery?: boolean;
|
|
@@ -2072,6 +2174,12 @@ declare namespace gapi.client {
|
|
|
2072
2174
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDoubleList;
|
|
2073
2175
|
};
|
|
2074
2176
|
}
|
|
2177
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo {
|
|
2178
|
+
/** Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */
|
|
2179
|
+
name?: string;
|
|
2180
|
+
/** 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. */
|
|
2181
|
+
queryId?: string;
|
|
2182
|
+
}
|
|
2075
2183
|
interface GoogleCloudDiscoveryengineV1alphaSearchResponseSummary {
|
|
2076
2184
|
/** A collection of Safety Attribute categories and their associated confidence scores. */
|
|
2077
2185
|
safetyAttributes?: GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes;
|
|
@@ -2133,7 +2241,7 @@ declare namespace gapi.client {
|
|
|
2133
2241
|
boostControlIds?: string[];
|
|
2134
2242
|
/** Output only. ServingConfig created timestamp. */
|
|
2135
2243
|
createTime?: string;
|
|
2136
|
-
/** Custom fine tuning configs. */
|
|
2244
|
+
/** Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here. */
|
|
2137
2245
|
customFineTuningSpec?: GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
|
|
2138
2246
|
/** Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
|
|
2139
2247
|
displayName?: string;
|
|
@@ -2159,7 +2267,7 @@ declare namespace gapi.client {
|
|
|
2159
2267
|
name?: string;
|
|
2160
2268
|
/** 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. */
|
|
2161
2269
|
onewaySynonymsControlIds?: string[];
|
|
2162
|
-
/** 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
|
|
2270
|
+
/** 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)`. */
|
|
2163
2271
|
rankingExpression?: string;
|
|
2164
2272
|
/** 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. */
|
|
2165
2273
|
redirectControlIds?: string[];
|
|
@@ -2501,6 +2609,8 @@ declare namespace gapi.client {
|
|
|
2501
2609
|
createTime?: string;
|
|
2502
2610
|
/** The display name of the model. */
|
|
2503
2611
|
displayName?: string;
|
|
2612
|
+
/** The metrics of the trained model. */
|
|
2613
|
+
metrics?: {[P in string]: number};
|
|
2504
2614
|
/** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
|
|
2505
2615
|
modelState?: string;
|
|
2506
2616
|
/** The version of the model. */
|
|
@@ -2570,7 +2680,7 @@ declare namespace gapi.client {
|
|
|
2570
2680
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2571
2681
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2572
2682
|
name?: string;
|
|
2573
|
-
/** 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
|
|
2683
|
+
/** 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. */
|
|
2574
2684
|
parsingConfigOverrides?: {
|
|
2575
2685
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
2576
2686
|
};
|
|
@@ -3026,7 +3136,7 @@ declare namespace gapi.client {
|
|
|
3026
3136
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3027
3137
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
3028
3138
|
name?: string;
|
|
3029
|
-
/** 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
|
|
3139
|
+
/** 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. */
|
|
3030
3140
|
parsingConfigOverrides?: {
|
|
3031
3141
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
3032
3142
|
};
|