@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20241123 → 0.0.20241204
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 +350 -4
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241204
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -268,6 +268,10 @@ declare namespace gapi.client {
|
|
|
268
268
|
completeTime?: string;
|
|
269
269
|
/** Output only. Answer creation timestamp. */
|
|
270
270
|
createTime?: string;
|
|
271
|
+
/** A score in the range of [0, 1] describing how grounded the answer is by the reference chunks. */
|
|
272
|
+
groundingScore?: number;
|
|
273
|
+
/** Optional. Grounding supports. */
|
|
274
|
+
groundingSupports?: GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport[];
|
|
271
275
|
/** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*` */
|
|
272
276
|
name?: string;
|
|
273
277
|
/** Query understanding information. */
|
|
@@ -293,6 +297,18 @@ declare namespace gapi.client {
|
|
|
293
297
|
/** ID of the citation source. */
|
|
294
298
|
referenceId?: string;
|
|
295
299
|
}
|
|
300
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerGroundingSupport {
|
|
301
|
+
/** Required. End of the claim, exclusive. */
|
|
302
|
+
endIndex?: string;
|
|
303
|
+
/** Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned. */
|
|
304
|
+
groundingCheckRequired?: boolean;
|
|
305
|
+
/** A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks. */
|
|
306
|
+
groundingScore?: number;
|
|
307
|
+
/** Optional. Citation sources for the claim. */
|
|
308
|
+
sources?: GoogleCloudDiscoveryengineV1alphaAnswerCitationSource[];
|
|
309
|
+
/** Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode). */
|
|
310
|
+
startIndex?: string;
|
|
311
|
+
}
|
|
296
312
|
interface GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest {
|
|
297
313
|
/** Answer generation specification. */
|
|
298
314
|
answerGenerationSpec?: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec;
|
|
@@ -1115,6 +1131,10 @@ declare namespace gapi.client {
|
|
|
1115
1131
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
1116
1132
|
updateTime?: string;
|
|
1117
1133
|
}
|
|
1134
|
+
interface GoogleCloudDiscoveryengineV1alphaDeleteSessionRequest {
|
|
1135
|
+
/** Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
1136
|
+
name?: string;
|
|
1137
|
+
}
|
|
1118
1138
|
interface GoogleCloudDiscoveryengineV1alphaDeleteSitemapMetadata {
|
|
1119
1139
|
/** Operation create time. */
|
|
1120
1140
|
createTime?: string;
|
|
@@ -1437,6 +1457,8 @@ declare namespace gapi.client {
|
|
|
1437
1457
|
gcsStagingDir?: string;
|
|
1438
1458
|
/** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
|
|
1439
1459
|
resourceTypes?: string[];
|
|
1460
|
+
/** Optional. Whether to update the DataStore schema to the latest predefined schema. If true, the DataStore schema will be updated to include any FHIR fields or resource types that have been added since the last import and corresponding FHIR resources will be imported from the FHIR store. Note this field cannot be used in conjunction with `resource_types`. It should be used after initial import. */
|
|
1461
|
+
updateFromLatestPredefinedSchema?: boolean;
|
|
1440
1462
|
}
|
|
1441
1463
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
1442
1464
|
/** 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 ``. */
|
|
@@ -1480,6 +1502,10 @@ declare namespace gapi.client {
|
|
|
1480
1502
|
/** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
|
|
1481
1503
|
inputUris?: string[];
|
|
1482
1504
|
}
|
|
1505
|
+
interface GoogleCloudDiscoveryengineV1alphaGetSessionRequest {
|
|
1506
|
+
/** Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
|
|
1507
|
+
name?: string;
|
|
1508
|
+
}
|
|
1483
1509
|
interface GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse {
|
|
1484
1510
|
/** Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } } */
|
|
1485
1511
|
documentDataMap?: {[P in string]: {[P in string]: any}};
|
|
@@ -1790,6 +1816,18 @@ declare namespace gapi.client {
|
|
|
1790
1816
|
/** All the ServingConfigs for a given dataStore. */
|
|
1791
1817
|
servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
|
|
1792
1818
|
}
|
|
1819
|
+
interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
|
|
1820
|
+
/** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
|
|
1821
|
+
filter?: string;
|
|
1822
|
+
/** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
|
|
1823
|
+
orderBy?: string;
|
|
1824
|
+
/** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
|
|
1825
|
+
pageSize?: number;
|
|
1826
|
+
/** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
|
|
1827
|
+
pageToken?: string;
|
|
1828
|
+
/** Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` */
|
|
1829
|
+
parent?: string;
|
|
1830
|
+
}
|
|
1793
1831
|
interface GoogleCloudDiscoveryengineV1alphaListSessionsResponse {
|
|
1794
1832
|
/** Pagination token, if not returned indicates the last page. */
|
|
1795
1833
|
nextPageToken?: string;
|
|
@@ -2420,6 +2458,8 @@ declare namespace gapi.client {
|
|
|
2420
2458
|
version?: string;
|
|
2421
2459
|
}
|
|
2422
2460
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
|
|
2461
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
2462
|
+
boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
|
|
2423
2463
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
2424
2464
|
dataStore?: string;
|
|
2425
2465
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -2953,6 +2993,12 @@ declare namespace gapi.client {
|
|
|
2953
2993
|
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
2954
2994
|
updateTime?: string;
|
|
2955
2995
|
}
|
|
2996
|
+
interface GoogleCloudDiscoveryengineV1alphaUpdateSessionRequest {
|
|
2997
|
+
/** Required. The Session to update. */
|
|
2998
|
+
session?: GoogleCloudDiscoveryengineV1alphaSession;
|
|
2999
|
+
/** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
|
|
3000
|
+
updateMask?: string;
|
|
3001
|
+
}
|
|
2956
3002
|
interface GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata {
|
|
2957
3003
|
/** Operation create time. */
|
|
2958
3004
|
createTime?: string;
|
|
@@ -3785,6 +3831,8 @@ declare namespace gapi.client {
|
|
|
3785
3831
|
version?: string;
|
|
3786
3832
|
}
|
|
3787
3833
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
|
|
3834
|
+
/** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
|
|
3835
|
+
boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
|
|
3788
3836
|
/** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
|
|
3789
3837
|
dataStore?: string;
|
|
3790
3838
|
/** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
@@ -4406,6 +4454,130 @@ declare namespace gapi.client {
|
|
|
4406
4454
|
/** Required. The URL for the page the user wants to promote. */
|
|
4407
4455
|
uri?: string;
|
|
4408
4456
|
}
|
|
4457
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec {
|
|
4458
|
+
/** Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */
|
|
4459
|
+
chunkSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec;
|
|
4460
|
+
/** If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */
|
|
4461
|
+
extractiveContentSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec;
|
|
4462
|
+
/** Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */
|
|
4463
|
+
searchResultMode?: string;
|
|
4464
|
+
/** If `snippetSpec` is not specified, snippets are not included in the search response. */
|
|
4465
|
+
snippetSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec;
|
|
4466
|
+
/** If `summarySpec` is not specified, summaries are not included in the search response. */
|
|
4467
|
+
summarySpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec;
|
|
4468
|
+
}
|
|
4469
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec {
|
|
4470
|
+
/** The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */
|
|
4471
|
+
numNextChunks?: number;
|
|
4472
|
+
/** The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */
|
|
4473
|
+
numPreviousChunks?: number;
|
|
4474
|
+
}
|
|
4475
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec {
|
|
4476
|
+
/** The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */
|
|
4477
|
+
maxExtractiveAnswerCount?: number;
|
|
4478
|
+
/** The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */
|
|
4479
|
+
maxExtractiveSegmentCount?: number;
|
|
4480
|
+
/** Return at most `num_next_segments` segments after each selected segments. */
|
|
4481
|
+
numNextSegments?: number;
|
|
4482
|
+
/** Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */
|
|
4483
|
+
numPreviousSegments?: number;
|
|
4484
|
+
/** Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */
|
|
4485
|
+
returnExtractiveSegmentScore?: boolean;
|
|
4486
|
+
}
|
|
4487
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec {
|
|
4488
|
+
/** [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. */
|
|
4489
|
+
maxSnippetCount?: number;
|
|
4490
|
+
/** [DEPRECATED] This field is deprecated and will have no affect on the snippet. */
|
|
4491
|
+
referenceOnly?: boolean;
|
|
4492
|
+
/** If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */
|
|
4493
|
+
returnSnippet?: boolean;
|
|
4494
|
+
}
|
|
4495
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec {
|
|
4496
|
+
/** 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. */
|
|
4497
|
+
ignoreAdversarialQuery?: boolean;
|
|
4498
|
+
/** Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. */
|
|
4499
|
+
ignoreJailBreakingQuery?: boolean;
|
|
4500
|
+
/** 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. */
|
|
4501
|
+
ignoreLowRelevantContent?: boolean;
|
|
4502
|
+
/** 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. */
|
|
4503
|
+
ignoreNonSummarySeekingQuery?: boolean;
|
|
4504
|
+
/** 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. */
|
|
4505
|
+
includeCitations?: boolean;
|
|
4506
|
+
/** Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
|
|
4507
|
+
languageCode?: string;
|
|
4508
|
+
/** If specified, the spec will be used to modify the prompt provided to the LLM. */
|
|
4509
|
+
modelPromptSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec;
|
|
4510
|
+
/** If specified, the spec will be used to modify the model specification provided to the LLM. */
|
|
4511
|
+
modelSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec;
|
|
4512
|
+
/** The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */
|
|
4513
|
+
summaryResultCount?: number;
|
|
4514
|
+
/** If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */
|
|
4515
|
+
useSemanticChunks?: boolean;
|
|
4516
|
+
}
|
|
4517
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelPromptSpec {
|
|
4518
|
+
/** Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */
|
|
4519
|
+
preamble?: string;
|
|
4520
|
+
}
|
|
4521
|
+
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecModelSpec {
|
|
4522
|
+
/** The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */
|
|
4523
|
+
version?: string;
|
|
4524
|
+
}
|
|
4525
|
+
interface GoogleCloudDiscoveryengineV1ServingConfig {
|
|
4526
|
+
/** Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */
|
|
4527
|
+
boostControlIds?: string[];
|
|
4528
|
+
/** Output only. ServingConfig created timestamp. */
|
|
4529
|
+
createTime?: string;
|
|
4530
|
+
/** 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. */
|
|
4531
|
+
displayName?: string;
|
|
4532
|
+
/** Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4533
|
+
dissociateControlIds?: string[];
|
|
4534
|
+
/** How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4535
|
+
diversityLevel?: string;
|
|
4536
|
+
/** Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. */
|
|
4537
|
+
filterControlIds?: string[];
|
|
4538
|
+
/** The GenericConfig of the serving configuration. */
|
|
4539
|
+
genericConfig?: GoogleCloudDiscoveryengineV1ServingConfigGenericConfig;
|
|
4540
|
+
/** Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. */
|
|
4541
|
+
ignoreControlIds?: string[];
|
|
4542
|
+
/** The MediaConfig of the serving configuration. */
|
|
4543
|
+
mediaConfig?: GoogleCloudDiscoveryengineV1ServingConfigMediaConfig;
|
|
4544
|
+
/** The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */
|
|
4545
|
+
modelId?: string;
|
|
4546
|
+
/** Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` */
|
|
4547
|
+
name?: string;
|
|
4548
|
+
/** 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. */
|
|
4549
|
+
onewaySynonymsControlIds?: string[];
|
|
4550
|
+
/** Condition promote specifications. Maximum number of specifications is 100. */
|
|
4551
|
+
promoteControlIds?: string[];
|
|
4552
|
+
/** 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)`. */
|
|
4553
|
+
rankingExpression?: string;
|
|
4554
|
+
/** 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. */
|
|
4555
|
+
redirectControlIds?: string[];
|
|
4556
|
+
/** Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4557
|
+
replacementControlIds?: string[];
|
|
4558
|
+
/** Required. Immutable. Specifies the solution type that a serving config can be associated with. */
|
|
4559
|
+
solutionType?: string;
|
|
4560
|
+
/** Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */
|
|
4561
|
+
synonymsControlIds?: string[];
|
|
4562
|
+
/** Output only. ServingConfig updated timestamp. */
|
|
4563
|
+
updateTime?: string;
|
|
4564
|
+
}
|
|
4565
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigGenericConfig {
|
|
4566
|
+
/** Specifies the expected behavior of content search. Only valid for content-search enabled data store. */
|
|
4567
|
+
contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
|
|
4568
|
+
}
|
|
4569
|
+
interface GoogleCloudDiscoveryengineV1ServingConfigMediaConfig {
|
|
4570
|
+
/** Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */
|
|
4571
|
+
contentFreshnessCutoffDays?: number;
|
|
4572
|
+
/** Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */
|
|
4573
|
+
contentWatchedPercentageThreshold?: number;
|
|
4574
|
+
/** Specifies the content watched minutes threshold for demotion. */
|
|
4575
|
+
contentWatchedSecondsThreshold?: number;
|
|
4576
|
+
/** Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days. */
|
|
4577
|
+
demoteContentWatchedPastDays?: number;
|
|
4578
|
+
/** Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */
|
|
4579
|
+
demotionEventType?: string;
|
|
4580
|
+
}
|
|
4409
4581
|
interface GoogleCloudDiscoveryengineV1SiteVerificationInfo {
|
|
4410
4582
|
/** Site verification state indicating the ownership and validity. */
|
|
4411
4583
|
siteVerificationState?: string;
|
|
@@ -6780,6 +6952,64 @@ declare namespace gapi.client {
|
|
|
6780
6952
|
},
|
|
6781
6953
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
6782
6954
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
6955
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
6956
|
+
streamAnswer(request: {
|
|
6957
|
+
/** V1 error format. */
|
|
6958
|
+
'$.xgafv'?: string;
|
|
6959
|
+
/** OAuth access token. */
|
|
6960
|
+
access_token?: string;
|
|
6961
|
+
/** Data format for response. */
|
|
6962
|
+
alt?: string;
|
|
6963
|
+
/** JSONP */
|
|
6964
|
+
callback?: string;
|
|
6965
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6966
|
+
fields?: string;
|
|
6967
|
+
/** 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. */
|
|
6968
|
+
key?: string;
|
|
6969
|
+
/** OAuth 2.0 token for the current user. */
|
|
6970
|
+
oauth_token?: string;
|
|
6971
|
+
/** Returns response with indentations and line breaks. */
|
|
6972
|
+
prettyPrint?: boolean;
|
|
6973
|
+
/** 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. */
|
|
6974
|
+
quotaUser?: string;
|
|
6975
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
6976
|
+
servingConfig: string;
|
|
6977
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6978
|
+
upload_protocol?: string;
|
|
6979
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6980
|
+
uploadType?: string;
|
|
6981
|
+
/** Request body */
|
|
6982
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
6983
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
6984
|
+
streamAnswer(
|
|
6985
|
+
request: {
|
|
6986
|
+
/** V1 error format. */
|
|
6987
|
+
'$.xgafv'?: string;
|
|
6988
|
+
/** OAuth access token. */
|
|
6989
|
+
access_token?: string;
|
|
6990
|
+
/** Data format for response. */
|
|
6991
|
+
alt?: string;
|
|
6992
|
+
/** JSONP */
|
|
6993
|
+
callback?: string;
|
|
6994
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6995
|
+
fields?: string;
|
|
6996
|
+
/** 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. */
|
|
6997
|
+
key?: string;
|
|
6998
|
+
/** OAuth 2.0 token for the current user. */
|
|
6999
|
+
oauth_token?: string;
|
|
7000
|
+
/** Returns response with indentations and line breaks. */
|
|
7001
|
+
prettyPrint?: boolean;
|
|
7002
|
+
/** 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. */
|
|
7003
|
+
quotaUser?: string;
|
|
7004
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
7005
|
+
servingConfig: string;
|
|
7006
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
7007
|
+
upload_protocol?: string;
|
|
7008
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
7009
|
+
uploadType?: string;
|
|
7010
|
+
},
|
|
7011
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
7012
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
6783
7013
|
}
|
|
6784
7014
|
interface AnswersResource {
|
|
6785
7015
|
/** Gets a Answer. */
|
|
@@ -7985,7 +8215,7 @@ declare namespace gapi.client {
|
|
|
7985
8215
|
key?: string;
|
|
7986
8216
|
/** OAuth 2.0 token for the current user. */
|
|
7987
8217
|
oauth_token?: string;
|
|
7988
|
-
/** Required. The parent
|
|
8218
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
7989
8219
|
parent: string;
|
|
7990
8220
|
/** Returns response with indentations and line breaks. */
|
|
7991
8221
|
prettyPrint?: boolean;
|
|
@@ -9588,6 +9818,64 @@ declare namespace gapi.client {
|
|
|
9588
9818
|
},
|
|
9589
9819
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
9590
9820
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
9821
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
9822
|
+
streamAnswer(request: {
|
|
9823
|
+
/** V1 error format. */
|
|
9824
|
+
'$.xgafv'?: string;
|
|
9825
|
+
/** OAuth access token. */
|
|
9826
|
+
access_token?: string;
|
|
9827
|
+
/** Data format for response. */
|
|
9828
|
+
alt?: string;
|
|
9829
|
+
/** JSONP */
|
|
9830
|
+
callback?: string;
|
|
9831
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9832
|
+
fields?: string;
|
|
9833
|
+
/** 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. */
|
|
9834
|
+
key?: string;
|
|
9835
|
+
/** OAuth 2.0 token for the current user. */
|
|
9836
|
+
oauth_token?: string;
|
|
9837
|
+
/** Returns response with indentations and line breaks. */
|
|
9838
|
+
prettyPrint?: boolean;
|
|
9839
|
+
/** 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. */
|
|
9840
|
+
quotaUser?: string;
|
|
9841
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
9842
|
+
servingConfig: string;
|
|
9843
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9844
|
+
upload_protocol?: string;
|
|
9845
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9846
|
+
uploadType?: string;
|
|
9847
|
+
/** Request body */
|
|
9848
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
9849
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
9850
|
+
streamAnswer(
|
|
9851
|
+
request: {
|
|
9852
|
+
/** V1 error format. */
|
|
9853
|
+
'$.xgafv'?: string;
|
|
9854
|
+
/** OAuth access token. */
|
|
9855
|
+
access_token?: string;
|
|
9856
|
+
/** Data format for response. */
|
|
9857
|
+
alt?: string;
|
|
9858
|
+
/** JSONP */
|
|
9859
|
+
callback?: string;
|
|
9860
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9861
|
+
fields?: string;
|
|
9862
|
+
/** 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. */
|
|
9863
|
+
key?: string;
|
|
9864
|
+
/** OAuth 2.0 token for the current user. */
|
|
9865
|
+
oauth_token?: string;
|
|
9866
|
+
/** Returns response with indentations and line breaks. */
|
|
9867
|
+
prettyPrint?: boolean;
|
|
9868
|
+
/** 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. */
|
|
9869
|
+
quotaUser?: string;
|
|
9870
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
9871
|
+
servingConfig: string;
|
|
9872
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9873
|
+
upload_protocol?: string;
|
|
9874
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9875
|
+
uploadType?: string;
|
|
9876
|
+
},
|
|
9877
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
9878
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
9591
9879
|
}
|
|
9592
9880
|
interface AnswersResource {
|
|
9593
9881
|
/** Gets a Answer. */
|
|
@@ -12220,6 +12508,64 @@ declare namespace gapi.client {
|
|
|
12220
12508
|
},
|
|
12221
12509
|
body: GoogleCloudDiscoveryengineV1alphaSearchRequest
|
|
12222
12510
|
): Request<GoogleCloudDiscoveryengineV1alphaSearchResponse>;
|
|
12511
|
+
/** Answer query method (streaming). It takes one AnswerQueryRequest and returns multiple AnswerQueryResponse messages in a stream. */
|
|
12512
|
+
streamAnswer(request: {
|
|
12513
|
+
/** V1 error format. */
|
|
12514
|
+
'$.xgafv'?: string;
|
|
12515
|
+
/** OAuth access token. */
|
|
12516
|
+
access_token?: string;
|
|
12517
|
+
/** Data format for response. */
|
|
12518
|
+
alt?: string;
|
|
12519
|
+
/** JSONP */
|
|
12520
|
+
callback?: string;
|
|
12521
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12522
|
+
fields?: string;
|
|
12523
|
+
/** 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. */
|
|
12524
|
+
key?: string;
|
|
12525
|
+
/** OAuth 2.0 token for the current user. */
|
|
12526
|
+
oauth_token?: string;
|
|
12527
|
+
/** Returns response with indentations and line breaks. */
|
|
12528
|
+
prettyPrint?: boolean;
|
|
12529
|
+
/** 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. */
|
|
12530
|
+
quotaUser?: string;
|
|
12531
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12532
|
+
servingConfig: string;
|
|
12533
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12534
|
+
upload_protocol?: string;
|
|
12535
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12536
|
+
uploadType?: string;
|
|
12537
|
+
/** Request body */
|
|
12538
|
+
resource: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
12539
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
12540
|
+
streamAnswer(
|
|
12541
|
+
request: {
|
|
12542
|
+
/** V1 error format. */
|
|
12543
|
+
'$.xgafv'?: string;
|
|
12544
|
+
/** OAuth access token. */
|
|
12545
|
+
access_token?: string;
|
|
12546
|
+
/** Data format for response. */
|
|
12547
|
+
alt?: string;
|
|
12548
|
+
/** JSONP */
|
|
12549
|
+
callback?: string;
|
|
12550
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12551
|
+
fields?: string;
|
|
12552
|
+
/** 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. */
|
|
12553
|
+
key?: string;
|
|
12554
|
+
/** OAuth 2.0 token for the current user. */
|
|
12555
|
+
oauth_token?: string;
|
|
12556
|
+
/** Returns response with indentations and line breaks. */
|
|
12557
|
+
prettyPrint?: boolean;
|
|
12558
|
+
/** 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. */
|
|
12559
|
+
quotaUser?: string;
|
|
12560
|
+
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
12561
|
+
servingConfig: string;
|
|
12562
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12563
|
+
upload_protocol?: string;
|
|
12564
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12565
|
+
uploadType?: string;
|
|
12566
|
+
},
|
|
12567
|
+
body: GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
|
|
12568
|
+
): Request<GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>;
|
|
12223
12569
|
}
|
|
12224
12570
|
interface AnswersResource {
|
|
12225
12571
|
/** Gets a Answer. */
|
|
@@ -13154,7 +13500,7 @@ declare namespace gapi.client {
|
|
|
13154
13500
|
key?: string;
|
|
13155
13501
|
/** OAuth 2.0 token for the current user. */
|
|
13156
13502
|
oauth_token?: string;
|
|
13157
|
-
/** Required. The parent
|
|
13503
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
13158
13504
|
parent: string;
|
|
13159
13505
|
/** Returns response with indentations and line breaks. */
|
|
13160
13506
|
prettyPrint?: boolean;
|
|
@@ -14757,7 +15103,7 @@ declare namespace gapi.client {
|
|
|
14757
15103
|
key?: string;
|
|
14758
15104
|
/** OAuth 2.0 token for the current user. */
|
|
14759
15105
|
oauth_token?: string;
|
|
14760
|
-
/** Required. The parent
|
|
15106
|
+
/** Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`. */
|
|
14761
15107
|
parent: string;
|
|
14762
15108
|
/** Returns response with indentations and line breaks. */
|
|
14763
15109
|
prettyPrint?: boolean;
|