@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/v1alpha.ts CHANGED
@@ -4155,6 +4155,10 @@ export namespace discoveryengine_v1alpha {
4155
4155
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
4156
4156
  */
4157
4157
  connectorModes?: string[] | null;
4158
+ /**
4159
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
4160
+ */
4161
+ connectorSourceId?: string | null;
4158
4162
  /**
4159
4163
  * 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.
4160
4164
  */
@@ -5288,7 +5292,7 @@ export namespace discoveryengine_v1alpha {
5288
5292
  */
5289
5293
  displayName?: string | null;
5290
5294
  /**
5291
- * 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`
5295
+ * 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`
5292
5296
  */
5293
5297
  features?: {[key: string]: string} | null;
5294
5298
  /**
@@ -5736,6 +5740,10 @@ export namespace discoveryengine_v1alpha {
5736
5740
  * Metadata corresponding to the external user.
5737
5741
  */
5738
5742
  groupMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaExternalIdentityGroupMetadata;
5743
+ /**
5744
+ * 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.
5745
+ */
5746
+ subject?: string | null;
5739
5747
  /**
5740
5748
  * Metadata corresponding to the external user.
5741
5749
  */
@@ -5758,7 +5766,7 @@ export namespace discoveryengine_v1alpha {
5758
5766
  */
5759
5767
  givenName?: string | null;
5760
5768
  /**
5761
- * The user's primary email address.
5769
+ * The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject.
5762
5770
  */
5763
5771
  primaryEmail?: string | null;
5764
5772
  }
@@ -5900,7 +5908,7 @@ export namespace discoveryengine_v1alpha {
5900
5908
  */
5901
5909
  schemaOrgPaths?: string[] | null;
5902
5910
  /**
5903
- * 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`.
5911
+ * 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).
5904
5912
  */
5905
5913
  searchableFieldImportance?: string | null;
5906
5914
  /**
@@ -7068,6 +7076,19 @@ export namespace discoveryengine_v1alpha {
7068
7076
  */
7069
7077
  nextPageToken?: string | null;
7070
7078
  }
7079
+ /**
7080
+ * Response message for LicenseConfigService.ListLicenseConfigs method.
7081
+ */
7082
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse {
7083
+ /**
7084
+ * All the customer's LicenseConfigs.
7085
+ */
7086
+ licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaLicenseConfig[];
7087
+ /**
7088
+ * Not supported.
7089
+ */
7090
+ nextPageToken?: string | null;
7091
+ }
7071
7092
  /**
7072
7093
  * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
7073
7094
  */
@@ -7138,7 +7159,7 @@ export namespace discoveryengine_v1alpha {
7138
7159
  */
7139
7160
  filter?: string | null;
7140
7161
  /**
7141
- * 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.
7162
+ * 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.
7142
7163
  */
7143
7164
  orderBy?: string | null;
7144
7165
  /**
@@ -7835,6 +7856,10 @@ export namespace discoveryengine_v1alpha {
7835
7856
  * Defines a user inputed query.
7836
7857
  */
7837
7858
  export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
7859
+ /**
7860
+ * Output only. The time at which the server accepted this query.
7861
+ */
7862
+ createTime?: string | null;
7838
7863
  /**
7839
7864
  * Query content parts.
7840
7865
  */
@@ -8812,7 +8837,7 @@ export namespace discoveryengine_v1alpha {
8812
8837
  */
8813
8838
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
8814
8839
  /**
8815
- * 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
8840
+ * 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
8816
8841
  */
8817
8842
  rankingExpression?: string | null;
8818
8843
  /**
@@ -10087,6 +10112,10 @@ export namespace discoveryengine_v1alpha {
10087
10112
  * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
10088
10113
  */
10089
10114
  name?: string | null;
10115
+ /**
10116
+ * 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.
10117
+ */
10118
+ pendingAsyncAssistOperationId?: string | null;
10090
10119
  /**
10091
10120
  * Output only. The time the session started.
10092
10121
  */
@@ -10442,11 +10471,28 @@ export namespace discoveryengine_v1alpha {
10442
10471
  * The tool names of the tools that were invoked.
10443
10472
  */
10444
10473
  invocationTools?: string[] | null;
10474
+ /**
10475
+ * The skills executed during the turn.
10476
+ */
10477
+ invokedSkills?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill[];
10445
10478
  /**
10446
10479
  * Session information. Only included in the final StreamAssistResponse of the response stream.
10447
10480
  */
10448
10481
  sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo;
10449
10482
  }
10483
+ /**
10484
+ * Represents a skill used during the assist call.
10485
+ */
10486
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaStreamAssistResponseInvokedSkill {
10487
+ /**
10488
+ * The display name of the skill.
10489
+ */
10490
+ displayName?: string | null;
10491
+ /**
10492
+ * The resource name of the skill.
10493
+ */
10494
+ name?: string | null;
10495
+ }
10450
10496
  /**
10451
10497
  * Information about the session.
10452
10498
  */
@@ -11432,7 +11478,7 @@ export namespace discoveryengine_v1alpha {
11432
11478
  */
11433
11479
  enableVisualContentSummary?: boolean | null;
11434
11480
  /**
11435
- * 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`
11481
+ * 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`
11436
11482
  */
11437
11483
  features?: {[key: string]: string} | null;
11438
11484
  /**
@@ -11523,7 +11569,7 @@ export namespace discoveryengine_v1alpha {
11523
11569
  */
11524
11570
  export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
11525
11571
  /**
11526
- * Obfuscated Dasher customer ID.
11572
+ * 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.
11527
11573
  */
11528
11574
  dasherCustomerId?: string | null;
11529
11575
  /**
@@ -12756,7 +12802,7 @@ export namespace discoveryengine_v1alpha {
12756
12802
  */
12757
12803
  displayName?: string | null;
12758
12804
  /**
12759
- * 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`
12805
+ * 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`
12760
12806
  */
12761
12807
  features?: {[key: string]: string} | null;
12762
12808
  /**
@@ -13903,7 +13949,7 @@ export namespace discoveryengine_v1alpha {
13903
13949
  */
13904
13950
  queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
13905
13951
  /**
13906
- * 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
13952
+ * 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
13907
13953
  */
13908
13954
  rankingExpression?: string | null;
13909
13955
  /**
@@ -14756,7 +14802,7 @@ export namespace discoveryengine_v1alpha {
14756
14802
  */
14757
14803
  export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
14758
14804
  /**
14759
- * Obfuscated Dasher customer ID.
14805
+ * 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.
14760
14806
  */
14761
14807
  dasherCustomerId?: string | null;
14762
14808
  /**
@@ -15135,6 +15181,10 @@ export namespace discoveryengine_v1alpha {
15135
15181
  * Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
15136
15182
  */
15137
15183
  connectorModes?: string[] | null;
15184
+ /**
15185
+ * Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
15186
+ */
15187
+ connectorSourceId?: string | null;
15138
15188
  /**
15139
15189
  * 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.
15140
15190
  */
@@ -15966,7 +16016,7 @@ export namespace discoveryengine_v1alpha {
15966
16016
  */
15967
16017
  displayName?: string | null;
15968
16018
  /**
15969
- * 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`
16019
+ * 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`
15970
16020
  */
15971
16021
  features?: {[key: string]: string} | null;
15972
16022
  /**
@@ -17323,7 +17373,7 @@ export namespace discoveryengine_v1alpha {
17323
17373
  */
17324
17374
  export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
17325
17375
  /**
17326
- * Obfuscated Dasher customer ID.
17376
+ * 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.
17327
17377
  */
17328
17378
  dasherCustomerId?: string | null;
17329
17379
  /**
@@ -21209,6 +21259,7 @@ export namespace discoveryengine_v1alpha {
21209
21259
  * // "blockingReasons": [],
21210
21260
  * // "cliConfig": {},
21211
21261
  * // "connectorModes": [],
21262
+ * // "connectorSourceId": "my_connectorSourceId",
21212
21263
  * // "connectorType": "my_connectorType",
21213
21264
  * // "createEuaSaas": false,
21214
21265
  * // "createTime": "my_createTime",
@@ -23727,6 +23778,7 @@ export namespace discoveryengine_v1alpha {
23727
23778
  * // "blockingReasons": [],
23728
23779
  * // "cliConfig": {},
23729
23780
  * // "connectorModes": [],
23781
+ * // "connectorSourceId": "my_connectorSourceId",
23730
23782
  * // "connectorType": "my_connectorType",
23731
23783
  * // "createEuaSaas": false,
23732
23784
  * // "createTime": "my_createTime",
@@ -24243,6 +24295,7 @@ export namespace discoveryengine_v1alpha {
24243
24295
  * // "blockingReasons": [],
24244
24296
  * // "cliConfig": {},
24245
24297
  * // "connectorModes": [],
24298
+ * // "connectorSourceId": "my_connectorSourceId",
24246
24299
  * // "connectorType": "my_connectorType",
24247
24300
  * // "createEuaSaas": false,
24248
24301
  * // "createTime": "my_createTime",
@@ -24294,6 +24347,7 @@ export namespace discoveryengine_v1alpha {
24294
24347
  * // "blockingReasons": [],
24295
24348
  * // "cliConfig": {},
24296
24349
  * // "connectorModes": [],
24350
+ * // "connectorSourceId": "my_connectorSourceId",
24297
24351
  * // "connectorType": "my_connectorType",
24298
24352
  * // "createEuaSaas": false,
24299
24353
  * // "createTime": "my_createTime",
@@ -38121,6 +38175,7 @@ export namespace discoveryengine_v1alpha {
38121
38175
  * // "isPinned": false,
38122
38176
  * // "labels": [],
38123
38177
  * // "name": "my_name",
38178
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
38124
38179
  * // "startTime": "my_startTime",
38125
38180
  * // "state": "my_state",
38126
38181
  * // "turns": [],
@@ -38138,6 +38193,7 @@ export namespace discoveryengine_v1alpha {
38138
38193
  * // "isPinned": false,
38139
38194
  * // "labels": [],
38140
38195
  * // "name": "my_name",
38196
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
38141
38197
  * // "startTime": "my_startTime",
38142
38198
  * // "state": "my_state",
38143
38199
  * // "turns": [],
@@ -38447,6 +38503,7 @@ export namespace discoveryengine_v1alpha {
38447
38503
  * // "isPinned": false,
38448
38504
  * // "labels": [],
38449
38505
  * // "name": "my_name",
38506
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
38450
38507
  * // "startTime": "my_startTime",
38451
38508
  * // "state": "my_state",
38452
38509
  * // "turns": [],
@@ -38598,7 +38655,7 @@ export namespace discoveryengine_v1alpha {
38598
38655
  * {
38599
38656
  * // 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"`
38600
38657
  * filter: 'placeholder-value',
38601
- * // 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.
38658
+ * // 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.
38602
38659
  * orderBy: 'placeholder-value',
38603
38660
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
38604
38661
  * pageSize: 'placeholder-value',
@@ -38777,6 +38834,7 @@ export namespace discoveryengine_v1alpha {
38777
38834
  * // "isPinned": false,
38778
38835
  * // "labels": [],
38779
38836
  * // "name": "my_name",
38837
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
38780
38838
  * // "startTime": "my_startTime",
38781
38839
  * // "state": "my_state",
38782
38840
  * // "turns": [],
@@ -38794,6 +38852,7 @@ export namespace discoveryengine_v1alpha {
38794
38852
  * // "isPinned": false,
38795
38853
  * // "labels": [],
38796
38854
  * // "name": "my_name",
38855
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
38797
38856
  * // "startTime": "my_startTime",
38798
38857
  * // "state": "my_state",
38799
38858
  * // "turns": [],
@@ -38943,7 +39002,7 @@ export namespace discoveryengine_v1alpha {
38943
39002
  */
38944
39003
  filter?: string;
38945
39004
  /**
38946
- * 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.
39005
+ * 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.
38947
39006
  */
38948
39007
  orderBy?: string;
38949
39008
  /**
@@ -45848,7 +45907,7 @@ export namespace discoveryengine_v1alpha {
45848
45907
  }
45849
45908
 
45850
45909
  /**
45851
- * 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.
45910
+ * 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.
45852
45911
  * @example
45853
45912
  * ```js
45854
45913
  * // Before running the sample:
@@ -47726,6 +47785,7 @@ export namespace discoveryengine_v1alpha {
47726
47785
  * // "answer": {},
47727
47786
  * // "assistToken": "my_assistToken",
47728
47787
  * // "invocationTools": [],
47788
+ * // "invokedSkills": [],
47729
47789
  * // "sessionInfo": {}
47730
47790
  * // }
47731
47791
  * }
@@ -54902,6 +54962,7 @@ export namespace discoveryengine_v1alpha {
54902
54962
  * // "isPinned": false,
54903
54963
  * // "labels": [],
54904
54964
  * // "name": "my_name",
54965
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
54905
54966
  * // "startTime": "my_startTime",
54906
54967
  * // "state": "my_state",
54907
54968
  * // "turns": [],
@@ -54919,6 +54980,7 @@ export namespace discoveryengine_v1alpha {
54919
54980
  * // "isPinned": false,
54920
54981
  * // "labels": [],
54921
54982
  * // "name": "my_name",
54983
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
54922
54984
  * // "startTime": "my_startTime",
54923
54985
  * // "state": "my_state",
54924
54986
  * // "turns": [],
@@ -55226,6 +55288,7 @@ export namespace discoveryengine_v1alpha {
55226
55288
  * // "isPinned": false,
55227
55289
  * // "labels": [],
55228
55290
  * // "name": "my_name",
55291
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
55229
55292
  * // "startTime": "my_startTime",
55230
55293
  * // "state": "my_state",
55231
55294
  * // "turns": [],
@@ -55376,7 +55439,7 @@ export namespace discoveryengine_v1alpha {
55376
55439
  * await discoveryengine.projects.locations.collections.engines.sessions.list({
55377
55440
  * // 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"`
55378
55441
  * filter: 'placeholder-value',
55379
- * // 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.
55442
+ * // 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.
55380
55443
  * orderBy: 'placeholder-value',
55381
55444
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
55382
55445
  * pageSize: 'placeholder-value',
@@ -55554,6 +55617,7 @@ export namespace discoveryengine_v1alpha {
55554
55617
  * // "isPinned": false,
55555
55618
  * // "labels": [],
55556
55619
  * // "name": "my_name",
55620
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
55557
55621
  * // "startTime": "my_startTime",
55558
55622
  * // "state": "my_state",
55559
55623
  * // "turns": [],
@@ -55571,6 +55635,7 @@ export namespace discoveryengine_v1alpha {
55571
55635
  * // "isPinned": false,
55572
55636
  * // "labels": [],
55573
55637
  * // "name": "my_name",
55638
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
55574
55639
  * // "startTime": "my_startTime",
55575
55640
  * // "state": "my_state",
55576
55641
  * // "turns": [],
@@ -55720,7 +55785,7 @@ export namespace discoveryengine_v1alpha {
55720
55785
  */
55721
55786
  filter?: string;
55722
55787
  /**
55723
- * 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.
55788
+ * 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.
55724
55789
  */
55725
55790
  orderBy?: string;
55726
55791
  /**
@@ -68662,6 +68727,7 @@ export namespace discoveryengine_v1alpha {
68662
68727
  * // "isPinned": false,
68663
68728
  * // "labels": [],
68664
68729
  * // "name": "my_name",
68730
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
68665
68731
  * // "startTime": "my_startTime",
68666
68732
  * // "state": "my_state",
68667
68733
  * // "turns": [],
@@ -68678,6 +68744,7 @@ export namespace discoveryengine_v1alpha {
68678
68744
  * // "isPinned": false,
68679
68745
  * // "labels": [],
68680
68746
  * // "name": "my_name",
68747
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
68681
68748
  * // "startTime": "my_startTime",
68682
68749
  * // "state": "my_state",
68683
68750
  * // "turns": [],
@@ -68982,6 +69049,7 @@ export namespace discoveryengine_v1alpha {
68982
69049
  * // "isPinned": false,
68983
69050
  * // "labels": [],
68984
69051
  * // "name": "my_name",
69052
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
68985
69053
  * // "startTime": "my_startTime",
68986
69054
  * // "state": "my_state",
68987
69055
  * // "turns": [],
@@ -69132,7 +69200,7 @@ export namespace discoveryengine_v1alpha {
69132
69200
  * {
69133
69201
  * // 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"`
69134
69202
  * filter: 'placeholder-value',
69135
- * // 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.
69203
+ * // 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.
69136
69204
  * orderBy: 'placeholder-value',
69137
69205
  * // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
69138
69206
  * pageSize: 'placeholder-value',
@@ -69310,6 +69378,7 @@ export namespace discoveryengine_v1alpha {
69310
69378
  * // "isPinned": false,
69311
69379
  * // "labels": [],
69312
69380
  * // "name": "my_name",
69381
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
69313
69382
  * // "startTime": "my_startTime",
69314
69383
  * // "state": "my_state",
69315
69384
  * // "turns": [],
@@ -69326,6 +69395,7 @@ export namespace discoveryengine_v1alpha {
69326
69395
  * // "isPinned": false,
69327
69396
  * // "labels": [],
69328
69397
  * // "name": "my_name",
69398
+ * // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
69329
69399
  * // "startTime": "my_startTime",
69330
69400
  * // "state": "my_state",
69331
69401
  * // "turns": [],
@@ -69475,7 +69545,7 @@ export namespace discoveryengine_v1alpha {
69475
69545
  */
69476
69546
  filter?: string;
69477
69547
  /**
69478
- * 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.
69548
+ * 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.
69479
69549
  */
69480
69550
  orderBy?: string;
69481
69551
  /**
@@ -76322,6 +76392,165 @@ export namespace discoveryengine_v1alpha {
76322
76392
  }
76323
76393
  }
76324
76394
 
76395
+ /**
76396
+ * Lists all the LicenseConfigs associated with the project.
76397
+ * @example
76398
+ * ```js
76399
+ * // Before running the sample:
76400
+ * // - Enable the API at:
76401
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
76402
+ * // - Login into gcloud by running:
76403
+ * // ```sh
76404
+ * // $ gcloud auth application-default login
76405
+ * // ```
76406
+ * // - Install the npm module by running:
76407
+ * // ```sh
76408
+ * // $ npm install googleapis
76409
+ * // ```
76410
+ *
76411
+ * const {google} = require('googleapis');
76412
+ * const discoveryengine = google.discoveryengine('v1alpha');
76413
+ *
76414
+ * async function main() {
76415
+ * const auth = new google.auth.GoogleAuth({
76416
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
76417
+ * scopes: [
76418
+ * 'https://www.googleapis.com/auth/cloud-platform',
76419
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
76420
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
76421
+ * ],
76422
+ * });
76423
+ *
76424
+ * // Acquire an auth client, and bind it to all future calls
76425
+ * const authClient = await auth.getClient();
76426
+ * google.options({auth: authClient});
76427
+ *
76428
+ * // Do the magic
76429
+ * const res = await discoveryengine.projects.locations.licenseConfigs.list({
76430
+ * // 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.
76431
+ * filter: 'placeholder-value',
76432
+ * // Optional. Not supported.
76433
+ * pageSize: 'placeholder-value',
76434
+ * // Optional. Not supported.
76435
+ * pageToken: 'placeholder-value',
76436
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
76437
+ * parent: 'projects/my-project/locations/my-location',
76438
+ * });
76439
+ * console.log(res.data);
76440
+ *
76441
+ * // Example response
76442
+ * // {
76443
+ * // "licenseConfigs": [],
76444
+ * // "nextPageToken": "my_nextPageToken"
76445
+ * // }
76446
+ * }
76447
+ *
76448
+ * main().catch(e => {
76449
+ * console.error(e);
76450
+ * throw e;
76451
+ * });
76452
+ *
76453
+ * ```
76454
+ *
76455
+ * @param params - Parameters for request
76456
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
76457
+ * @param callback - Optional callback that handles the response.
76458
+ * @returns A promise if used with async/await, or void if used with a callback.
76459
+ */
76460
+ list(
76461
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
76462
+ options: StreamMethodOptions
76463
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
76464
+ list(
76465
+ params?: Params$Resource$Projects$Locations$Licenseconfigs$List,
76466
+ options?: MethodOptions
76467
+ ): Promise<
76468
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76469
+ >;
76470
+ list(
76471
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
76472
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
76473
+ callback: BodyResponseCallback<Readable>
76474
+ ): void;
76475
+ list(
76476
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
76477
+ options:
76478
+ | MethodOptions
76479
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>,
76480
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76481
+ ): void;
76482
+ list(
76483
+ params: Params$Resource$Projects$Locations$Licenseconfigs$List,
76484
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76485
+ ): void;
76486
+ list(
76487
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76488
+ ): void;
76489
+ list(
76490
+ paramsOrCallback?:
76491
+ | Params$Resource$Projects$Locations$Licenseconfigs$List
76492
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76493
+ | BodyResponseCallback<Readable>,
76494
+ optionsOrCallback?:
76495
+ | MethodOptions
76496
+ | StreamMethodOptions
76497
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76498
+ | BodyResponseCallback<Readable>,
76499
+ callback?:
76500
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76501
+ | BodyResponseCallback<Readable>
76502
+ ):
76503
+ | void
76504
+ | Promise<
76505
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>
76506
+ >
76507
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
76508
+ let params = (paramsOrCallback ||
76509
+ {}) as Params$Resource$Projects$Locations$Licenseconfigs$List;
76510
+ let options = (optionsOrCallback || {}) as MethodOptions;
76511
+
76512
+ if (typeof paramsOrCallback === 'function') {
76513
+ callback = paramsOrCallback;
76514
+ params = {} as Params$Resource$Projects$Locations$Licenseconfigs$List;
76515
+ options = {};
76516
+ }
76517
+
76518
+ if (typeof optionsOrCallback === 'function') {
76519
+ callback = optionsOrCallback;
76520
+ options = {};
76521
+ }
76522
+
76523
+ const rootUrl =
76524
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
76525
+ const parameters = {
76526
+ options: Object.assign(
76527
+ {
76528
+ url: (rootUrl + '/v1alpha/{+parent}/licenseConfigs').replace(
76529
+ /([^:]\/)\/+/g,
76530
+ '$1'
76531
+ ),
76532
+ method: 'GET',
76533
+ apiVersion: '',
76534
+ },
76535
+ options
76536
+ ),
76537
+ params,
76538
+ requiredParams: ['parent'],
76539
+ pathParams: ['parent'],
76540
+ context: this.context,
76541
+ };
76542
+ if (callback) {
76543
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>(
76544
+ parameters,
76545
+ callback as BodyResponseCallback<unknown>
76546
+ );
76547
+ } else {
76548
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsResponse>(
76549
+ parameters
76550
+ );
76551
+ }
76552
+ }
76553
+
76325
76554
  /**
76326
76555
  * Updates the LicenseConfig
76327
76556
  * @example
@@ -76527,6 +76756,24 @@ export namespace discoveryengine_v1alpha {
76527
76756
  */
76528
76757
  name?: string;
76529
76758
  }
76759
+ export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
76760
+ /**
76761
+ * 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.
76762
+ */
76763
+ filter?: string;
76764
+ /**
76765
+ * Optional. Not supported.
76766
+ */
76767
+ pageSize?: number;
76768
+ /**
76769
+ * Optional. Not supported.
76770
+ */
76771
+ pageToken?: string;
76772
+ /**
76773
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
76774
+ */
76775
+ parent?: string;
76776
+ }
76530
76777
  export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
76531
76778
  /**
76532
76779
  * Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`