@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.
@@ -4142,6 +4142,10 @@ export declare namespace discoveryengine_v1alpha {
4142
4142
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
4143
4143
  */
4144
4144
  connectorModes?: string[] | null;
4145
+ /**
4146
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
4147
+ */
4148
+ connectorSourceId?: string | null;
4145
4149
  /**
4146
4150
  * 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.
4147
4151
  */
@@ -5300,7 +5304,7 @@ export declare namespace discoveryengine_v1alpha {
5300
5304
  */
5301
5305
  displayName?: string | null;
5302
5306
  /**
5303
- * 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`
5307
+ * 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`
5304
5308
  */
5305
5309
  features?: {
5306
5310
  [key: string]: string;
@@ -5754,6 +5758,10 @@ export declare namespace discoveryengine_v1alpha {
5754
5758
  * Metadata corresponding to the external user.
5755
5759
  */
5756
5760
  groupMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata;
5761
+ /**
5762
+ * Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings.
5763
+ */
5764
+ subject?: string | null;
5757
5765
  /**
5758
5766
  * Metadata corresponding to the external user.
5759
5767
  */
@@ -5777,7 +5785,7 @@ export declare namespace discoveryengine_v1alpha {
5777
5785
  */
5778
5786
  givenName?: string | null;
5779
5787
  /**
5780
- * The user's primary email address.
5788
+ * The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject.
5781
5789
  */
5782
5790
  primaryEmail?: string | null;
5783
5791
  }
@@ -5921,7 +5929,7 @@ export declare namespace discoveryengine_v1alpha {
5921
5929
  */
5922
5930
  schemaOrgPaths?: string[] | null;
5923
5931
  /**
5924
- * 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`.
5932
+ * 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).
5925
5933
  */
5926
5934
  searchableFieldImportance?: string | null;
5927
5935
  /**
@@ -7099,6 +7107,19 @@ export declare namespace discoveryengine_v1alpha {
7099
7107
  */
7100
7108
  nextPageToken?: string | null;
7101
7109
  }
7110
+ /**
7111
+ * Response message for LicenseConfigService.ListLicenseConfigs method.
7112
+ */
7113
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse {
7114
+ /**
7115
+ * All the customer's LicenseConfigs.
7116
+ */
7117
+ licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig[];
7118
+ /**
7119
+ * Not supported.
7120
+ */
7121
+ nextPageToken?: string | null;
7122
+ }
7102
7123
  /**
7103
7124
  * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
7104
7125
  */
@@ -7169,7 +7190,7 @@ export declare namespace discoveryengine_v1alpha {
7169
7190
  */
7170
7191
  filter?: string | null;
7171
7192
  /**
7172
- * 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.
7193
+ * 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.
7173
7194
  */
7174
7195
  orderBy?: string | null;
7175
7196
  /**
@@ -7869,6 +7890,10 @@ export declare namespace discoveryengine_v1alpha {
7869
7890
  * Defines a user inputed query.
7870
7891
  */
7871
7892
  export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
7893
+ /**
7894
+ * Output only. The time at which the server accepted this query.
7895
+ */
7896
+ createTime?: string | null;
7872
7897
  /**
7873
7898
  * Query content parts.
7874
7899
  */
@@ -8860,7 +8885,7 @@ export declare namespace discoveryengine_v1alpha {
8860
8885
  */
8861
8886
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
8862
8887
  /**
8863
- * 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
8888
+ * 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
8864
8889
  */
8865
8890
  rankingExpression?: string | null;
8866
8891
  /**
@@ -10137,6 +10162,10 @@ export declare namespace discoveryengine_v1alpha {
10137
10162
  * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
10138
10163
  */
10139
10164
  name?: string | null;
10165
+ /**
10166
+ * 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.
10167
+ */
10168
+ pendingAsyncAssistOperationId?: string | null;
10140
10169
  /**
10141
10170
  * Output only. The time the session started.
10142
10171
  */
@@ -10505,11 +10534,28 @@ export declare namespace discoveryengine_v1alpha {
10505
10534
  * The tool names of the tools that were invoked.
10506
10535
  */
10507
10536
  invocationTools?: string[] | null;
10537
+ /**
10538
+ * The skills executed during the turn.
10539
+ */
10540
+ invokedSkills?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill[];
10508
10541
  /**
10509
10542
  * Session information. Only included in the final StreamAssistResponse of the response stream.
10510
10543
  */
10511
10544
  sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
10512
10545
  }
10546
+ /**
10547
+ * Represents a skill used during the assist call.
10548
+ */
10549
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill {
10550
+ /**
10551
+ * The display name of the skill.
10552
+ */
10553
+ displayName?: string | null;
10554
+ /**
10555
+ * The resource name of the skill.
10556
+ */
10557
+ name?: string | null;
10558
+ }
10513
10559
  /**
10514
10560
  * Information about the session.
10515
10561
  */
@@ -11499,7 +11545,7 @@ export declare namespace discoveryengine_v1alpha {
11499
11545
  */
11500
11546
  enableVisualContentSummary?: boolean | null;
11501
11547
  /**
11502
- * 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`
11548
+ * 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`
11503
11549
  */
11504
11550
  features?: {
11505
11551
  [key: string]: string;
@@ -11594,7 +11640,7 @@ export declare namespace discoveryengine_v1alpha {
11594
11640
  */
11595
11641
  export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
11596
11642
  /**
11597
- * Obfuscated Dasher customer ID.
11643
+ * 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.
11598
11644
  */
11599
11645
  dasherCustomerId?: string | null;
11600
11646
  /**
@@ -12831,7 +12877,7 @@ export declare namespace discoveryengine_v1alpha {
12831
12877
  */
12832
12878
  displayName?: string | null;
12833
12879
  /**
12834
- * 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`
12880
+ * 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`
12835
12881
  */
12836
12882
  features?: {
12837
12883
  [key: string]: string;
@@ -13987,7 +14033,7 @@ export declare namespace discoveryengine_v1alpha {
13987
14033
  */
13988
14034
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
13989
14035
  /**
13990
- * 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
14036
+ * 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
13991
14037
  */
13992
14038
  rankingExpression?: string | null;
13993
14039
  /**
@@ -14845,7 +14891,7 @@ export declare namespace discoveryengine_v1alpha {
14845
14891
  */
14846
14892
  export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
14847
14893
  /**
14848
- * Obfuscated Dasher customer ID.
14894
+ * 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.
14849
14895
  */
14850
14896
  dasherCustomerId?: string | null;
14851
14897
  /**
@@ -15224,6 +15270,10 @@ export declare namespace discoveryengine_v1alpha {
15224
15270
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
15225
15271
  */
15226
15272
  connectorModes?: string[] | null;
15273
+ /**
15274
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
15275
+ */
15276
+ connectorSourceId?: string | null;
15227
15277
  /**
15228
15278
  * 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.
15229
15279
  */
@@ -16074,7 +16124,7 @@ export declare namespace discoveryengine_v1alpha {
16074
16124
  */
16075
16125
  displayName?: string | null;
16076
16126
  /**
16077
- * 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`
16127
+ * 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`
16078
16128
  */
16079
16129
  features?: {
16080
16130
  [key: string]: string;
@@ -17441,7 +17491,7 @@ export declare namespace discoveryengine_v1alpha {
17441
17491
  */
17442
17492
  export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
17443
17493
  /**
17444
- * Obfuscated Dasher customer ID.
17494
+ * 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.
17445
17495
  */
17446
17496
  dasherCustomerId?: string | null;
17447
17497
  /**
@@ -19830,6 +19880,7 @@ export declare namespace discoveryengine_v1alpha {
19830
19880
  * // "blockingReasons": [],
19831
19881
  * // "cliConfig": {},
19832
19882
  * // "connectorModes": [],
19883
+ * // "connectorSourceId": "my_connectorSourceId",
19833
19884
  * // "connectorType": "my_connectorType",
19834
19885
  * // "createEuaSaas": false,
19835
19886
  * // "createTime": "my_createTime",
@@ -21152,6 +21203,7 @@ export declare namespace discoveryengine_v1alpha {
21152
21203
  * // "blockingReasons": [],
21153
21204
  * // "cliConfig": {},
21154
21205
  * // "connectorModes": [],
21206
+ * // "connectorSourceId": "my_connectorSourceId",
21155
21207
  * // "connectorType": "my_connectorType",
21156
21208
  * // "createEuaSaas": false,
21157
21209
  * // "createTime": "my_createTime",
@@ -21415,6 +21467,7 @@ export declare namespace discoveryengine_v1alpha {
21415
21467
  * // "blockingReasons": [],
21416
21468
  * // "cliConfig": {},
21417
21469
  * // "connectorModes": [],
21470
+ * // "connectorSourceId": "my_connectorSourceId",
21418
21471
  * // "connectorType": "my_connectorType",
21419
21472
  * // "createEuaSaas": false,
21420
21473
  * // "createTime": "my_createTime",
@@ -21466,6 +21519,7 @@ export declare namespace discoveryengine_v1alpha {
21466
21519
  * // "blockingReasons": [],
21467
21520
  * // "cliConfig": {},
21468
21521
  * // "connectorModes": [],
21522
+ * // "connectorSourceId": "my_connectorSourceId",
21469
21523
  * // "connectorType": "my_connectorType",
21470
21524
  * // "createEuaSaas": false,
21471
21525
  * // "createTime": "my_createTime",
@@ -28683,6 +28737,7 @@ export declare namespace discoveryengine_v1alpha {
28683
28737
  * // "isPinned": false,
28684
28738
  * // "labels": [],
28685
28739
  * // "name": "my_name",
28740
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
28686
28741
  * // "startTime": "my_startTime",
28687
28742
  * // "state": "my_state",
28688
28743
  * // "turns": [],
@@ -28700,6 +28755,7 @@ export declare namespace discoveryengine_v1alpha {
28700
28755
  * // "isPinned": false,
28701
28756
  * // "labels": [],
28702
28757
  * // "name": "my_name",
28758
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
28703
28759
  * // "startTime": "my_startTime",
28704
28760
  * // "state": "my_state",
28705
28761
  * // "turns": [],
@@ -28844,6 +28900,7 @@ export declare namespace discoveryengine_v1alpha {
28844
28900
  * // "isPinned": false,
28845
28901
  * // "labels": [],
28846
28902
  * // "name": "my_name",
28903
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
28847
28904
  * // "startTime": "my_startTime",
28848
28905
  * // "state": "my_state",
28849
28906
  * // "turns": [],
@@ -28909,7 +28966,7 @@ export declare namespace discoveryengine_v1alpha {
28909
28966
  * {
28910
28967
  * // 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"`
28911
28968
  * filter: 'placeholder-value',
28912
- * // 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.
28969
+ * // 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.
28913
28970
  * orderBy: 'placeholder-value',
28914
28971
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
28915
28972
  * pageSize: 'placeholder-value',
@@ -28999,6 +29056,7 @@ export declare namespace discoveryengine_v1alpha {
28999
29056
  * // "isPinned": false,
29000
29057
  * // "labels": [],
29001
29058
  * // "name": "my_name",
29059
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
29002
29060
  * // "startTime": "my_startTime",
29003
29061
  * // "state": "my_state",
29004
29062
  * // "turns": [],
@@ -29016,6 +29074,7 @@ export declare namespace discoveryengine_v1alpha {
29016
29074
  * // "isPinned": false,
29017
29075
  * // "labels": [],
29018
29076
  * // "name": "my_name",
29077
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
29019
29078
  * // "startTime": "my_startTime",
29020
29079
  * // "state": "my_state",
29021
29080
  * // "turns": [],
@@ -29078,7 +29137,7 @@ export declare namespace discoveryengine_v1alpha {
29078
29137
  */
29079
29138
  filter?: string;
29080
29139
  /**
29081
- * 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.
29140
+ * 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.
29082
29141
  */
29083
29142
  orderBy?: string;
29084
29143
  /**
@@ -32669,7 +32728,7 @@ export declare namespace discoveryengine_v1alpha {
32669
32728
  resume(params: Params$Resource$Projects$Locations$Collections$Engines$Resume, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
32670
32729
  resume(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaEngine>): void;
32671
32730
  /**
32672
- * 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.
32731
+ * 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.
32673
32732
  * @example
32674
32733
  * ```js
32675
32734
  * // Before running the sample:
@@ -33678,6 +33737,7 @@ export declare namespace discoveryengine_v1alpha {
33678
33737
  * // "answer": {},
33679
33738
  * // "assistToken": "my_assistToken",
33680
33739
  * // "invocationTools": [],
33740
+ * // "invokedSkills": [],
33681
33741
  * // "sessionInfo": {}
33682
33742
  * // }
33683
33743
  * }
@@ -37497,6 +37557,7 @@ export declare namespace discoveryengine_v1alpha {
37497
37557
  * // "isPinned": false,
37498
37558
  * // "labels": [],
37499
37559
  * // "name": "my_name",
37560
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
37500
37561
  * // "startTime": "my_startTime",
37501
37562
  * // "state": "my_state",
37502
37563
  * // "turns": [],
@@ -37514,6 +37575,7 @@ export declare namespace discoveryengine_v1alpha {
37514
37575
  * // "isPinned": false,
37515
37576
  * // "labels": [],
37516
37577
  * // "name": "my_name",
37578
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
37517
37579
  * // "startTime": "my_startTime",
37518
37580
  * // "state": "my_state",
37519
37581
  * // "turns": [],
@@ -37656,6 +37718,7 @@ export declare namespace discoveryengine_v1alpha {
37656
37718
  * // "isPinned": false,
37657
37719
  * // "labels": [],
37658
37720
  * // "name": "my_name",
37721
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
37659
37722
  * // "startTime": "my_startTime",
37660
37723
  * // "state": "my_state",
37661
37724
  * // "turns": [],
@@ -37720,7 +37783,7 @@ export declare namespace discoveryengine_v1alpha {
37720
37783
  * await discoveryengine.projects.locations.collections.engines.sessions.list({
37721
37784
  * // 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"`
37722
37785
  * filter: 'placeholder-value',
37723
- * // 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.
37786
+ * // 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.
37724
37787
  * orderBy: 'placeholder-value',
37725
37788
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
37726
37789
  * pageSize: 'placeholder-value',
@@ -37809,6 +37872,7 @@ export declare namespace discoveryengine_v1alpha {
37809
37872
  * // "isPinned": false,
37810
37873
  * // "labels": [],
37811
37874
  * // "name": "my_name",
37875
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
37812
37876
  * // "startTime": "my_startTime",
37813
37877
  * // "state": "my_state",
37814
37878
  * // "turns": [],
@@ -37826,6 +37890,7 @@ export declare namespace discoveryengine_v1alpha {
37826
37890
  * // "isPinned": false,
37827
37891
  * // "labels": [],
37828
37892
  * // "name": "my_name",
37893
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
37829
37894
  * // "startTime": "my_startTime",
37830
37895
  * // "state": "my_state",
37831
37896
  * // "turns": [],
@@ -37888,7 +37953,7 @@ export declare namespace discoveryengine_v1alpha {
37888
37953
  */
37889
37954
  filter?: string;
37890
37955
  /**
37891
- * 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.
37956
+ * 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.
37892
37957
  */
37893
37958
  orderBy?: string;
37894
37959
  /**
@@ -44688,6 +44753,7 @@ export declare namespace discoveryengine_v1alpha {
44688
44753
  * // "isPinned": false,
44689
44754
  * // "labels": [],
44690
44755
  * // "name": "my_name",
44756
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
44691
44757
  * // "startTime": "my_startTime",
44692
44758
  * // "state": "my_state",
44693
44759
  * // "turns": [],
@@ -44704,6 +44770,7 @@ export declare namespace discoveryengine_v1alpha {
44704
44770
  * // "isPinned": false,
44705
44771
  * // "labels": [],
44706
44772
  * // "name": "my_name",
44773
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
44707
44774
  * // "startTime": "my_startTime",
44708
44775
  * // "state": "my_state",
44709
44776
  * // "turns": [],
@@ -44843,6 +44910,7 @@ export declare namespace discoveryengine_v1alpha {
44843
44910
  * // "isPinned": false,
44844
44911
  * // "labels": [],
44845
44912
  * // "name": "my_name",
44913
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
44846
44914
  * // "startTime": "my_startTime",
44847
44915
  * // "state": "my_state",
44848
44916
  * // "turns": [],
@@ -44907,7 +44975,7 @@ export declare namespace discoveryengine_v1alpha {
44907
44975
  * {
44908
44976
  * // 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"`
44909
44977
  * filter: 'placeholder-value',
44910
- * // 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.
44978
+ * // 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.
44911
44979
  * orderBy: 'placeholder-value',
44912
44980
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
44913
44981
  * pageSize: 'placeholder-value',
@@ -44996,6 +45064,7 @@ export declare namespace discoveryengine_v1alpha {
44996
45064
  * // "isPinned": false,
44997
45065
  * // "labels": [],
44998
45066
  * // "name": "my_name",
45067
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
44999
45068
  * // "startTime": "my_startTime",
45000
45069
  * // "state": "my_state",
45001
45070
  * // "turns": [],
@@ -45012,6 +45081,7 @@ export declare namespace discoveryengine_v1alpha {
45012
45081
  * // "isPinned": false,
45013
45082
  * // "labels": [],
45014
45083
  * // "name": "my_name",
45084
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
45015
45085
  * // "startTime": "my_startTime",
45016
45086
  * // "state": "my_state",
45017
45087
  * // "turns": [],
@@ -45074,7 +45144,7 @@ export declare namespace discoveryengine_v1alpha {
45074
45144
  */
45075
45145
  filter?: string;
45076
45146
  /**
45077
- * 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.
45147
+ * 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.
45078
45148
  */
45079
45149
  orderBy?: string;
45080
45150
  /**
@@ -48628,6 +48698,77 @@ export declare namespace discoveryengine_v1alpha {
48628
48698
  get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig>): void;
48629
48699
  get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig>): void;
48630
48700
  get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig>): void;
48701
+ /**
48702
+ * Lists all the LicenseConfigs associated with the project.
48703
+ * @example
48704
+ * ```js
48705
+ * // Before running the sample:
48706
+ * // - Enable the API at:
48707
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
48708
+ * // - Login into gcloud by running:
48709
+ * // ```sh
48710
+ * // $ gcloud auth application-default login
48711
+ * // ```
48712
+ * // - Install the npm module by running:
48713
+ * // ```sh
48714
+ * // $ npm install googleapis
48715
+ * // ```
48716
+ *
48717
+ * const {google} = require('googleapis');
48718
+ * const discoveryengine = google.discoveryengine('v1alpha');
48719
+ *
48720
+ * async function main() {
48721
+ * const auth = new google.auth.GoogleAuth({
48722
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
48723
+ * scopes: [
48724
+ * 'https://www.googleapis.com/auth/cloud-platform',
48725
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
48726
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
48727
+ * ],
48728
+ * });
48729
+ *
48730
+ * // Acquire an auth client, and bind it to all future calls
48731
+ * const authClient = await auth.getClient();
48732
+ * google.options({auth: authClient});
48733
+ *
48734
+ * // Do the magic
48735
+ * const res = await discoveryengine.projects.locations.licenseConfigs.list({
48736
+ * // 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.
48737
+ * filter: 'placeholder-value',
48738
+ * // Optional. Not supported.
48739
+ * pageSize: 'placeholder-value',
48740
+ * // Optional. Not supported.
48741
+ * pageToken: 'placeholder-value',
48742
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
48743
+ * parent: 'projects/my-project/locations/my-location',
48744
+ * });
48745
+ * console.log(res.data);
48746
+ *
48747
+ * // Example response
48748
+ * // {
48749
+ * // "licenseConfigs": [],
48750
+ * // "nextPageToken": "my_nextPageToken"
48751
+ * // }
48752
+ * }
48753
+ *
48754
+ * main().catch(e => {
48755
+ * console.error(e);
48756
+ * throw e;
48757
+ * });
48758
+ *
48759
+ * ```
48760
+ *
48761
+ * @param params - Parameters for request
48762
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
48763
+ * @param callback - Optional callback that handles the response.
48764
+ * @returns A promise if used with async/await, or void if used with a callback.
48765
+ */
48766
+ list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
48767
+ list(params?: Params$Resource$Projects$Locations$Licenseconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>>;
48768
+ list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
48769
+ list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>): void;
48770
+ list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>): void;
48771
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>): void;
48631
48772
  /**
48632
48773
  * Updates the LicenseConfig
48633
48774
  * @example
@@ -48747,6 +48888,24 @@ export declare namespace discoveryengine_v1alpha {
48747
48888
  */
48748
48889
  name?: string;
48749
48890
  }
48891
+ export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
48892
+ /**
48893
+ * 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.
48894
+ */
48895
+ filter?: string;
48896
+ /**
48897
+ * Optional. Not supported.
48898
+ */
48899
+ pageSize?: number;
48900
+ /**
48901
+ * Optional. Not supported.
48902
+ */
48903
+ pageToken?: string;
48904
+ /**
48905
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
48906
+ */
48907
+ parent?: string;
48908
+ }
48750
48909
  export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
48751
48910
  /**
48752
48911
  * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
package/build/v1alpha.js CHANGED
@@ -11339,6 +11339,38 @@ var discoveryengine_v1alpha;
11339
11339
  return (0, googleapis_common_1.createAPIRequest)(parameters);
11340
11340
  }
11341
11341
  }
11342
+ list(paramsOrCallback, optionsOrCallback, callback) {
11343
+ let params = (paramsOrCallback ||
11344
+ {});
11345
+ let options = (optionsOrCallback || {});
11346
+ if (typeof paramsOrCallback === 'function') {
11347
+ callback = paramsOrCallback;
11348
+ params = {};
11349
+ options = {};
11350
+ }
11351
+ if (typeof optionsOrCallback === 'function') {
11352
+ callback = optionsOrCallback;
11353
+ options = {};
11354
+ }
11355
+ const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
11356
+ const parameters = {
11357
+ options: Object.assign({
11358
+ url: (rootUrl + '/v1alpha/{+parent}/licenseConfigs').replace(/([^:]\/)\/+/g, '$1'),
11359
+ method: 'GET',
11360
+ apiVersion: '',
11361
+ }, options),
11362
+ params,
11363
+ requiredParams: ['parent'],
11364
+ pathParams: ['parent'],
11365
+ context: this.context,
11366
+ };
11367
+ if (callback) {
11368
+ (0, googleapis_common_1.createAPIRequest)(parameters, callback);
11369
+ }
11370
+ else {
11371
+ return (0, googleapis_common_1.createAPIRequest)(parameters);
11372
+ }
11373
+ }
11342
11374
  patch(paramsOrCallback, optionsOrCallback, callback) {
11343
11375
  let params = (paramsOrCallback ||
11344
11376
  {});