@googleapis/discoveryengine 29.0.0 → 30.0.0
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/CHANGELOG.md +11 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +178 -19
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +178 -19
- package/build/v1alpha.js +32 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +172 -17
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +266 -19
- package/v1alpha.ts +266 -19
- package/v1beta.ts +260 -17
package/build/v1beta.d.ts
CHANGED
|
@@ -2015,6 +2015,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2015
2015
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
2016
2016
|
*/
|
|
2017
2017
|
connectorModes?: string[] | null;
|
|
2018
|
+
/**
|
|
2019
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
2020
|
+
*/
|
|
2021
|
+
connectorSourceId?: string | null;
|
|
2018
2022
|
/**
|
|
2019
2023
|
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
2020
2024
|
*/
|
|
@@ -2964,7 +2968,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2964
2968
|
*/
|
|
2965
2969
|
displayName?: string | null;
|
|
2966
2970
|
/**
|
|
2967
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`
|
|
2971
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`
|
|
2968
2972
|
*/
|
|
2969
2973
|
features?: {
|
|
2970
2974
|
[key: string]: string;
|
|
@@ -3390,7 +3394,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3390
3394
|
*/
|
|
3391
3395
|
schemaOrgPaths?: string[] | null;
|
|
3392
3396
|
/**
|
|
3393
|
-
* Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
|
|
3397
|
+
* Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
|
|
3394
3398
|
*/
|
|
3395
3399
|
searchableFieldImportance?: string | null;
|
|
3396
3400
|
/**
|
|
@@ -3801,7 +3805,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3801
3805
|
*/
|
|
3802
3806
|
filter?: string | null;
|
|
3803
3807
|
/**
|
|
3804
|
-
* 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
3808
|
+
* 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
3805
3809
|
*/
|
|
3806
3810
|
orderBy?: string | null;
|
|
3807
3811
|
/**
|
|
@@ -4232,6 +4236,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4232
4236
|
* Defines a user inputed query.
|
|
4233
4237
|
*/
|
|
4234
4238
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
|
|
4239
|
+
/**
|
|
4240
|
+
* Output only. The time at which the server accepted this query.
|
|
4241
|
+
*/
|
|
4242
|
+
createTime?: string | null;
|
|
4235
4243
|
/**
|
|
4236
4244
|
* Query content parts.
|
|
4237
4245
|
*/
|
|
@@ -4705,7 +4713,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
4705
4713
|
*/
|
|
4706
4714
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
4707
4715
|
/**
|
|
4708
|
-
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
|
|
4716
|
+
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
|
|
4709
4717
|
*/
|
|
4710
4718
|
rankingExpression?: string | null;
|
|
4711
4719
|
/**
|
|
@@ -5286,6 +5294,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5286
5294
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
5287
5295
|
*/
|
|
5288
5296
|
name?: string | null;
|
|
5297
|
+
/**
|
|
5298
|
+
* Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes.
|
|
5299
|
+
*/
|
|
5300
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
5289
5301
|
/**
|
|
5290
5302
|
* Output only. The time the session started.
|
|
5291
5303
|
*/
|
|
@@ -5693,7 +5705,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
5693
5705
|
*/
|
|
5694
5706
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
5695
5707
|
/**
|
|
5696
|
-
* Obfuscated Dasher customer ID.
|
|
5708
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
5697
5709
|
*/
|
|
5698
5710
|
dasherCustomerId?: string | null;
|
|
5699
5711
|
/**
|
|
@@ -9440,7 +9452,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9440
9452
|
*/
|
|
9441
9453
|
displayName?: string | null;
|
|
9442
9454
|
/**
|
|
9443
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`
|
|
9455
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`
|
|
9444
9456
|
*/
|
|
9445
9457
|
features?: {
|
|
9446
9458
|
[key: string]: string;
|
|
@@ -10646,6 +10658,19 @@ export declare namespace discoveryengine_v1beta {
|
|
|
10646
10658
|
*/
|
|
10647
10659
|
nextPageToken?: string | null;
|
|
10648
10660
|
}
|
|
10661
|
+
/**
|
|
10662
|
+
* Response message for LicenseConfigService.ListLicenseConfigs method.
|
|
10663
|
+
*/
|
|
10664
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse {
|
|
10665
|
+
/**
|
|
10666
|
+
* All the customer's LicenseConfigs.
|
|
10667
|
+
*/
|
|
10668
|
+
licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig[];
|
|
10669
|
+
/**
|
|
10670
|
+
* Not supported.
|
|
10671
|
+
*/
|
|
10672
|
+
nextPageToken?: string | null;
|
|
10673
|
+
}
|
|
10649
10674
|
/**
|
|
10650
10675
|
* Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
|
|
10651
10676
|
*/
|
|
@@ -11850,7 +11875,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
11850
11875
|
*/
|
|
11851
11876
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
11852
11877
|
/**
|
|
11853
|
-
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
|
|
11878
|
+
* Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be 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)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double \> 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
|
|
11854
11879
|
*/
|
|
11855
11880
|
rankingExpression?: string | null;
|
|
11856
11881
|
/**
|
|
@@ -13115,6 +13140,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13115
13140
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
13116
13141
|
*/
|
|
13117
13142
|
name?: string | null;
|
|
13143
|
+
/**
|
|
13144
|
+
* Output only. Full resource name of an in-progress AsyncAssist operation for this session, e.g. `projects/x/locations/x/collections/x/engines/x/sessions/x/operations/x`. Set when the operation starts and cleared when it finishes.
|
|
13145
|
+
*/
|
|
13146
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
13118
13147
|
/**
|
|
13119
13148
|
* Output only. The time the session started.
|
|
13120
13149
|
*/
|
|
@@ -13382,11 +13411,28 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13382
13411
|
* The tool names of the tools that were invoked.
|
|
13383
13412
|
*/
|
|
13384
13413
|
invocationTools?: string[] | null;
|
|
13414
|
+
/**
|
|
13415
|
+
* The skills executed during the turn.
|
|
13416
|
+
*/
|
|
13417
|
+
invokedSkills?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill[];
|
|
13385
13418
|
/**
|
|
13386
13419
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
13387
13420
|
*/
|
|
13388
13421
|
sessionInfo?: Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
13389
13422
|
}
|
|
13423
|
+
/**
|
|
13424
|
+
* Represents a skill used during the assist call.
|
|
13425
|
+
*/
|
|
13426
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaStreamAssistResponseInvokedSkill {
|
|
13427
|
+
/**
|
|
13428
|
+
* The display name of the skill.
|
|
13429
|
+
*/
|
|
13430
|
+
displayName?: string | null;
|
|
13431
|
+
/**
|
|
13432
|
+
* The resource name of the skill.
|
|
13433
|
+
*/
|
|
13434
|
+
name?: string | null;
|
|
13435
|
+
}
|
|
13390
13436
|
/**
|
|
13391
13437
|
* Information about the session.
|
|
13392
13438
|
*/
|
|
@@ -13837,7 +13883,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
13837
13883
|
*/
|
|
13838
13884
|
export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
13839
13885
|
/**
|
|
13840
|
-
* Obfuscated Dasher customer ID.
|
|
13886
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
13841
13887
|
*/
|
|
13842
13888
|
dasherCustomerId?: string | null;
|
|
13843
13889
|
/**
|
|
@@ -14216,6 +14262,10 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14216
14262
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
14217
14263
|
*/
|
|
14218
14264
|
connectorModes?: string[] | null;
|
|
14265
|
+
/**
|
|
14266
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
14267
|
+
*/
|
|
14268
|
+
connectorSourceId?: string | null;
|
|
14219
14269
|
/**
|
|
14220
14270
|
* Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
|
|
14221
14271
|
*/
|
|
@@ -15066,7 +15116,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15066
15116
|
*/
|
|
15067
15117
|
displayName?: string | null;
|
|
15068
15118
|
/**
|
|
15069
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills`
|
|
15119
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups`
|
|
15070
15120
|
*/
|
|
15071
15121
|
features?: {
|
|
15072
15122
|
[key: string]: string;
|
|
@@ -16433,7 +16483,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
16433
16483
|
*/
|
|
16434
16484
|
export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
16435
16485
|
/**
|
|
16436
|
-
* Obfuscated Dasher customer ID.
|
|
16486
|
+
* Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
|
|
16437
16487
|
*/
|
|
16438
16488
|
dasherCustomerId?: string | null;
|
|
16439
16489
|
/**
|
|
@@ -23545,6 +23595,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23545
23595
|
* // "isPinned": false,
|
|
23546
23596
|
* // "labels": [],
|
|
23547
23597
|
* // "name": "my_name",
|
|
23598
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23548
23599
|
* // "startTime": "my_startTime",
|
|
23549
23600
|
* // "state": "my_state",
|
|
23550
23601
|
* // "turns": [],
|
|
@@ -23562,6 +23613,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23562
23613
|
* // "isPinned": false,
|
|
23563
23614
|
* // "labels": [],
|
|
23564
23615
|
* // "name": "my_name",
|
|
23616
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23565
23617
|
* // "startTime": "my_startTime",
|
|
23566
23618
|
* // "state": "my_state",
|
|
23567
23619
|
* // "turns": [],
|
|
@@ -23706,6 +23758,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23706
23758
|
* // "isPinned": false,
|
|
23707
23759
|
* // "labels": [],
|
|
23708
23760
|
* // "name": "my_name",
|
|
23761
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23709
23762
|
* // "startTime": "my_startTime",
|
|
23710
23763
|
* // "state": "my_state",
|
|
23711
23764
|
* // "turns": [],
|
|
@@ -23771,7 +23824,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23771
23824
|
* {
|
|
23772
23825
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
23773
23826
|
* filter: 'placeholder-value',
|
|
23774
|
-
* // 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23827
|
+
* // 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23775
23828
|
* orderBy: 'placeholder-value',
|
|
23776
23829
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
23777
23830
|
* pageSize: 'placeholder-value',
|
|
@@ -23861,6 +23914,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23861
23914
|
* // "isPinned": false,
|
|
23862
23915
|
* // "labels": [],
|
|
23863
23916
|
* // "name": "my_name",
|
|
23917
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23864
23918
|
* // "startTime": "my_startTime",
|
|
23865
23919
|
* // "state": "my_state",
|
|
23866
23920
|
* // "turns": [],
|
|
@@ -23878,6 +23932,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23878
23932
|
* // "isPinned": false,
|
|
23879
23933
|
* // "labels": [],
|
|
23880
23934
|
* // "name": "my_name",
|
|
23935
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
23881
23936
|
* // "startTime": "my_startTime",
|
|
23882
23937
|
* // "state": "my_state",
|
|
23883
23938
|
* // "turns": [],
|
|
@@ -23940,7 +23995,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
23940
23995
|
*/
|
|
23941
23996
|
filter?: string;
|
|
23942
23997
|
/**
|
|
23943
|
-
* 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23998
|
+
* 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
23944
23999
|
*/
|
|
23945
24000
|
orderBy?: string;
|
|
23946
24001
|
/**
|
|
@@ -26993,7 +27048,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
26993
27048
|
resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
26994
27049
|
resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaEngine>): void;
|
|
26995
27050
|
/**
|
|
26996
|
-
* Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.user`
|
|
27051
|
+
* Sets the IAM access control policy for an Engine. A `NOT_FOUND` error is returned if the resource does not exist. **Important:** When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: `roles/discoveryengine.admin`, `roles/discoveryengine.agentspaceAdmin`, `roles/discoveryengine.user`, `roles/discoveryengine.agentspaceUser`, `roles/discoveryengine.viewer`, `roles/discoveryengine.agentspaceViewer`. Attempting to grant any other role will result in a warning in logging.
|
|
26997
27052
|
* @example
|
|
26998
27053
|
* ```js
|
|
26999
27054
|
* // Before running the sample:
|
|
@@ -27728,6 +27783,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
27728
27783
|
* // "answer": {},
|
|
27729
27784
|
* // "assistToken": "my_assistToken",
|
|
27730
27785
|
* // "invocationTools": [],
|
|
27786
|
+
* // "invokedSkills": [],
|
|
27731
27787
|
* // "sessionInfo": {}
|
|
27732
27788
|
* // }
|
|
27733
27789
|
* }
|
|
@@ -30450,6 +30506,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30450
30506
|
* // "isPinned": false,
|
|
30451
30507
|
* // "labels": [],
|
|
30452
30508
|
* // "name": "my_name",
|
|
30509
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30453
30510
|
* // "startTime": "my_startTime",
|
|
30454
30511
|
* // "state": "my_state",
|
|
30455
30512
|
* // "turns": [],
|
|
@@ -30467,6 +30524,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30467
30524
|
* // "isPinned": false,
|
|
30468
30525
|
* // "labels": [],
|
|
30469
30526
|
* // "name": "my_name",
|
|
30527
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30470
30528
|
* // "startTime": "my_startTime",
|
|
30471
30529
|
* // "state": "my_state",
|
|
30472
30530
|
* // "turns": [],
|
|
@@ -30609,6 +30667,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30609
30667
|
* // "isPinned": false,
|
|
30610
30668
|
* // "labels": [],
|
|
30611
30669
|
* // "name": "my_name",
|
|
30670
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30612
30671
|
* // "startTime": "my_startTime",
|
|
30613
30672
|
* // "state": "my_state",
|
|
30614
30673
|
* // "turns": [],
|
|
@@ -30673,7 +30732,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30673
30732
|
* await discoveryengine.projects.locations.collections.engines.sessions.list({
|
|
30674
30733
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
30675
30734
|
* filter: 'placeholder-value',
|
|
30676
|
-
* // 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30735
|
+
* // 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30677
30736
|
* orderBy: 'placeholder-value',
|
|
30678
30737
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
30679
30738
|
* pageSize: 'placeholder-value',
|
|
@@ -30762,6 +30821,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30762
30821
|
* // "isPinned": false,
|
|
30763
30822
|
* // "labels": [],
|
|
30764
30823
|
* // "name": "my_name",
|
|
30824
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30765
30825
|
* // "startTime": "my_startTime",
|
|
30766
30826
|
* // "state": "my_state",
|
|
30767
30827
|
* // "turns": [],
|
|
@@ -30779,6 +30839,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30779
30839
|
* // "isPinned": false,
|
|
30780
30840
|
* // "labels": [],
|
|
30781
30841
|
* // "name": "my_name",
|
|
30842
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
30782
30843
|
* // "startTime": "my_startTime",
|
|
30783
30844
|
* // "state": "my_state",
|
|
30784
30845
|
* // "turns": [],
|
|
@@ -30841,7 +30902,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
30841
30902
|
*/
|
|
30842
30903
|
filter?: string;
|
|
30843
30904
|
/**
|
|
30844
|
-
* 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30905
|
+
* 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
30845
30906
|
*/
|
|
30846
30907
|
orderBy?: string;
|
|
30847
30908
|
/**
|
|
@@ -36094,6 +36155,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36094
36155
|
* // "isPinned": false,
|
|
36095
36156
|
* // "labels": [],
|
|
36096
36157
|
* // "name": "my_name",
|
|
36158
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36097
36159
|
* // "startTime": "my_startTime",
|
|
36098
36160
|
* // "state": "my_state",
|
|
36099
36161
|
* // "turns": [],
|
|
@@ -36110,6 +36172,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36110
36172
|
* // "isPinned": false,
|
|
36111
36173
|
* // "labels": [],
|
|
36112
36174
|
* // "name": "my_name",
|
|
36175
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36113
36176
|
* // "startTime": "my_startTime",
|
|
36114
36177
|
* // "state": "my_state",
|
|
36115
36178
|
* // "turns": [],
|
|
@@ -36249,6 +36312,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36249
36312
|
* // "isPinned": false,
|
|
36250
36313
|
* // "labels": [],
|
|
36251
36314
|
* // "name": "my_name",
|
|
36315
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36252
36316
|
* // "startTime": "my_startTime",
|
|
36253
36317
|
* // "state": "my_state",
|
|
36254
36318
|
* // "turns": [],
|
|
@@ -36313,7 +36377,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36313
36377
|
* {
|
|
36314
36378
|
* // A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time \> "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
|
|
36315
36379
|
* filter: 'placeholder-value',
|
|
36316
|
-
* // 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36380
|
+
* // 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36317
36381
|
* orderBy: 'placeholder-value',
|
|
36318
36382
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
36319
36383
|
* pageSize: 'placeholder-value',
|
|
@@ -36402,6 +36466,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36402
36466
|
* // "isPinned": false,
|
|
36403
36467
|
* // "labels": [],
|
|
36404
36468
|
* // "name": "my_name",
|
|
36469
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36405
36470
|
* // "startTime": "my_startTime",
|
|
36406
36471
|
* // "state": "my_state",
|
|
36407
36472
|
* // "turns": [],
|
|
@@ -36418,6 +36483,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36418
36483
|
* // "isPinned": false,
|
|
36419
36484
|
* // "labels": [],
|
|
36420
36485
|
* // "name": "my_name",
|
|
36486
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
36421
36487
|
* // "startTime": "my_startTime",
|
|
36422
36488
|
* // "state": "my_state",
|
|
36423
36489
|
* // "turns": [],
|
|
@@ -36480,7 +36546,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
36480
36546
|
*/
|
|
36481
36547
|
filter?: string;
|
|
36482
36548
|
/**
|
|
36483
|
-
* 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` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36549
|
+
* 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` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
|
|
36484
36550
|
*/
|
|
36485
36551
|
orderBy?: string;
|
|
36486
36552
|
/**
|
|
@@ -39741,6 +39807,77 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39741
39807
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
39742
39808
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
39743
39809
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaLicenseConfig>): void;
|
|
39810
|
+
/**
|
|
39811
|
+
* Lists all the LicenseConfigs associated with the project.
|
|
39812
|
+
* @example
|
|
39813
|
+
* ```js
|
|
39814
|
+
* // Before running the sample:
|
|
39815
|
+
* // - Enable the API at:
|
|
39816
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
39817
|
+
* // - Login into gcloud by running:
|
|
39818
|
+
* // ```sh
|
|
39819
|
+
* // $ gcloud auth application-default login
|
|
39820
|
+
* // ```
|
|
39821
|
+
* // - Install the npm module by running:
|
|
39822
|
+
* // ```sh
|
|
39823
|
+
* // $ npm install googleapis
|
|
39824
|
+
* // ```
|
|
39825
|
+
*
|
|
39826
|
+
* const {google} = require('googleapis');
|
|
39827
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
39828
|
+
*
|
|
39829
|
+
* async function main() {
|
|
39830
|
+
* const auth = new google.auth.GoogleAuth({
|
|
39831
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
39832
|
+
* scopes: [
|
|
39833
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
39834
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
39835
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
39836
|
+
* ],
|
|
39837
|
+
* });
|
|
39838
|
+
*
|
|
39839
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
39840
|
+
* const authClient = await auth.getClient();
|
|
39841
|
+
* google.options({auth: authClient});
|
|
39842
|
+
*
|
|
39843
|
+
* // Do the magic
|
|
39844
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.list({
|
|
39845
|
+
* // Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.
|
|
39846
|
+
* filter: 'placeholder-value',
|
|
39847
|
+
* // Optional. Not supported.
|
|
39848
|
+
* pageSize: 'placeholder-value',
|
|
39849
|
+
* // Optional. Not supported.
|
|
39850
|
+
* pageToken: 'placeholder-value',
|
|
39851
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
39852
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
39853
|
+
* });
|
|
39854
|
+
* console.log(res.data);
|
|
39855
|
+
*
|
|
39856
|
+
* // Example response
|
|
39857
|
+
* // {
|
|
39858
|
+
* // "licenseConfigs": [],
|
|
39859
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
39860
|
+
* // }
|
|
39861
|
+
* }
|
|
39862
|
+
*
|
|
39863
|
+
* main().catch(e => {
|
|
39864
|
+
* console.error(e);
|
|
39865
|
+
* throw e;
|
|
39866
|
+
* });
|
|
39867
|
+
*
|
|
39868
|
+
* ```
|
|
39869
|
+
*
|
|
39870
|
+
* @param params - Parameters for request
|
|
39871
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
39872
|
+
* @param callback - Optional callback that handles the response.
|
|
39873
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
39874
|
+
*/
|
|
39875
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
39876
|
+
list(params?: Params$Resource$Projects$Locations$Licenseconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>>;
|
|
39877
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
39878
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
39879
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
39880
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsResponse>): void;
|
|
39744
39881
|
/**
|
|
39745
39882
|
* Updates the LicenseConfig
|
|
39746
39883
|
* @example
|
|
@@ -39858,6 +39995,24 @@ export declare namespace discoveryengine_v1beta {
|
|
|
39858
39995
|
*/
|
|
39859
39996
|
name?: string;
|
|
39860
39997
|
}
|
|
39998
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
|
|
39999
|
+
/**
|
|
40000
|
+
* Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs.
|
|
40001
|
+
*/
|
|
40002
|
+
filter?: string;
|
|
40003
|
+
/**
|
|
40004
|
+
* Optional. Not supported.
|
|
40005
|
+
*/
|
|
40006
|
+
pageSize?: number;
|
|
40007
|
+
/**
|
|
40008
|
+
* Optional. Not supported.
|
|
40009
|
+
*/
|
|
40010
|
+
pageToken?: string;
|
|
40011
|
+
/**
|
|
40012
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
40013
|
+
*/
|
|
40014
|
+
parent?: string;
|
|
40015
|
+
}
|
|
39861
40016
|
export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
|
|
39862
40017
|
/**
|
|
39863
40018
|
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
package/build/v1beta.js
CHANGED
|
@@ -8735,6 +8735,38 @@ var discoveryengine_v1beta;
|
|
|
8735
8735
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
8736
8736
|
}
|
|
8737
8737
|
}
|
|
8738
|
+
list(paramsOrCallback, optionsOrCallback, callback) {
|
|
8739
|
+
let params = (paramsOrCallback ||
|
|
8740
|
+
{});
|
|
8741
|
+
let options = (optionsOrCallback || {});
|
|
8742
|
+
if (typeof paramsOrCallback === 'function') {
|
|
8743
|
+
callback = paramsOrCallback;
|
|
8744
|
+
params = {};
|
|
8745
|
+
options = {};
|
|
8746
|
+
}
|
|
8747
|
+
if (typeof optionsOrCallback === 'function') {
|
|
8748
|
+
callback = optionsOrCallback;
|
|
8749
|
+
options = {};
|
|
8750
|
+
}
|
|
8751
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
8752
|
+
const parameters = {
|
|
8753
|
+
options: Object.assign({
|
|
8754
|
+
url: (rootUrl + '/v1beta/{+parent}/licenseConfigs').replace(/([^:]\/)\/+/g, '$1'),
|
|
8755
|
+
method: 'GET',
|
|
8756
|
+
apiVersion: '',
|
|
8757
|
+
}, options),
|
|
8758
|
+
params,
|
|
8759
|
+
requiredParams: ['parent'],
|
|
8760
|
+
pathParams: ['parent'],
|
|
8761
|
+
context: this.context,
|
|
8762
|
+
};
|
|
8763
|
+
if (callback) {
|
|
8764
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
8765
|
+
}
|
|
8766
|
+
else {
|
|
8767
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
8768
|
+
}
|
|
8769
|
+
}
|
|
8738
8770
|
patch(paramsOrCallback, optionsOrCallback, callback) {
|
|
8739
8771
|
let params = (paramsOrCallback ||
|
|
8740
8772
|
{});
|