@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20250714 → 0.0.20250722

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.
Files changed (3) hide show
  1. package/index.d.ts +242 -18
  2. package/package.json +1 -1
  3. package/readme.md +3 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20250714
12
+ // Revision: 20250722
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -441,9 +441,9 @@ declare namespace gapi.client {
441
441
  interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
442
442
  /** Output only. The default CmekConfig for the Customer. */
443
443
  isDefault?: boolean;
444
- /** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
444
+ /** Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
445
445
  kmsKey?: string;
446
- /** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
446
+ /** Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
447
447
  kmsKeyVersion?: string;
448
448
  /** Output only. The timestamp of the last key rotation. */
449
449
  lastRotationTimestampMicros?: string;
@@ -940,6 +940,8 @@ declare namespace gapi.client {
940
940
  }
941
941
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
942
942
  interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
943
+ /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
944
+ enableGetProcessedDocument?: boolean;
943
945
  /** Optional. If true, the LLM based annotation is added to the image during parsing. */
944
946
  enableImageAnnotation?: boolean;
945
947
  /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -981,7 +983,7 @@ declare namespace gapi.client {
981
983
  disableAnalytics?: boolean;
982
984
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
983
985
  displayName?: string;
984
- /** 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` */
986
+ /** 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` - Enables personalization based on user preferences. */
985
987
  features?: {[P in string]: string};
986
988
  /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
987
989
  industryVertical?: string;
@@ -1296,7 +1298,7 @@ declare namespace gapi.client {
1296
1298
  region?: string;
1297
1299
  }
1298
1300
  interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
1299
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true" */
1301
+ /** 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` 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\"" */
1300
1302
  filter?: string;
1301
1303
  /** 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. */
1302
1304
  orderBy?: string;
@@ -1597,7 +1599,7 @@ declare namespace gapi.client {
1597
1599
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
1598
1600
  /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
1599
1601
  servingConfig?: string;
1600
- /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
1602
+ /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
1601
1603
  session?: string;
1602
1604
  /** Session specification. Can be used only when `session` is set. */
1603
1605
  sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
@@ -2015,6 +2017,10 @@ declare namespace gapi.client {
2015
2017
  /** Optional. The top-p value to be used for the user defined classifier. */
2016
2018
  topP?: number;
2017
2019
  }
2020
+ interface GoogleCloudDiscoveryengineV1Assistant {
2021
+ /** Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. */
2022
+ name?: string;
2023
+ }
2018
2024
  interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
2019
2025
  /** Operation create time. */
2020
2026
  createTime?: string;
@@ -2583,6 +2589,106 @@ declare namespace gapi.client {
2583
2589
  /** The query to search. */
2584
2590
  query?: string;
2585
2591
  }
2592
+ interface GoogleCloudDiscoveryengineV1betaAssistAnswer {
2593
+ /** Reasons for not answering the assist call. */
2594
+ assistSkippedReasons?: string[];
2595
+ /** Immutable. Identifier. Resource name of the `AssistAnswer`. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
2596
+ name?: string;
2597
+ /** Replies of the assistant. */
2598
+ replies?: GoogleCloudDiscoveryengineV1betaAssistAnswerReply[];
2599
+ /** State of the answer generation. */
2600
+ state?: string;
2601
+ }
2602
+ interface GoogleCloudDiscoveryengineV1betaAssistAnswerReply {
2603
+ /** Possibly grounded response text or media from the assistant. */
2604
+ groundedContent?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContent;
2605
+ }
2606
+ interface GoogleCloudDiscoveryengineV1betaAssistantContent {
2607
+ /** Result of executing an ExecutableCode. */
2608
+ codeExecutionResult?: GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult;
2609
+ /** Code generated by the model that is meant to be executed. */
2610
+ executableCode?: GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode;
2611
+ /** A file, e.g., an audio summary. */
2612
+ file?: GoogleCloudDiscoveryengineV1betaAssistantContentFile;
2613
+ /** Inline binary data. */
2614
+ inlineData?: GoogleCloudDiscoveryengineV1betaAssistantContentBlob;
2615
+ /** The producer of the content. Can be "model" or "user". */
2616
+ role?: string;
2617
+ /** Inline text. */
2618
+ text?: string;
2619
+ /** Optional. Indicates if the part is thought from the model. */
2620
+ thought?: boolean;
2621
+ }
2622
+ interface GoogleCloudDiscoveryengineV1betaAssistantContentBlob {
2623
+ /** Required. Raw bytes. */
2624
+ data?: string;
2625
+ /** Required. The media type (MIME type) of the generated data. */
2626
+ mimeType?: string;
2627
+ }
2628
+ interface GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult {
2629
+ /** Required. Outcome of the code execution. */
2630
+ outcome?: string;
2631
+ /** Optional. Contains stdout when code execution is successful, stderr or other description otherwise. */
2632
+ output?: string;
2633
+ }
2634
+ interface GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode {
2635
+ /** Required. The code content. Currently only supports Python. */
2636
+ code?: string;
2637
+ }
2638
+ interface GoogleCloudDiscoveryengineV1betaAssistantContentFile {
2639
+ /** Required. The file ID. */
2640
+ fileId?: string;
2641
+ /** Required. The media type (MIME type) of the file. */
2642
+ mimeType?: string;
2643
+ }
2644
+ interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContent {
2645
+ /** The content. */
2646
+ content?: GoogleCloudDiscoveryengineV1betaAssistantContent;
2647
+ /** Metadata for grounding based on text sources. */
2648
+ textGroundingMetadata?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata;
2649
+ }
2650
+ interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata {
2651
+ /** References for the grounded text. */
2652
+ references?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference[];
2653
+ /** Grounding information for parts of the text. */
2654
+ segments?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment[];
2655
+ }
2656
+ interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference {
2657
+ /** Referenced text content. */
2658
+ content?: string;
2659
+ /** Document metadata. */
2660
+ documentMetadata?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata;
2661
+ }
2662
+ interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata {
2663
+ /** Document resource name. */
2664
+ document?: string;
2665
+ /** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
2666
+ domain?: string;
2667
+ /** Page identifier. */
2668
+ pageIdentifier?: string;
2669
+ /** Title. */
2670
+ title?: string;
2671
+ /** URI for the document. It may contain a URL that redirects to the actual website. */
2672
+ uri?: string;
2673
+ }
2674
+ interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment {
2675
+ /** End of the segment, exclusive. */
2676
+ endIndex?: string;
2677
+ /** Score for the segment. */
2678
+ groundingScore?: number;
2679
+ /** References for the segment. */
2680
+ referenceIndices?: number[];
2681
+ /** Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). */
2682
+ startIndex?: string;
2683
+ /** The text segment itself. */
2684
+ text?: string;
2685
+ }
2686
+ interface GoogleCloudDiscoveryengineV1betaAssistUserMetadata {
2687
+ /** Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. */
2688
+ preferredLanguageCode?: string;
2689
+ /** Optional. IANA time zone, e.g. Europe/Budapest. */
2690
+ timeZone?: string;
2691
+ }
2586
2692
  interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
2587
2693
  /** Operation create time. */
2588
2694
  createTime?: string;
@@ -2815,9 +2921,9 @@ declare namespace gapi.client {
2815
2921
  interface GoogleCloudDiscoveryengineV1betaCmekConfig {
2816
2922
  /** Output only. The default CmekConfig for the Customer. */
2817
2923
  isDefault?: boolean;
2818
- /** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
2924
+ /** Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
2819
2925
  kmsKey?: string;
2820
- /** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
2926
+ /** Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
2821
2927
  kmsKeyVersion?: string;
2822
2928
  /** Output only. The timestamp of the last key rotation. */
2823
2929
  lastRotationTimestampMicros?: string;
@@ -3291,6 +3397,8 @@ declare namespace gapi.client {
3291
3397
  }
3292
3398
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
3293
3399
  interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
3400
+ /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
3401
+ enableGetProcessedDocument?: boolean;
3294
3402
  /** Optional. If true, the LLM based annotation is added to the image during parsing. */
3295
3403
  enableImageAnnotation?: boolean;
3296
3404
  /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -3341,7 +3449,7 @@ declare namespace gapi.client {
3341
3449
  disableAnalytics?: boolean;
3342
3450
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
3343
3451
  displayName?: string;
3344
- /** 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` */
3452
+ /** 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` - Enables personalization based on user preferences. */
3345
3453
  features?: {[P in string]: string};
3346
3454
  /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
3347
3455
  industryVertical?: string;
@@ -3605,7 +3713,7 @@ declare namespace gapi.client {
3605
3713
  forceRefreshContent?: boolean;
3606
3714
  /** Cloud Storage location for the input content. */
3607
3715
  gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
3608
- /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */
3716
+ /** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. */
3609
3717
  idField?: string;
3610
3718
  /** The Inline source for the input content for documents. */
3611
3719
  inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
@@ -3955,6 +4063,12 @@ declare namespace gapi.client {
3955
4063
  acceptDataUseTerms?: boolean;
3956
4064
  /** Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */
3957
4065
  dataUseTermsVersion?: string;
4066
+ /** Optional. Parameters for Agentspace. */
4067
+ saasParams?: GoogleCloudDiscoveryengineV1betaProvisionProjectRequestSaasParams;
4068
+ }
4069
+ interface GoogleCloudDiscoveryengineV1betaProvisionProjectRequestSaasParams {
4070
+ /** Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service]. */
4071
+ acceptBizQos?: boolean;
3958
4072
  }
3959
4073
  interface GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest {}
3960
4074
  interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
@@ -4071,7 +4185,7 @@ declare namespace gapi.client {
4071
4185
  model?: string;
4072
4186
  /** The query to use. */
4073
4187
  query?: string;
4074
- /** Required. A list of records to rank. At most 200 records to rank. */
4188
+ /** Required. A list of records to rank. */
4075
4189
  records?: GoogleCloudDiscoveryengineV1betaRankingRecord[];
4076
4190
  /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
4077
4191
  topN?: number;
@@ -4303,7 +4417,7 @@ declare namespace gapi.client {
4303
4417
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
4304
4418
  /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
4305
4419
  servingConfig?: string;
4306
- /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
4420
+ /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
4307
4421
  session?: string;
4308
4422
  /** Session specification. Can be used only when `session` is set. */
4309
4423
  sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
@@ -4885,6 +4999,53 @@ declare namespace gapi.client {
4885
4999
  /** Required. The table name of the Spanner database that needs to be imported. */
4886
5000
  tableId?: string;
4887
5001
  }
5002
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequest {
5003
+ /** Optional. Specification of the generation configuration for the request. */
5004
+ generationSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec;
5005
+ /** Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. */
5006
+ query?: GoogleCloudDiscoveryengineV1betaQuery;
5007
+ /** Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` */
5008
+ session?: string;
5009
+ /** Optional. Specification of tools that are used to serve the request. */
5010
+ toolsSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec;
5011
+ /** Optional. Information about the user initiating the query. */
5012
+ userMetadata?: GoogleCloudDiscoveryengineV1betaAssistUserMetadata;
5013
+ }
5014
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec {
5015
+ /** Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. */
5016
+ modelId?: string;
5017
+ }
5018
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec {
5019
+ /** Optional. Specification of the image generation tool. */
5020
+ imageGenerationSpec?: any;
5021
+ /** Optional. Specification of the Vertex AI Search tool. */
5022
+ vertexAiSearchSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec;
5023
+ /** Optional. Specification of the video generation tool. */
5024
+ videoGenerationSpec?: any;
5025
+ /** Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. */
5026
+ webGroundingSpec?: any;
5027
+ }
5028
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec {}
5029
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec {
5030
+ /** Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. */
5031
+ dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
5032
+ /** Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
5033
+ filter?: string;
5034
+ }
5035
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec {}
5036
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec {}
5037
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistResponse {
5038
+ /** Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. */
5039
+ answer?: GoogleCloudDiscoveryengineV1betaAssistAnswer;
5040
+ /** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
5041
+ assistToken?: string;
5042
+ /** Session information. */
5043
+ sessionInfo?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
5044
+ }
5045
+ interface GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo {
5046
+ /** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
5047
+ session?: string;
5048
+ }
4888
5049
  interface GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry {
4889
5050
  /** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
4890
5051
  blockPhrase?: string;
@@ -5082,9 +5243,9 @@ declare namespace gapi.client {
5082
5243
  interface GoogleCloudDiscoveryengineV1CmekConfig {
5083
5244
  /** Output only. The default CmekConfig for the Customer. */
5084
5245
  isDefault?: boolean;
5085
- /** KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
5246
+ /** Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. */
5086
5247
  kmsKey?: string;
5087
- /** KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
5248
+ /** Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. */
5088
5249
  kmsKeyVersion?: string;
5089
5250
  /** Output only. The timestamp of the last key rotation. */
5090
5251
  lastRotationTimestampMicros?: string;
@@ -5358,6 +5519,8 @@ declare namespace gapi.client {
5358
5519
  }
5359
5520
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
5360
5521
  interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {
5522
+ /** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
5523
+ enableGetProcessedDocument?: boolean;
5361
5524
  /** Optional. If true, the LLM based annotation is added to the image during parsing. */
5362
5525
  enableImageAnnotation?: boolean;
5363
5526
  /** Optional. If true, the LLM based annotation is added to the table during parsing. */
@@ -5399,7 +5562,7 @@ declare namespace gapi.client {
5399
5562
  disableAnalytics?: boolean;
5400
5563
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
5401
5564
  displayName?: string;
5402
- /** 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` */
5565
+ /** 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` - Enables personalization based on user preferences. */
5403
5566
  features?: {[P in string]: string};
5404
5567
  /** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
5405
5568
  industryVertical?: string;
@@ -8351,7 +8514,7 @@ declare namespace gapi.client {
8351
8514
  callback?: string;
8352
8515
  /** Selector specifying which fields to include in a partial response. */
8353
8516
  fields?: string;
8354
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true" */
8517
+ /** 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` 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\"" */
8355
8518
  filter?: string;
8356
8519
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
8357
8520
  key?: string;
@@ -9902,6 +10065,66 @@ declare namespace gapi.client {
9902
10065
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
9903
10066
  userEvents: UserEventsResource;
9904
10067
  }
10068
+ interface AssistantsResource {
10069
+ /** Assists the user with a query in a streaming fashion. */
10070
+ streamAssist(request: {
10071
+ /** V1 error format. */
10072
+ '$.xgafv'?: string;
10073
+ /** OAuth access token. */
10074
+ access_token?: string;
10075
+ /** Data format for response. */
10076
+ alt?: string;
10077
+ /** JSONP */
10078
+ callback?: string;
10079
+ /** Selector specifying which fields to include in a partial response. */
10080
+ fields?: string;
10081
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
10082
+ key?: string;
10083
+ /** Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
10084
+ name: string;
10085
+ /** OAuth 2.0 token for the current user. */
10086
+ oauth_token?: string;
10087
+ /** Returns response with indentations and line breaks. */
10088
+ prettyPrint?: boolean;
10089
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
10090
+ quotaUser?: string;
10091
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10092
+ upload_protocol?: string;
10093
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10094
+ uploadType?: string;
10095
+ /** Request body */
10096
+ resource: GoogleCloudDiscoveryengineV1betaStreamAssistRequest;
10097
+ }): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
10098
+ streamAssist(
10099
+ request: {
10100
+ /** V1 error format. */
10101
+ '$.xgafv'?: string;
10102
+ /** OAuth access token. */
10103
+ access_token?: string;
10104
+ /** Data format for response. */
10105
+ alt?: string;
10106
+ /** JSONP */
10107
+ callback?: string;
10108
+ /** Selector specifying which fields to include in a partial response. */
10109
+ fields?: string;
10110
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
10111
+ key?: string;
10112
+ /** Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
10113
+ name: string;
10114
+ /** OAuth 2.0 token for the current user. */
10115
+ oauth_token?: string;
10116
+ /** Returns response with indentations and line breaks. */
10117
+ prettyPrint?: boolean;
10118
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
10119
+ quotaUser?: string;
10120
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
10121
+ upload_protocol?: string;
10122
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
10123
+ uploadType?: string;
10124
+ },
10125
+ body: GoogleCloudDiscoveryengineV1betaStreamAssistRequest,
10126
+ ): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
10127
+ }
9905
10128
  interface CompletionConfigResource {
9906
10129
  /** Completes the user input with advanced keyword suggestions. */
9907
10130
  completeQuery(request: {
@@ -11132,7 +11355,7 @@ declare namespace gapi.client {
11132
11355
  callback?: string;
11133
11356
  /** Selector specifying which fields to include in a partial response. */
11134
11357
  fields?: string;
11135
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true" */
11358
+ /** 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` 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\"" */
11136
11359
  filter?: string;
11137
11360
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
11138
11361
  key?: string;
@@ -11605,6 +11828,7 @@ declare namespace gapi.client {
11605
11828
  },
11606
11829
  body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest,
11607
11830
  ): Request<GoogleLongrunningOperation>;
11831
+ assistants: AssistantsResource;
11608
11832
  completionConfig: CompletionConfigResource;
11609
11833
  controls: ControlsResource;
11610
11834
  conversations: ConversationsResource;
@@ -13732,7 +13956,7 @@ declare namespace gapi.client {
13732
13956
  callback?: string;
13733
13957
  /** Selector specifying which fields to include in a partial response. */
13734
13958
  fields?: string;
13735
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state, starred. Examples: "user_pseudo_id = some_id" "starred = true" */
13959
+ /** 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` 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\"" */
13736
13960
  filter?: string;
13737
13961
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13738
13962
  key?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20250714",
3
+ "version": "0.0.20250722",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -48,6 +48,9 @@ Don't forget to authenticate your client before sending any request to resources
48
48
  // declare client_id registered in Google Developers Console
49
49
  var client_id = '',
50
50
  scope = [
51
+ // Search your organization's data in the Cloud Search index
52
+ 'https://www.googleapis.com/auth/cloud_search.query',
53
+
51
54
  // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
52
55
  'https://www.googleapis.com/auth/cloud-platform',
53
56
  ],