@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/v1.ts CHANGED
@@ -2912,6 +2912,10 @@ export namespace discoveryengine_v1 {
2912
2912
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
2913
2913
  */
2914
2914
  connectorModes?: string[] | null;
2915
+ /**
2916
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
2917
+ */
2918
+ connectorSourceId?: string | null;
2915
2919
  /**
2916
2920
  * 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.
2917
2921
  */
@@ -3842,7 +3846,7 @@ export namespace discoveryengine_v1 {
3842
3846
  */
3843
3847
  displayName?: string | null;
3844
3848
  /**
3845
- * 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`
3849
+ * 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`
3846
3850
  */
3847
3851
  features?: {[key: string]: string} | null;
3848
3852
  /**
@@ -4262,7 +4266,7 @@ export namespace discoveryengine_v1 {
4262
4266
  */
4263
4267
  schemaOrgPaths?: string[] | null;
4264
4268
  /**
4265
- * 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`.
4269
+ * 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).
4266
4270
  */
4267
4271
  searchableFieldImportance?: string | null;
4268
4272
  /**
@@ -4669,7 +4673,7 @@ export namespace discoveryengine_v1 {
4669
4673
  */
4670
4674
  filter?: string | null;
4671
4675
  /**
4672
- * 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.
4676
+ * 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.
4673
4677
  */
4674
4678
  orderBy?: string | null;
4675
4679
  /**
@@ -5101,6 +5105,10 @@ export namespace discoveryengine_v1 {
5101
5105
  * Defines a user inputed query.
5102
5106
  */
5103
5107
  export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
5108
+ /**
5109
+ * Output only. The time at which the server accepted this query.
5110
+ */
5111
+ createTime?: string | null;
5104
5112
  /**
5105
5113
  * Query content parts.
5106
5114
  */
@@ -5570,7 +5578,7 @@ export namespace discoveryengine_v1 {
5570
5578
  */
5571
5579
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
5572
5580
  /**
5573
- * 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
5581
+ * 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
5574
5582
  */
5575
5583
  rankingExpression?: string | null;
5576
5584
  /**
@@ -6149,6 +6157,10 @@ export namespace discoveryengine_v1 {
6149
6157
  * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
6150
6158
  */
6151
6159
  name?: string | null;
6160
+ /**
6161
+ * 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.
6162
+ */
6163
+ pendingAsyncAssistOperationId?: string | null;
6152
6164
  /**
6153
6165
  * Output only. The time the session started.
6154
6166
  */
@@ -6549,7 +6561,7 @@ export namespace discoveryengine_v1 {
6549
6561
  */
6550
6562
  export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
6551
6563
  /**
6552
- * Obfuscated Dasher customer ID.
6564
+ * 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.
6553
6565
  */
6554
6566
  dasherCustomerId?: string | null;
6555
6567
  /**
@@ -8949,7 +8961,7 @@ export namespace discoveryengine_v1 {
8949
8961
  */
8950
8962
  displayName?: string | null;
8951
8963
  /**
8952
- * 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`
8964
+ * 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`
8953
8965
  */
8954
8966
  features?: {[key: string]: string} | null;
8955
8967
  /**
@@ -10096,7 +10108,7 @@ export namespace discoveryengine_v1 {
10096
10108
  */
10097
10109
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
10098
10110
  /**
10099
- * 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
10111
+ * 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
10100
10112
  */
10101
10113
  rankingExpression?: string | null;
10102
10114
  /**
@@ -10949,7 +10961,7 @@ export namespace discoveryengine_v1 {
10949
10961
  */
10950
10962
  export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
10951
10963
  /**
10952
- * Obfuscated Dasher customer ID.
10964
+ * 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.
10953
10965
  */
10954
10966
  dasherCustomerId?: string | null;
10955
10967
  /**
@@ -11967,6 +11979,10 @@ export namespace discoveryengine_v1 {
11967
11979
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
11968
11980
  */
11969
11981
  connectorModes?: string[] | null;
11982
+ /**
11983
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
11984
+ */
11985
+ connectorSourceId?: string | null;
11970
11986
  /**
11971
11987
  * 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.
11972
11988
  */
@@ -12983,7 +12999,7 @@ export namespace discoveryengine_v1 {
12983
12999
  */
12984
13000
  displayName?: string | null;
12985
13001
  /**
12986
- * 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`
13002
+ * 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`
12987
13003
  */
12988
13004
  features?: {[key: string]: string} | null;
12989
13005
  /**
@@ -14007,6 +14023,19 @@ export namespace discoveryengine_v1 {
14007
14023
  */
14008
14024
  nextPageToken?: string | null;
14009
14025
  }
14026
+ /**
14027
+ * Response message for LicenseConfigService.ListLicenseConfigs method.
14028
+ */
14029
+ export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse {
14030
+ /**
14031
+ * All the customer's LicenseConfigs.
14032
+ */
14033
+ licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1LicenseConfig[];
14034
+ /**
14035
+ * Not supported.
14036
+ */
14037
+ nextPageToken?: string | null;
14038
+ }
14010
14039
  /**
14011
14040
  * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
14012
14041
  */
@@ -14927,7 +14956,7 @@ export namespace discoveryengine_v1 {
14927
14956
  */
14928
14957
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec;
14929
14958
  /**
14930
- * 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
14959
+ * 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
14931
14960
  */
14932
14961
  rankingExpression?: string | null;
14933
14962
  /**
@@ -15976,6 +16005,10 @@ export namespace discoveryengine_v1 {
15976
16005
  * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
15977
16006
  */
15978
16007
  name?: string | null;
16008
+ /**
16009
+ * 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.
16010
+ */
16011
+ pendingAsyncAssistOperationId?: string | null;
15979
16012
  /**
15980
16013
  * Output only. The time the session started.
15981
16014
  */
@@ -16212,11 +16245,28 @@ export namespace discoveryengine_v1 {
16212
16245
  * The tool names of the tools that were invoked.
16213
16246
  */
16214
16247
  invocationTools?: string[] | null;
16248
+ /**
16249
+ * The skills executed during the turn.
16250
+ */
16251
+ invokedSkills?: Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill[];
16215
16252
  /**
16216
16253
  * Session information. Only included in the final StreamAssistResponse of the response stream.
16217
16254
  */
16218
16255
  sessionInfo?: Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo;
16219
16256
  }
16257
+ /**
16258
+ * Represents a skill used during the assist call.
16259
+ */
16260
+ export interface Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill {
16261
+ /**
16262
+ * The display name of the skill.
16263
+ */
16264
+ displayName?: string | null;
16265
+ /**
16266
+ * The resource name of the skill.
16267
+ */
16268
+ name?: string | null;
16269
+ }
16220
16270
  /**
16221
16271
  * Information about the session.
16222
16272
  */
@@ -17114,7 +17164,7 @@ export namespace discoveryengine_v1 {
17114
17164
  */
17115
17165
  enableVisualContentSummary?: boolean | null;
17116
17166
  /**
17117
- * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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`
17167
+ * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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`
17118
17168
  */
17119
17169
  features?: {[key: string]: string} | null;
17120
17170
  /**
@@ -17184,7 +17234,7 @@ export namespace discoveryengine_v1 {
17184
17234
  */
17185
17235
  export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
17186
17236
  /**
17187
- * Obfuscated Dasher customer ID.
17237
+ * 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.
17188
17238
  */
17189
17239
  dasherCustomerId?: string | null;
17190
17240
  /**
@@ -18632,6 +18682,7 @@ export namespace discoveryengine_v1 {
18632
18682
  * // "blockingReasons": [],
18633
18683
  * // "cliConfig": {},
18634
18684
  * // "connectorModes": [],
18685
+ * // "connectorSourceId": "my_connectorSourceId",
18635
18686
  * // "connectorType": "my_connectorType",
18636
18687
  * // "createEuaSaas": false,
18637
18688
  * // "createTime": "my_createTime",
@@ -20055,6 +20106,7 @@ export namespace discoveryengine_v1 {
20055
20106
  * // "blockingReasons": [],
20056
20107
  * // "cliConfig": {},
20057
20108
  * // "connectorModes": [],
20109
+ * // "connectorSourceId": "my_connectorSourceId",
20058
20110
  * // "connectorType": "my_connectorType",
20059
20111
  * // "createEuaSaas": false,
20060
20112
  * // "createTime": "my_createTime",
@@ -20251,6 +20303,7 @@ export namespace discoveryengine_v1 {
20251
20303
  * // "blockingReasons": [],
20252
20304
  * // "cliConfig": {},
20253
20305
  * // "connectorModes": [],
20306
+ * // "connectorSourceId": "my_connectorSourceId",
20254
20307
  * // "connectorType": "my_connectorType",
20255
20308
  * // "createEuaSaas": false,
20256
20309
  * // "createTime": "my_createTime",
@@ -20301,6 +20354,7 @@ export namespace discoveryengine_v1 {
20301
20354
  * // "blockingReasons": [],
20302
20355
  * // "cliConfig": {},
20303
20356
  * // "connectorModes": [],
20357
+ * // "connectorSourceId": "my_connectorSourceId",
20304
20358
  * // "connectorType": "my_connectorType",
20305
20359
  * // "createEuaSaas": false,
20306
20360
  * // "createTime": "my_createTime",
@@ -31214,6 +31268,7 @@ export namespace discoveryengine_v1 {
31214
31268
  * // "isPinned": false,
31215
31269
  * // "labels": [],
31216
31270
  * // "name": "my_name",
31271
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
31217
31272
  * // "startTime": "my_startTime",
31218
31273
  * // "state": "my_state",
31219
31274
  * // "turns": [],
@@ -31231,6 +31286,7 @@ export namespace discoveryengine_v1 {
31231
31286
  * // "isPinned": false,
31232
31287
  * // "labels": [],
31233
31288
  * // "name": "my_name",
31289
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
31234
31290
  * // "startTime": "my_startTime",
31235
31291
  * // "state": "my_state",
31236
31292
  * // "turns": [],
@@ -31540,6 +31596,7 @@ export namespace discoveryengine_v1 {
31540
31596
  * // "isPinned": false,
31541
31597
  * // "labels": [],
31542
31598
  * // "name": "my_name",
31599
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
31543
31600
  * // "startTime": "my_startTime",
31544
31601
  * // "state": "my_state",
31545
31602
  * // "turns": [],
@@ -31691,7 +31748,7 @@ export namespace discoveryengine_v1 {
31691
31748
  * {
31692
31749
  * // 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"`
31693
31750
  * filter: 'placeholder-value',
31694
- * // 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.
31751
+ * // 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.
31695
31752
  * orderBy: 'placeholder-value',
31696
31753
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
31697
31754
  * pageSize: 'placeholder-value',
@@ -31870,6 +31927,7 @@ export namespace discoveryengine_v1 {
31870
31927
  * // "isPinned": false,
31871
31928
  * // "labels": [],
31872
31929
  * // "name": "my_name",
31930
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
31873
31931
  * // "startTime": "my_startTime",
31874
31932
  * // "state": "my_state",
31875
31933
  * // "turns": [],
@@ -31887,6 +31945,7 @@ export namespace discoveryengine_v1 {
31887
31945
  * // "isPinned": false,
31888
31946
  * // "labels": [],
31889
31947
  * // "name": "my_name",
31948
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
31890
31949
  * // "startTime": "my_startTime",
31891
31950
  * // "state": "my_state",
31892
31951
  * // "turns": [],
@@ -32036,7 +32095,7 @@ export namespace discoveryengine_v1 {
32036
32095
  */
32037
32096
  filter?: string;
32038
32097
  /**
32039
- * 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.
32098
+ * 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.
32040
32099
  */
32041
32100
  orderBy?: string;
32042
32101
  /**
@@ -38065,7 +38124,7 @@ export namespace discoveryengine_v1 {
38065
38124
  }
38066
38125
 
38067
38126
  /**
38068
- * 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` and `roles/discoveryengine.agentspaceUser`. Attempting to grant any other role will result in a warning in logging.
38127
+ * 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.
38069
38128
  * @example
38070
38129
  * ```js
38071
38130
  * // Before running the sample:
@@ -39212,6 +39271,7 @@ export namespace discoveryengine_v1 {
39212
39271
  * // "answer": {},
39213
39272
  * // "assistToken": "my_assistToken",
39214
39273
  * // "invocationTools": [],
39274
+ * // "invokedSkills": [],
39215
39275
  * // "sessionInfo": {}
39216
39276
  * // }
39217
39277
  * }
@@ -46037,6 +46097,7 @@ export namespace discoveryengine_v1 {
46037
46097
  * // "isPinned": false,
46038
46098
  * // "labels": [],
46039
46099
  * // "name": "my_name",
46100
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
46040
46101
  * // "startTime": "my_startTime",
46041
46102
  * // "state": "my_state",
46042
46103
  * // "turns": [],
@@ -46054,6 +46115,7 @@ export namespace discoveryengine_v1 {
46054
46115
  * // "isPinned": false,
46055
46116
  * // "labels": [],
46056
46117
  * // "name": "my_name",
46118
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
46057
46119
  * // "startTime": "my_startTime",
46058
46120
  * // "state": "my_state",
46059
46121
  * // "turns": [],
@@ -46361,6 +46423,7 @@ export namespace discoveryengine_v1 {
46361
46423
  * // "isPinned": false,
46362
46424
  * // "labels": [],
46363
46425
  * // "name": "my_name",
46426
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
46364
46427
  * // "startTime": "my_startTime",
46365
46428
  * // "state": "my_state",
46366
46429
  * // "turns": [],
@@ -46511,7 +46574,7 @@ export namespace discoveryengine_v1 {
46511
46574
  * await discoveryengine.projects.locations.collections.engines.sessions.list({
46512
46575
  * // 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"`
46513
46576
  * filter: 'placeholder-value',
46514
- * // 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.
46577
+ * // 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.
46515
46578
  * orderBy: 'placeholder-value',
46516
46579
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
46517
46580
  * pageSize: 'placeholder-value',
@@ -46689,6 +46752,7 @@ export namespace discoveryengine_v1 {
46689
46752
  * // "isPinned": false,
46690
46753
  * // "labels": [],
46691
46754
  * // "name": "my_name",
46755
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
46692
46756
  * // "startTime": "my_startTime",
46693
46757
  * // "state": "my_state",
46694
46758
  * // "turns": [],
@@ -46706,6 +46770,7 @@ export namespace discoveryengine_v1 {
46706
46770
  * // "isPinned": false,
46707
46771
  * // "labels": [],
46708
46772
  * // "name": "my_name",
46773
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
46709
46774
  * // "startTime": "my_startTime",
46710
46775
  * // "state": "my_state",
46711
46776
  * // "turns": [],
@@ -46855,7 +46920,7 @@ export namespace discoveryengine_v1 {
46855
46920
  */
46856
46921
  filter?: string;
46857
46922
  /**
46858
- * 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.
46923
+ * 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.
46859
46924
  */
46860
46925
  orderBy?: string;
46861
46926
  /**
@@ -57282,6 +57347,7 @@ export namespace discoveryengine_v1 {
57282
57347
  * // "isPinned": false,
57283
57348
  * // "labels": [],
57284
57349
  * // "name": "my_name",
57350
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
57285
57351
  * // "startTime": "my_startTime",
57286
57352
  * // "state": "my_state",
57287
57353
  * // "turns": [],
@@ -57298,6 +57364,7 @@ export namespace discoveryengine_v1 {
57298
57364
  * // "isPinned": false,
57299
57365
  * // "labels": [],
57300
57366
  * // "name": "my_name",
57367
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
57301
57368
  * // "startTime": "my_startTime",
57302
57369
  * // "state": "my_state",
57303
57370
  * // "turns": [],
@@ -57602,6 +57669,7 @@ export namespace discoveryengine_v1 {
57602
57669
  * // "isPinned": false,
57603
57670
  * // "labels": [],
57604
57671
  * // "name": "my_name",
57672
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
57605
57673
  * // "startTime": "my_startTime",
57606
57674
  * // "state": "my_state",
57607
57675
  * // "turns": [],
@@ -57752,7 +57820,7 @@ export namespace discoveryengine_v1 {
57752
57820
  * {
57753
57821
  * // 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"`
57754
57822
  * filter: 'placeholder-value',
57755
- * // 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.
57823
+ * // 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.
57756
57824
  * orderBy: 'placeholder-value',
57757
57825
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
57758
57826
  * pageSize: 'placeholder-value',
@@ -57930,6 +57998,7 @@ export namespace discoveryengine_v1 {
57930
57998
  * // "isPinned": false,
57931
57999
  * // "labels": [],
57932
58000
  * // "name": "my_name",
58001
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
57933
58002
  * // "startTime": "my_startTime",
57934
58003
  * // "state": "my_state",
57935
58004
  * // "turns": [],
@@ -57946,6 +58015,7 @@ export namespace discoveryengine_v1 {
57946
58015
  * // "isPinned": false,
57947
58016
  * // "labels": [],
57948
58017
  * // "name": "my_name",
58018
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
57949
58019
  * // "startTime": "my_startTime",
57950
58020
  * // "state": "my_state",
57951
58021
  * // "turns": [],
@@ -58095,7 +58165,7 @@ export namespace discoveryengine_v1 {
58095
58165
  */
58096
58166
  filter?: string;
58097
58167
  /**
58098
- * 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.
58168
+ * 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.
58099
58169
  */
58100
58170
  orderBy?: string;
58101
58171
  /**
@@ -64077,6 +64147,165 @@ export namespace discoveryengine_v1 {
64077
64147
  }
64078
64148
  }
64079
64149
 
64150
+ /**
64151
+ * Lists all the LicenseConfigs associated with the project.
64152
+ * @example
64153
+ * ```js
64154
+ * // Before running the sample:
64155
+ * // - Enable the API at:
64156
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
64157
+ * // - Login into gcloud by running:
64158
+ * // ```sh
64159
+ * // $ gcloud auth application-default login
64160
+ * // ```
64161
+ * // - Install the npm module by running:
64162
+ * // ```sh
64163
+ * // $ npm install googleapis
64164
+ * // ```
64165
+ *
64166
+ * const {google} = require('googleapis');
64167
+ * const discoveryengine = google.discoveryengine('v1');
64168
+ *
64169
+ * async function main() {
64170
+ * const auth = new google.auth.GoogleAuth({
64171
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
64172
+ * scopes: [
64173
+ * 'https://www.googleapis.com/auth/cloud-platform',
64174
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
64175
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
64176
+ * ],
64177
+ * });
64178
+ *
64179
+ * // Acquire an auth client, and bind it to all future calls
64180
+ * const authClient = await auth.getClient();
64181
+ * google.options({auth: authClient});
64182
+ *
64183
+ * // Do the magic
64184
+ * const res = await discoveryengine.projects.locations.licenseConfigs.list({
64185
+ * // 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.
64186
+ * filter: 'placeholder-value',
64187
+ * // Optional. Not supported.
64188
+ * pageSize: 'placeholder-value',
64189
+ * // Optional. Not supported.
64190
+ * pageToken: 'placeholder-value',
64191
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
64192
+ * parent: 'projects/my-project/locations/my-location',
64193
+ * });
64194
+ * console.log(res.data);
64195
+ *
64196
+ * // Example response
64197
+ * // {
64198
+ * // "licenseConfigs": [],
64199
+ * // "nextPageToken": "my_nextPageToken"
64200
+ * // }
64201
+ * }
64202
+ *
64203
+ * main().catch(e => {
64204
+ * console.error(e);
64205
+ * throw e;
64206
+ * });
64207
+ *
64208
+ * ```
64209
+ *
64210
+ * @param params - Parameters for request
64211
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
64212
+ * @param callback - Optional callback that handles the response.
64213
+ * @returns A promise if used with async/await, or void if used with a callback.
64214
+ */
64215
+ list(
64216
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
64217
+ options: StreamMethodOptions
64218
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
64219
+ list(
64220
+ params?: Params$Resource$Projects$Locations$Licenseconfigs$List,
64221
+ options?: MethodOptions
64222
+ ): Promise<
64223
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64224
+ >;
64225
+ list(
64226
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
64227
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
64228
+ callback: BodyResponseCallback<Readable>
64229
+ ): void;
64230
+ list(
64231
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
64232
+ options:
64233
+ | MethodOptions
64234
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>,
64235
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64236
+ ): void;
64237
+ list(
64238
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
64239
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64240
+ ): void;
64241
+ list(
64242
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64243
+ ): void;
64244
+ list(
64245
+ paramsOrCallback?:
64246
+ | Params$Resource$Projects$Locations$Licenseconfigs$List
64247
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64248
+ | BodyResponseCallback<Readable>,
64249
+ optionsOrCallback?:
64250
+ | MethodOptions
64251
+ | StreamMethodOptions
64252
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64253
+ | BodyResponseCallback<Readable>,
64254
+ callback?:
64255
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64256
+ | BodyResponseCallback<Readable>
64257
+ ):
64258
+ | void
64259
+ | Promise<
64260
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>
64261
+ >
64262
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
64263
+ let params = (paramsOrCallback ||
64264
+ {}) as Params$Resource$Projects$Locations$Licenseconfigs$List;
64265
+ let options = (optionsOrCallback || {}) as MethodOptions;
64266
+
64267
+ if (typeof paramsOrCallback === 'function') {
64268
+ callback = paramsOrCallback;
64269
+ params = {} as Params$Resource$Projects$Locations$Licenseconfigs$List;
64270
+ options = {};
64271
+ }
64272
+
64273
+ if (typeof optionsOrCallback === 'function') {
64274
+ callback = optionsOrCallback;
64275
+ options = {};
64276
+ }
64277
+
64278
+ const rootUrl =
64279
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
64280
+ const parameters = {
64281
+ options: Object.assign(
64282
+ {
64283
+ url: (rootUrl + '/v1/{+parent}/licenseConfigs').replace(
64284
+ /([^:]\/)\/+/g,
64285
+ '$1'
64286
+ ),
64287
+ method: 'GET',
64288
+ apiVersion: '',
64289
+ },
64290
+ options
64291
+ ),
64292
+ params,
64293
+ requiredParams: ['parent'],
64294
+ pathParams: ['parent'],
64295
+ context: this.context,
64296
+ };
64297
+ if (callback) {
64298
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>(
64299
+ parameters,
64300
+ callback as BodyResponseCallback<unknown>
64301
+ );
64302
+ } else {
64303
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>(
64304
+ parameters
64305
+ );
64306
+ }
64307
+ }
64308
+
64080
64309
  /**
64081
64310
  * Updates the LicenseConfig
64082
64311
  * @example
@@ -64280,6 +64509,24 @@ export namespace discoveryengine_v1 {
64280
64509
  */
64281
64510
  name?: string;
64282
64511
  }
64512
+ export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
64513
+ /**
64514
+ * 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.
64515
+ */
64516
+ filter?: string;
64517
+ /**
64518
+ * Optional. Not supported.
64519
+ */
64520
+ pageSize?: number;
64521
+ /**
64522
+ * Optional. Not supported.
64523
+ */
64524
+ pageToken?: string;
64525
+ /**
64526
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
64527
+ */
64528
+ parent?: string;
64529
+ }
64283
64530
  export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
64284
64531
  /**
64285
64532
  * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`