@googleapis/discoveryengine 29.0.0 → 30.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +178 -19
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +178 -19
- package/build/v1alpha.js +32 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +172 -17
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +266 -19
- package/v1alpha.ts +266 -19
- package/v1beta.ts +260 -17
package/build/v1.d.ts
CHANGED
|
@@ -2919,6 +2919,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
2919
2919
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
2920
2920
|
*/
|
|
2921
2921
|
connectorModes?: string[] | null;
|
|
2922
|
+
/**
|
|
2923
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
2924
|
+
*/
|
|
2925
|
+
connectorSourceId?: string | null;
|
|
2922
2926
|
/**
|
|
2923
2927
|
* 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.
|
|
2924
2928
|
*/
|
|
@@ -3868,7 +3872,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
3868
3872
|
*/
|
|
3869
3873
|
displayName?: string | null;
|
|
3870
3874
|
/**
|
|
3871
|
-
* 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`
|
|
3875
|
+
* 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`
|
|
3872
3876
|
*/
|
|
3873
3877
|
features?: {
|
|
3874
3878
|
[key: string]: string;
|
|
@@ -4294,7 +4298,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
4294
4298
|
*/
|
|
4295
4299
|
schemaOrgPaths?: string[] | null;
|
|
4296
4300
|
/**
|
|
4297
|
-
* 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`.
|
|
4301
|
+
* 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).
|
|
4298
4302
|
*/
|
|
4299
4303
|
searchableFieldImportance?: string | null;
|
|
4300
4304
|
/**
|
|
@@ -4705,7 +4709,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
4705
4709
|
*/
|
|
4706
4710
|
filter?: string | null;
|
|
4707
4711
|
/**
|
|
4708
|
-
* 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.
|
|
4712
|
+
* 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.
|
|
4709
4713
|
*/
|
|
4710
4714
|
orderBy?: string | null;
|
|
4711
4715
|
/**
|
|
@@ -5136,6 +5140,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
5136
5140
|
* Defines a user inputed query.
|
|
5137
5141
|
*/
|
|
5138
5142
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaQuery {
|
|
5143
|
+
/**
|
|
5144
|
+
* Output only. The time at which the server accepted this query.
|
|
5145
|
+
*/
|
|
5146
|
+
createTime?: string | null;
|
|
5139
5147
|
/**
|
|
5140
5148
|
* Query content parts.
|
|
5141
5149
|
*/
|
|
@@ -5609,7 +5617,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
5609
5617
|
*/
|
|
5610
5618
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec;
|
|
5611
5619
|
/**
|
|
5612
|
-
* 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
|
|
5620
|
+
* 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
|
|
5613
5621
|
*/
|
|
5614
5622
|
rankingExpression?: string | null;
|
|
5615
5623
|
/**
|
|
@@ -6190,6 +6198,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
6190
6198
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
6191
6199
|
*/
|
|
6192
6200
|
name?: string | null;
|
|
6201
|
+
/**
|
|
6202
|
+
* 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.
|
|
6203
|
+
*/
|
|
6204
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
6193
6205
|
/**
|
|
6194
6206
|
* Output only. The time the session started.
|
|
6195
6207
|
*/
|
|
@@ -6597,7 +6609,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
6597
6609
|
*/
|
|
6598
6610
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
|
|
6599
6611
|
/**
|
|
6600
|
-
* Obfuscated Dasher customer ID.
|
|
6612
|
+
* 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.
|
|
6601
6613
|
*/
|
|
6602
6614
|
dasherCustomerId?: string | null;
|
|
6603
6615
|
/**
|
|
@@ -9012,7 +9024,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
9012
9024
|
*/
|
|
9013
9025
|
displayName?: string | null;
|
|
9014
9026
|
/**
|
|
9015
|
-
* 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`
|
|
9027
|
+
* 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`
|
|
9016
9028
|
*/
|
|
9017
9029
|
features?: {
|
|
9018
9030
|
[key: string]: string;
|
|
@@ -10168,7 +10180,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
10168
10180
|
*/
|
|
10169
10181
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec;
|
|
10170
10182
|
/**
|
|
10171
|
-
* 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
|
|
10183
|
+
* 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
|
|
10172
10184
|
*/
|
|
10173
10185
|
rankingExpression?: string | null;
|
|
10174
10186
|
/**
|
|
@@ -11026,7 +11038,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
11026
11038
|
*/
|
|
11027
11039
|
export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
|
|
11028
11040
|
/**
|
|
11029
|
-
* Obfuscated Dasher customer ID.
|
|
11041
|
+
* 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.
|
|
11030
11042
|
*/
|
|
11031
11043
|
dasherCustomerId?: string | null;
|
|
11032
11044
|
/**
|
|
@@ -12052,6 +12064,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
12052
12064
|
* Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
|
|
12053
12065
|
*/
|
|
12054
12066
|
connectorModes?: string[] | null;
|
|
12067
|
+
/**
|
|
12068
|
+
* Optional. If set, this value instead of `data_source` is used to fetch the corresponding connector source.
|
|
12069
|
+
*/
|
|
12070
|
+
connectorSourceId?: string | null;
|
|
12055
12071
|
/**
|
|
12056
12072
|
* 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.
|
|
12057
12073
|
*/
|
|
@@ -13093,7 +13109,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
13093
13109
|
*/
|
|
13094
13110
|
displayName?: string | null;
|
|
13095
13111
|
/**
|
|
13096
|
-
* 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`
|
|
13112
|
+
* 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`
|
|
13097
13113
|
*/
|
|
13098
13114
|
features?: {
|
|
13099
13115
|
[key: string]: string;
|
|
@@ -14125,6 +14141,19 @@ export declare namespace discoveryengine_v1 {
|
|
|
14125
14141
|
*/
|
|
14126
14142
|
nextPageToken?: string | null;
|
|
14127
14143
|
}
|
|
14144
|
+
/**
|
|
14145
|
+
* Response message for LicenseConfigService.ListLicenseConfigs method.
|
|
14146
|
+
*/
|
|
14147
|
+
export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse {
|
|
14148
|
+
/**
|
|
14149
|
+
* All the customer's LicenseConfigs.
|
|
14150
|
+
*/
|
|
14151
|
+
licenseConfigs?: Schema$GoogleCloudDiscoveryengineV1LicenseConfig[];
|
|
14152
|
+
/**
|
|
14153
|
+
* Not supported.
|
|
14154
|
+
*/
|
|
14155
|
+
nextPageToken?: string | null;
|
|
14156
|
+
}
|
|
14128
14157
|
/**
|
|
14129
14158
|
* Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
|
|
14130
14159
|
*/
|
|
@@ -15060,7 +15089,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
15060
15089
|
*/
|
|
15061
15090
|
queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestQueryExpansionSpec;
|
|
15062
15091
|
/**
|
|
15063
|
-
* 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
|
|
15092
|
+
* 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
|
|
15064
15093
|
*/
|
|
15065
15094
|
rankingExpression?: string | null;
|
|
15066
15095
|
/**
|
|
@@ -16111,6 +16140,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
16111
16140
|
* Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x`
|
|
16112
16141
|
*/
|
|
16113
16142
|
name?: string | null;
|
|
16143
|
+
/**
|
|
16144
|
+
* 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.
|
|
16145
|
+
*/
|
|
16146
|
+
pendingAsyncAssistOperationId?: string | null;
|
|
16114
16147
|
/**
|
|
16115
16148
|
* Output only. The time the session started.
|
|
16116
16149
|
*/
|
|
@@ -16353,11 +16386,28 @@ export declare namespace discoveryengine_v1 {
|
|
|
16353
16386
|
* The tool names of the tools that were invoked.
|
|
16354
16387
|
*/
|
|
16355
16388
|
invocationTools?: string[] | null;
|
|
16389
|
+
/**
|
|
16390
|
+
* The skills executed during the turn.
|
|
16391
|
+
*/
|
|
16392
|
+
invokedSkills?: Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill[];
|
|
16356
16393
|
/**
|
|
16357
16394
|
* Session information. Only included in the final StreamAssistResponse of the response stream.
|
|
16358
16395
|
*/
|
|
16359
16396
|
sessionInfo?: Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo;
|
|
16360
16397
|
}
|
|
16398
|
+
/**
|
|
16399
|
+
* Represents a skill used during the assist call.
|
|
16400
|
+
*/
|
|
16401
|
+
export interface Schema$GoogleCloudDiscoveryengineV1StreamAssistResponseInvokedSkill {
|
|
16402
|
+
/**
|
|
16403
|
+
* The display name of the skill.
|
|
16404
|
+
*/
|
|
16405
|
+
displayName?: string | null;
|
|
16406
|
+
/**
|
|
16407
|
+
* The resource name of the skill.
|
|
16408
|
+
*/
|
|
16409
|
+
name?: string | null;
|
|
16410
|
+
}
|
|
16361
16411
|
/**
|
|
16362
16412
|
* Information about the session.
|
|
16363
16413
|
*/
|
|
@@ -17257,7 +17307,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17257
17307
|
*/
|
|
17258
17308
|
enableVisualContentSummary?: boolean | null;
|
|
17259
17309
|
/**
|
|
17260
|
-
* 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`
|
|
17310
|
+
* 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`
|
|
17261
17311
|
*/
|
|
17262
17312
|
features?: {
|
|
17263
17313
|
[key: string]: string;
|
|
@@ -17331,7 +17381,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
17331
17381
|
*/
|
|
17332
17382
|
export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig {
|
|
17333
17383
|
/**
|
|
17334
|
-
* Obfuscated Dasher customer ID.
|
|
17384
|
+
* 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.
|
|
17335
17385
|
*/
|
|
17336
17386
|
dasherCustomerId?: string | null;
|
|
17337
17387
|
/**
|
|
@@ -18223,6 +18273,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18223
18273
|
* // "blockingReasons": [],
|
|
18224
18274
|
* // "cliConfig": {},
|
|
18225
18275
|
* // "connectorModes": [],
|
|
18276
|
+
* // "connectorSourceId": "my_connectorSourceId",
|
|
18226
18277
|
* // "connectorType": "my_connectorType",
|
|
18227
18278
|
* // "createEuaSaas": false,
|
|
18228
18279
|
* // "createTime": "my_createTime",
|
|
@@ -18966,6 +19017,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
18966
19017
|
* // "blockingReasons": [],
|
|
18967
19018
|
* // "cliConfig": {},
|
|
18968
19019
|
* // "connectorModes": [],
|
|
19020
|
+
* // "connectorSourceId": "my_connectorSourceId",
|
|
18969
19021
|
* // "connectorType": "my_connectorType",
|
|
18970
19022
|
* // "createEuaSaas": false,
|
|
18971
19023
|
* // "createTime": "my_createTime",
|
|
@@ -19076,6 +19128,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
19076
19128
|
* // "blockingReasons": [],
|
|
19077
19129
|
* // "cliConfig": {},
|
|
19078
19130
|
* // "connectorModes": [],
|
|
19131
|
+
* // "connectorSourceId": "my_connectorSourceId",
|
|
19079
19132
|
* // "connectorType": "my_connectorType",
|
|
19080
19133
|
* // "createEuaSaas": false,
|
|
19081
19134
|
* // "createTime": "my_createTime",
|
|
@@ -19126,6 +19179,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
19126
19179
|
* // "blockingReasons": [],
|
|
19127
19180
|
* // "cliConfig": {},
|
|
19128
19181
|
* // "connectorModes": [],
|
|
19182
|
+
* // "connectorSourceId": "my_connectorSourceId",
|
|
19129
19183
|
* // "connectorType": "my_connectorType",
|
|
19130
19184
|
* // "createEuaSaas": false,
|
|
19131
19185
|
* // "createTime": "my_createTime",
|
|
@@ -24839,6 +24893,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24839
24893
|
* // "isPinned": false,
|
|
24840
24894
|
* // "labels": [],
|
|
24841
24895
|
* // "name": "my_name",
|
|
24896
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
24842
24897
|
* // "startTime": "my_startTime",
|
|
24843
24898
|
* // "state": "my_state",
|
|
24844
24899
|
* // "turns": [],
|
|
@@ -24856,6 +24911,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
24856
24911
|
* // "isPinned": false,
|
|
24857
24912
|
* // "labels": [],
|
|
24858
24913
|
* // "name": "my_name",
|
|
24914
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
24859
24915
|
* // "startTime": "my_startTime",
|
|
24860
24916
|
* // "state": "my_state",
|
|
24861
24917
|
* // "turns": [],
|
|
@@ -25000,6 +25056,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25000
25056
|
* // "isPinned": false,
|
|
25001
25057
|
* // "labels": [],
|
|
25002
25058
|
* // "name": "my_name",
|
|
25059
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
25003
25060
|
* // "startTime": "my_startTime",
|
|
25004
25061
|
* // "state": "my_state",
|
|
25005
25062
|
* // "turns": [],
|
|
@@ -25065,7 +25122,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25065
25122
|
* {
|
|
25066
25123
|
* // 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"`
|
|
25067
25124
|
* filter: 'placeholder-value',
|
|
25068
|
-
* // 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.
|
|
25125
|
+
* // 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.
|
|
25069
25126
|
* orderBy: 'placeholder-value',
|
|
25070
25127
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
25071
25128
|
* pageSize: 'placeholder-value',
|
|
@@ -25155,6 +25212,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25155
25212
|
* // "isPinned": false,
|
|
25156
25213
|
* // "labels": [],
|
|
25157
25214
|
* // "name": "my_name",
|
|
25215
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
25158
25216
|
* // "startTime": "my_startTime",
|
|
25159
25217
|
* // "state": "my_state",
|
|
25160
25218
|
* // "turns": [],
|
|
@@ -25172,6 +25230,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25172
25230
|
* // "isPinned": false,
|
|
25173
25231
|
* // "labels": [],
|
|
25174
25232
|
* // "name": "my_name",
|
|
25233
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
25175
25234
|
* // "startTime": "my_startTime",
|
|
25176
25235
|
* // "state": "my_state",
|
|
25177
25236
|
* // "turns": [],
|
|
@@ -25234,7 +25293,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25234
25293
|
*/
|
|
25235
25294
|
filter?: string;
|
|
25236
25295
|
/**
|
|
25237
|
-
* 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.
|
|
25296
|
+
* 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.
|
|
25238
25297
|
*/
|
|
25239
25298
|
orderBy?: string;
|
|
25240
25299
|
/**
|
|
@@ -28390,7 +28449,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
28390
28449
|
patch(params: Params$Resource$Projects$Locations$Collections$Engines$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
|
|
28391
28450
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1Engine>): void;
|
|
28392
28451
|
/**
|
|
28393
|
-
* 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`
|
|
28452
|
+
* 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.
|
|
28394
28453
|
* @example
|
|
28395
28454
|
* ```js
|
|
28396
28455
|
* // Before running the sample:
|
|
@@ -29019,6 +29078,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
29019
29078
|
* // "answer": {},
|
|
29020
29079
|
* // "assistToken": "my_assistToken",
|
|
29021
29080
|
* // "invocationTools": [],
|
|
29081
|
+
* // "invokedSkills": [],
|
|
29022
29082
|
* // "sessionInfo": {}
|
|
29023
29083
|
* // }
|
|
29024
29084
|
* }
|
|
@@ -32617,6 +32677,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32617
32677
|
* // "isPinned": false,
|
|
32618
32678
|
* // "labels": [],
|
|
32619
32679
|
* // "name": "my_name",
|
|
32680
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
32620
32681
|
* // "startTime": "my_startTime",
|
|
32621
32682
|
* // "state": "my_state",
|
|
32622
32683
|
* // "turns": [],
|
|
@@ -32634,6 +32695,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32634
32695
|
* // "isPinned": false,
|
|
32635
32696
|
* // "labels": [],
|
|
32636
32697
|
* // "name": "my_name",
|
|
32698
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
32637
32699
|
* // "startTime": "my_startTime",
|
|
32638
32700
|
* // "state": "my_state",
|
|
32639
32701
|
* // "turns": [],
|
|
@@ -32776,6 +32838,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32776
32838
|
* // "isPinned": false,
|
|
32777
32839
|
* // "labels": [],
|
|
32778
32840
|
* // "name": "my_name",
|
|
32841
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
32779
32842
|
* // "startTime": "my_startTime",
|
|
32780
32843
|
* // "state": "my_state",
|
|
32781
32844
|
* // "turns": [],
|
|
@@ -32840,7 +32903,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32840
32903
|
* await discoveryengine.projects.locations.collections.engines.sessions.list({
|
|
32841
32904
|
* // 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"`
|
|
32842
32905
|
* filter: 'placeholder-value',
|
|
32843
|
-
* // 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.
|
|
32906
|
+
* // 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.
|
|
32844
32907
|
* orderBy: 'placeholder-value',
|
|
32845
32908
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
32846
32909
|
* pageSize: 'placeholder-value',
|
|
@@ -32929,6 +32992,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32929
32992
|
* // "isPinned": false,
|
|
32930
32993
|
* // "labels": [],
|
|
32931
32994
|
* // "name": "my_name",
|
|
32995
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
32932
32996
|
* // "startTime": "my_startTime",
|
|
32933
32997
|
* // "state": "my_state",
|
|
32934
32998
|
* // "turns": [],
|
|
@@ -32946,6 +33010,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
32946
33010
|
* // "isPinned": false,
|
|
32947
33011
|
* // "labels": [],
|
|
32948
33012
|
* // "name": "my_name",
|
|
33013
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
32949
33014
|
* // "startTime": "my_startTime",
|
|
32950
33015
|
* // "state": "my_state",
|
|
32951
33016
|
* // "turns": [],
|
|
@@ -33008,7 +33073,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
33008
33073
|
*/
|
|
33009
33074
|
filter?: string;
|
|
33010
33075
|
/**
|
|
33011
|
-
* 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.
|
|
33076
|
+
* 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.
|
|
33012
33077
|
*/
|
|
33013
33078
|
orderBy?: string;
|
|
33014
33079
|
/**
|
|
@@ -38515,6 +38580,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38515
38580
|
* // "isPinned": false,
|
|
38516
38581
|
* // "labels": [],
|
|
38517
38582
|
* // "name": "my_name",
|
|
38583
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
38518
38584
|
* // "startTime": "my_startTime",
|
|
38519
38585
|
* // "state": "my_state",
|
|
38520
38586
|
* // "turns": [],
|
|
@@ -38531,6 +38597,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38531
38597
|
* // "isPinned": false,
|
|
38532
38598
|
* // "labels": [],
|
|
38533
38599
|
* // "name": "my_name",
|
|
38600
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
38534
38601
|
* // "startTime": "my_startTime",
|
|
38535
38602
|
* // "state": "my_state",
|
|
38536
38603
|
* // "turns": [],
|
|
@@ -38670,6 +38737,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38670
38737
|
* // "isPinned": false,
|
|
38671
38738
|
* // "labels": [],
|
|
38672
38739
|
* // "name": "my_name",
|
|
38740
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
38673
38741
|
* // "startTime": "my_startTime",
|
|
38674
38742
|
* // "state": "my_state",
|
|
38675
38743
|
* // "turns": [],
|
|
@@ -38734,7 +38802,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38734
38802
|
* {
|
|
38735
38803
|
* // 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"`
|
|
38736
38804
|
* filter: 'placeholder-value',
|
|
38737
|
-
* // 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.
|
|
38805
|
+
* // 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.
|
|
38738
38806
|
* orderBy: 'placeholder-value',
|
|
38739
38807
|
* // Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
|
38740
38808
|
* pageSize: 'placeholder-value',
|
|
@@ -38823,6 +38891,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38823
38891
|
* // "isPinned": false,
|
|
38824
38892
|
* // "labels": [],
|
|
38825
38893
|
* // "name": "my_name",
|
|
38894
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
38826
38895
|
* // "startTime": "my_startTime",
|
|
38827
38896
|
* // "state": "my_state",
|
|
38828
38897
|
* // "turns": [],
|
|
@@ -38839,6 +38908,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38839
38908
|
* // "isPinned": false,
|
|
38840
38909
|
* // "labels": [],
|
|
38841
38910
|
* // "name": "my_name",
|
|
38911
|
+
* // "pendingAsyncAssistOperationId": "my_pendingAsyncAssistOperationId",
|
|
38842
38912
|
* // "startTime": "my_startTime",
|
|
38843
38913
|
* // "state": "my_state",
|
|
38844
38914
|
* // "turns": [],
|
|
@@ -38901,7 +38971,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
38901
38971
|
*/
|
|
38902
38972
|
filter?: string;
|
|
38903
38973
|
/**
|
|
38904
|
-
* 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.
|
|
38974
|
+
* 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.
|
|
38905
38975
|
*/
|
|
38906
38976
|
orderBy?: string;
|
|
38907
38977
|
/**
|
|
@@ -42026,6 +42096,77 @@ export declare namespace discoveryengine_v1 {
|
|
|
42026
42096
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
42027
42097
|
get(params: Params$Resource$Projects$Locations$Licenseconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
42028
42098
|
get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1LicenseConfig>): void;
|
|
42099
|
+
/**
|
|
42100
|
+
* Lists all the LicenseConfigs associated with the project.
|
|
42101
|
+
* @example
|
|
42102
|
+
* ```js
|
|
42103
|
+
* // Before running the sample:
|
|
42104
|
+
* // - Enable the API at:
|
|
42105
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
42106
|
+
* // - Login into gcloud by running:
|
|
42107
|
+
* // ```sh
|
|
42108
|
+
* // $ gcloud auth application-default login
|
|
42109
|
+
* // ```
|
|
42110
|
+
* // - Install the npm module by running:
|
|
42111
|
+
* // ```sh
|
|
42112
|
+
* // $ npm install googleapis
|
|
42113
|
+
* // ```
|
|
42114
|
+
*
|
|
42115
|
+
* const {google} = require('googleapis');
|
|
42116
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
42117
|
+
*
|
|
42118
|
+
* async function main() {
|
|
42119
|
+
* const auth = new google.auth.GoogleAuth({
|
|
42120
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
42121
|
+
* scopes: [
|
|
42122
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
42123
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
42124
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
42125
|
+
* ],
|
|
42126
|
+
* });
|
|
42127
|
+
*
|
|
42128
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
42129
|
+
* const authClient = await auth.getClient();
|
|
42130
|
+
* google.options({auth: authClient});
|
|
42131
|
+
*
|
|
42132
|
+
* // Do the magic
|
|
42133
|
+
* const res = await discoveryengine.projects.locations.licenseConfigs.list({
|
|
42134
|
+
* // 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.
|
|
42135
|
+
* filter: 'placeholder-value',
|
|
42136
|
+
* // Optional. Not supported.
|
|
42137
|
+
* pageSize: 'placeholder-value',
|
|
42138
|
+
* // Optional. Not supported.
|
|
42139
|
+
* pageToken: 'placeholder-value',
|
|
42140
|
+
* // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
42141
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
42142
|
+
* });
|
|
42143
|
+
* console.log(res.data);
|
|
42144
|
+
*
|
|
42145
|
+
* // Example response
|
|
42146
|
+
* // {
|
|
42147
|
+
* // "licenseConfigs": [],
|
|
42148
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
42149
|
+
* // }
|
|
42150
|
+
* }
|
|
42151
|
+
*
|
|
42152
|
+
* main().catch(e => {
|
|
42153
|
+
* console.error(e);
|
|
42154
|
+
* throw e;
|
|
42155
|
+
* });
|
|
42156
|
+
*
|
|
42157
|
+
* ```
|
|
42158
|
+
*
|
|
42159
|
+
* @param params - Parameters for request
|
|
42160
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
42161
|
+
* @param callback - Optional callback that handles the response.
|
|
42162
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
42163
|
+
*/
|
|
42164
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
42165
|
+
list(params?: Params$Resource$Projects$Locations$Licenseconfigs$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>>;
|
|
42166
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
42167
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>): void;
|
|
42168
|
+
list(params: Params$Resource$Projects$Locations$Licenseconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>): void;
|
|
42169
|
+
list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsResponse>): void;
|
|
42029
42170
|
/**
|
|
42030
42171
|
* Updates the LicenseConfig
|
|
42031
42172
|
* @example
|
|
@@ -42143,6 +42284,24 @@ export declare namespace discoveryengine_v1 {
|
|
|
42143
42284
|
*/
|
|
42144
42285
|
name?: string;
|
|
42145
42286
|
}
|
|
42287
|
+
export interface Params$Resource$Projects$Locations$Licenseconfigs$List extends StandardParameters {
|
|
42288
|
+
/**
|
|
42289
|
+
* 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.
|
|
42290
|
+
*/
|
|
42291
|
+
filter?: string;
|
|
42292
|
+
/**
|
|
42293
|
+
* Optional. Not supported.
|
|
42294
|
+
*/
|
|
42295
|
+
pageSize?: number;
|
|
42296
|
+
/**
|
|
42297
|
+
* Optional. Not supported.
|
|
42298
|
+
*/
|
|
42299
|
+
pageToken?: string;
|
|
42300
|
+
/**
|
|
42301
|
+
* Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
|
|
42302
|
+
*/
|
|
42303
|
+
parent?: string;
|
|
42304
|
+
}
|
|
42146
42305
|
export interface Params$Resource$Projects$Locations$Licenseconfigs$Patch extends StandardParameters {
|
|
42147
42306
|
/**
|
|
42148
42307
|
* Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project\}/locations/{location\}/licenseConfigs/{license_config\}`
|
package/build/v1.js
CHANGED
|
@@ -9160,6 +9160,38 @@ var discoveryengine_v1;
|
|
|
9160
9160
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
9161
9161
|
}
|
|
9162
9162
|
}
|
|
9163
|
+
list(paramsOrCallback, optionsOrCallback, callback) {
|
|
9164
|
+
let params = (paramsOrCallback ||
|
|
9165
|
+
{});
|
|
9166
|
+
let options = (optionsOrCallback || {});
|
|
9167
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9168
|
+
callback = paramsOrCallback;
|
|
9169
|
+
params = {};
|
|
9170
|
+
options = {};
|
|
9171
|
+
}
|
|
9172
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9173
|
+
callback = optionsOrCallback;
|
|
9174
|
+
options = {};
|
|
9175
|
+
}
|
|
9176
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
9177
|
+
const parameters = {
|
|
9178
|
+
options: Object.assign({
|
|
9179
|
+
url: (rootUrl + '/v1/{+parent}/licenseConfigs').replace(/([^:]\/)\/+/g, '$1'),
|
|
9180
|
+
method: 'GET',
|
|
9181
|
+
apiVersion: '',
|
|
9182
|
+
}, options),
|
|
9183
|
+
params,
|
|
9184
|
+
requiredParams: ['parent'],
|
|
9185
|
+
pathParams: ['parent'],
|
|
9186
|
+
context: this.context,
|
|
9187
|
+
};
|
|
9188
|
+
if (callback) {
|
|
9189
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
9190
|
+
}
|
|
9191
|
+
else {
|
|
9192
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
9193
|
+
}
|
|
9194
|
+
}
|
|
9163
9195
|
patch(paramsOrCallback, optionsOrCallback, callback) {
|
|
9164
9196
|
let params = (paramsOrCallback ||
|
|
9165
9197
|
{});
|