@googleapis/discoveryengine 36.0.0 → 37.1.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.
@@ -2503,7 +2503,7 @@ export declare namespace discoveryengine_v1alpha {
2503
2503
  */
2504
2504
  generationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig;
2505
2505
  /**
2506
- * Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data.
2506
+ * Optional. Indicates whether Knowledge Catalog is enabled for this specific assistant. When enabled, it powers discovery context using organizational data. If unspecified, defaults to true.
2507
2507
  */
2508
2508
  knowledgeCatalogEnabled?: boolean | null;
2509
2509
  /**
@@ -8166,6 +8166,10 @@ export declare namespace discoveryengine_v1alpha {
8166
8166
  * Optional. Configuration for NotebookLM settings.
8167
8167
  */
8168
8168
  notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
8169
+ /**
8170
+ * Optional. Resource-level access control config for Gemini Enterprise users.
8171
+ */
8172
+ resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig;
8169
8173
  }
8170
8174
  /**
8171
8175
  * Configuration for NotebookLM.
@@ -8219,6 +8223,15 @@ export declare namespace discoveryengine_v1alpha {
8219
8223
  */
8220
8224
  userPromptTemplate?: string | null;
8221
8225
  }
8226
+ /**
8227
+ * Controls resource-level access control for Gemini Enterprise users.
8228
+ */
8229
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig {
8230
+ /**
8231
+ * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
8232
+ */
8233
+ dataStoreAccessControlEnabled?: boolean | null;
8234
+ }
8222
8235
  /**
8223
8236
  * Metadata about the terms of service.
8224
8237
  */
@@ -8625,6 +8638,10 @@ export declare namespace discoveryengine_v1alpha {
8625
8638
  * This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
8626
8639
  */
8627
8640
  uiJsonPayload?: string | null;
8641
+ /**
8642
+ * Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above.
8643
+ */
8644
+ userSuppliedSobiArtifactReference?: Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference;
8628
8645
  }
8629
8646
  /**
8630
8647
  * Represents a document reference.
@@ -8717,6 +8734,19 @@ export declare namespace discoveryengine_v1alpha {
8717
8734
  */
8718
8735
  personId?: string | null;
8719
8736
  }
8737
+ /**
8738
+ * Reference to a user-supplied file attached to a long-running-agent (Sobi) task. Rendered by the client as an attachment chip on the user turn's bubble. The file itself is stored on the task's `AgentArtifact` list; the client resolves full metadata (source URI, size, ...) for download or preview by calling `GetTask` on the Sobi Task API and matching `AgentArtifact.name` against `file_name`. Only `file_name` and `mime_type` appear on this wire deliberately: the backing `gs://` or Drive URI is not exposed to conversation-history readers. Same variant is used for both byte-uploaded and Drive-picked files -- "user attached a file" is one concept regardless of source.
8739
+ */
8740
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference {
8741
+ /**
8742
+ * Required. Client-supplied filename. Unique per task within the user-supplied artifact set (UI dedupes before upload). Doubles as the artifact identifier used to look up the artifact on `Task.artifacts`. The `_name` suffix is deliberate and the AIP-122 lint is suppressed: this field is not a resource name (which is what AIP-122 reserves the bare `name` for). It is the literal filename, and it serves as the join key against `AgentArtifact.name` on the backing Sobi task -- a structural role that `title` or `display_name` would not communicate to a client picking what to send. The internal mirror (`cloud/ml/discoveryengine/schema/assistant.proto`) uses the same field name so the round-trip converter stays name-for-name.
8743
+ */
8744
+ fileName?: string | null;
8745
+ /**
8746
+ * Optional. IANA MIME type. Used for icon/preview rendering.
8747
+ */
8748
+ mimeType?: string | null;
8749
+ }
8720
8750
  /**
8721
8751
  * Record message for RankService.Rank method.
8722
8752
  */
@@ -10088,6 +10118,27 @@ export declare namespace discoveryengine_v1alpha {
10088
10118
  * The condition under which search as you type should occur. Default to Condition.DISABLED.
10089
10119
  */
10090
10120
  condition?: string | null;
10121
+ /**
10122
+ * Optional. The list of fields to be used for Search As You Type scoring.
10123
+ */
10124
+ fields?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField[];
10125
+ /**
10126
+ * Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
10127
+ */
10128
+ scoreThreshold?: number | null;
10129
+ }
10130
+ /**
10131
+ * A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
10132
+ */
10133
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField {
10134
+ /**
10135
+ * Required. A field key that has been indexed for Search As You Type.
10136
+ */
10137
+ key?: string | null;
10138
+ /**
10139
+ * Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
10140
+ */
10141
+ weight?: number | null;
10091
10142
  }
10092
10143
  /**
10093
10144
  * Session specification.
@@ -12512,6 +12563,10 @@ export declare namespace discoveryengine_v1alpha {
12512
12563
  * Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request.
12513
12564
  */
12514
12565
  displayName?: string | null;
12566
+ /**
12567
+ * Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized.
12568
+ */
12569
+ family?: string | null;
12515
12570
  /**
12516
12571
  * Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`).
12517
12572
  */
@@ -14685,6 +14740,10 @@ export declare namespace discoveryengine_v1alpha {
14685
14740
  * Optional. Configuration for NotebookLM settings.
14686
14741
  */
14687
14742
  notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
14743
+ /**
14744
+ * Optional. Resource-level access control config for Gemini Enterprise users.
14745
+ */
14746
+ resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig;
14688
14747
  }
14689
14748
  /**
14690
14749
  * Configuration for NotebookLM.
@@ -14738,6 +14797,15 @@ export declare namespace discoveryengine_v1alpha {
14738
14797
  */
14739
14798
  userPromptTemplate?: string | null;
14740
14799
  }
14800
+ /**
14801
+ * Controls resource-level access control for Gemini Enterprise users.
14802
+ */
14803
+ export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig {
14804
+ /**
14805
+ * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
14806
+ */
14807
+ dataStoreAccessControlEnabled?: boolean | null;
14808
+ }
14741
14809
  /**
14742
14810
  * Metadata about the terms of service.
14743
14811
  */
@@ -15593,6 +15661,27 @@ export declare namespace discoveryengine_v1alpha {
15593
15661
  * The condition under which search as you type should occur. Default to Condition.DISABLED.
15594
15662
  */
15595
15663
  condition?: string | null;
15664
+ /**
15665
+ * Optional. The list of fields to be used for Search As You Type scoring.
15666
+ */
15667
+ fields?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField[];
15668
+ /**
15669
+ * Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
15670
+ */
15671
+ scoreThreshold?: number | null;
15672
+ }
15673
+ /**
15674
+ * A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
15675
+ */
15676
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField {
15677
+ /**
15678
+ * Required. A field key that has been indexed for Search As You Type.
15679
+ */
15680
+ key?: string | null;
15681
+ /**
15682
+ * Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
15683
+ */
15684
+ weight?: number | null;
15596
15685
  }
15597
15686
  /**
15598
15687
  * Session specification.
@@ -17902,6 +17991,10 @@ export declare namespace discoveryengine_v1alpha {
17902
17991
  * Optional. Configuration for NotebookLM settings.
17903
17992
  */
17904
17993
  notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
17994
+ /**
17995
+ * Optional. Resource-level access control config for Gemini Enterprise users.
17996
+ */
17997
+ resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig;
17905
17998
  }
17906
17999
  /**
17907
18000
  * Configuration for NotebookLM.
@@ -17955,6 +18048,15 @@ export declare namespace discoveryengine_v1alpha {
17955
18048
  */
17956
18049
  userPromptTemplate?: string | null;
17957
18050
  }
18051
+ /**
18052
+ * Controls resource-level access control for Gemini Enterprise users.
18053
+ */
18054
+ export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig {
18055
+ /**
18056
+ * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
18057
+ */
18058
+ dataStoreAccessControlEnabled?: boolean | null;
18059
+ }
17958
18060
  /**
17959
18061
  * Metadata about the terms of service.
17960
18062
  */
@@ -18689,6 +18791,32 @@ export declare namespace discoveryengine_v1alpha {
18689
18791
  */
18690
18792
  type?: string | null;
18691
18793
  }
18794
+ /**
18795
+ * Account and role information.
18796
+ */
18797
+ export interface Schema$GoogleCloudNotebooklmV1alphaAccountAndRole {
18798
+ /**
18799
+ * Required. The email address associated with the account.
18800
+ */
18801
+ email?: string | null;
18802
+ /**
18803
+ * Required. The role in the notebook.
18804
+ */
18805
+ role?: string | null;
18806
+ }
18807
+ /**
18808
+ * Metadata about an agentspace source.
18809
+ */
18810
+ export interface Schema$GoogleCloudNotebooklmV1alphaAgentspaceMetadata {
18811
+ /**
18812
+ * Output only. The full document name in Agentspace.
18813
+ */
18814
+ documentName?: string | null;
18815
+ /**
18816
+ * Output only. The title of the document.
18817
+ */
18818
+ documentTitle?: string | null;
18819
+ }
18692
18820
  /**
18693
18821
  * An audio overview of a notebook. This is a summary of the notebook in audio format.
18694
18822
  */
@@ -18735,6 +18863,51 @@ export declare namespace discoveryengine_v1alpha {
18735
18863
  */
18736
18864
  sourceIds?: Schema$GoogleCloudNotebooklmV1alphaSourceId[];
18737
18865
  }
18866
+ /**
18867
+ * Request for SourceService.BatchCreateSources method.
18868
+ */
18869
+ export interface Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest {
18870
+ /**
18871
+ * Required. The UserContents to be uploaded.
18872
+ */
18873
+ userContents?: Schema$GoogleCloudNotebooklmV1alphaUserContent[];
18874
+ }
18875
+ /**
18876
+ * Response for SourceService.BatchCreateSources method.
18877
+ */
18878
+ export interface Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse {
18879
+ /**
18880
+ * The Sources.
18881
+ */
18882
+ sources?: Schema$GoogleCloudNotebooklmV1alphaSource[];
18883
+ }
18884
+ /**
18885
+ * Request for NotebookService.BatchDeleteNotebooks method.
18886
+ */
18887
+ export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest {
18888
+ /**
18889
+ * Required. Full resource names of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`.
18890
+ */
18891
+ names?: string[] | null;
18892
+ }
18893
+ /**
18894
+ * Request for BatchDeleteSourcesRequest method.
18895
+ */
18896
+ export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest {
18897
+ /**
18898
+ * Required. Names of sources to be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\}
18899
+ */
18900
+ names?: string[] | null;
18901
+ }
18902
+ /**
18903
+ * Customer-managed encryption configuration for Notebooks.
18904
+ */
18905
+ export interface Schema$GoogleCloudNotebooklmV1alphaCmekConfig {
18906
+ /**
18907
+ * Required. KMS key resource name which will be used to encrypt resources `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{keyId\}`.
18908
+ */
18909
+ kmsKey?: string | null;
18910
+ }
18738
18911
  /**
18739
18912
  * Request for AudioOverviewService.CreateAudioOverview method.
18740
18913
  */
@@ -18753,6 +18926,308 @@ export declare namespace discoveryengine_v1alpha {
18753
18926
  */
18754
18927
  audioOverview?: Schema$GoogleCloudNotebooklmV1alphaAudioOverview;
18755
18928
  }
18929
+ /**
18930
+ * Failure reason containing details about why a source failed to ingest.
18931
+ */
18932
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReason {
18933
+ /**
18934
+ * An audio file transcription specific error.
18935
+ */
18936
+ audioTranscriptionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError;
18937
+ /**
18938
+ * Error if the user tries to add a source from a blocked domain.
18939
+ */
18940
+ domainBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked;
18941
+ /**
18942
+ * A google drive specific error.
18943
+ */
18944
+ googleDriveError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError;
18945
+ /**
18946
+ * Indicates an error occurred while ingesting the source.
18947
+ */
18948
+ ingestionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError;
18949
+ /**
18950
+ * Indicates that the source MIME type is blocked.
18951
+ */
18952
+ mimeTypeBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked;
18953
+ /**
18954
+ * Indicates that the source is paywalled and cannot be ingested.
18955
+ */
18956
+ paywallError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError;
18957
+ /**
18958
+ * Indicates that the policy check failed.
18959
+ */
18960
+ policyCheckFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed;
18961
+ /**
18962
+ * Indicates that the source is empty.
18963
+ */
18964
+ sourceEmpty?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty;
18965
+ /**
18966
+ * Error if the user tries to update beyond their limits.
18967
+ */
18968
+ sourceLimitExceeded?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded;
18969
+ /**
18970
+ * Indicates source word count exceeded the user's limit.
18971
+ */
18972
+ sourceTooLong?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong;
18973
+ /**
18974
+ * Indicates that the source is unreachable.
18975
+ */
18976
+ sourceUnreachable?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable;
18977
+ /**
18978
+ * Indicates an unknown error occurred.
18979
+ */
18980
+ unknown?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonUnknown;
18981
+ /**
18982
+ * Indicates an error occurred while uploading the source.
18983
+ */
18984
+ uploadError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonUploadError;
18985
+ /**
18986
+ * A youtube specific error.
18987
+ */
18988
+ youtubeError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError;
18989
+ }
18990
+ /**
18991
+ * An audio file transcription specific error.
18992
+ */
18993
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionError {
18994
+ /**
18995
+ * Could not detect language of the file (it may not be speech).
18996
+ */
18997
+ languageDetectionFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed;
18998
+ /**
18999
+ * No audio was detected in the input file (it may have been a video).
19000
+ */
19001
+ noAudioDetected?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected;
19002
+ }
19003
+ /**
19004
+ * Could not detect language of the file (it may not be speech).
19005
+ */
19006
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorLanguageDetectionFailed {
19007
+ }
19008
+ /**
19009
+ * No audio was detected in the input file.
19010
+ */
19011
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonAudioTranscriptionErrorNoAudioDetected {
19012
+ }
19013
+ /**
19014
+ * Error to indicate that the source was removed because the domain was blocked.
19015
+ */
19016
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonDomainBlocked {
19017
+ }
19018
+ /**
19019
+ * A google drive specific error.
19020
+ */
19021
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveError {
19022
+ /**
19023
+ * The user was prevented from downloading the file.
19024
+ */
19025
+ downloadPrevented?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented;
19026
+ }
19027
+ /**
19028
+ * The user was prevented from downloading the file.
19029
+ */
19030
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonGoogleDriveErrorDownloadPrevented {
19031
+ }
19032
+ /**
19033
+ * Indicates an error occurred while ingesting the source.
19034
+ */
19035
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError {
19036
+ }
19037
+ /**
19038
+ * Indicates that the source MIME type is blocked.
19039
+ */
19040
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked {
19041
+ }
19042
+ /**
19043
+ * Indicates that the source is paywalled and cannot be ingested.
19044
+ */
19045
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError {
19046
+ }
19047
+ /**
19048
+ * Indicates that the policy check failed.
19049
+ */
19050
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed {
19051
+ }
19052
+ /**
19053
+ * Indicates that the source is empty.
19054
+ */
19055
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceEmpty {
19056
+ }
19057
+ /**
19058
+ * Indicates that the user does not have space for this source.
19059
+ */
19060
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceLimitExceeded {
19061
+ }
19062
+ /**
19063
+ * Indicates source word count exceeded the user's limit.
19064
+ */
19065
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceTooLong {
19066
+ /**
19067
+ * The number of words in the source.
19068
+ */
19069
+ wordCount?: number | null;
19070
+ /**
19071
+ * The word count limit for the current user at the time of the upload.
19072
+ */
19073
+ wordLimit?: number | null;
19074
+ }
19075
+ /**
19076
+ * Indicates that the source is unreachable. This is primarily used for sources that are added via URL.
19077
+ */
19078
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonSourceUnreachable {
19079
+ /**
19080
+ * Describes why the source is unreachable.
19081
+ */
19082
+ errorDetails?: string | null;
19083
+ }
19084
+ /**
19085
+ * Indicates an unknown error occurred.
19086
+ */
19087
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonUnknown {
19088
+ }
19089
+ /**
19090
+ * Indicates an error occurred while uploading the source.
19091
+ */
19092
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonUploadError {
19093
+ }
19094
+ /**
19095
+ * A youtube specific error.
19096
+ */
19097
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeError {
19098
+ /**
19099
+ * Error to indicate that the source was removed because the video was deleted.
19100
+ */
19101
+ videoDeleted?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted;
19102
+ }
19103
+ /**
19104
+ * Error to indicate that the source was removed because the video was deleted.
19105
+ */
19106
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonYoutubeErrorVideoDeleted {
19107
+ }
19108
+ /**
19109
+ * Metadata about a google doc source.
19110
+ */
19111
+ export interface Schema$GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata {
19112
+ /**
19113
+ * Output only. The document id of the google doc.
19114
+ */
19115
+ documentId?: string | null;
19116
+ /**
19117
+ * Output only. Revision id for the doc.
19118
+ */
19119
+ revisionId?: string | null;
19120
+ }
19121
+ /**
19122
+ * Response for NotebookService.ListRecentlyViewedNotebooks method.
19123
+ */
19124
+ export interface Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse {
19125
+ /**
19126
+ * The page token, provide this to retrieve the subsequent page.
19127
+ */
19128
+ nextPageToken?: string | null;
19129
+ /**
19130
+ * The list of recently viewed notebooks.
19131
+ */
19132
+ notebooks?: Schema$GoogleCloudNotebooklmV1alphaNotebook[];
19133
+ }
19134
+ /**
19135
+ * Notebook is a resource where users can store their content (as sources) and interacts with the content.
19136
+ */
19137
+ export interface Schema$GoogleCloudNotebooklmV1alphaNotebook {
19138
+ /**
19139
+ * Output only. CMEK-related information for the Notebook.
19140
+ */
19141
+ cmekConfig?: Schema$GoogleCloudNotebooklmV1alphaCmekConfig;
19142
+ /**
19143
+ * Output only. The emoji of the notebook.
19144
+ */
19145
+ emoji?: string | null;
19146
+ /**
19147
+ * Output only. The metadata of the notebook.
19148
+ */
19149
+ metadata?: Schema$GoogleCloudNotebooklmV1alphaNotebookMetadata;
19150
+ /**
19151
+ * Identifier. The identifier of the notebook. Format: `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`. This field must be a UTF-8 encoded string.
19152
+ */
19153
+ name?: string | null;
19154
+ /**
19155
+ * Output only. Notebook id, which is the last segment of the notebook's resource name.
19156
+ */
19157
+ notebookId?: string | null;
19158
+ /**
19159
+ * Output only. List of sources in the notebook. This is an output only field.
19160
+ */
19161
+ sources?: Schema$GoogleCloudNotebooklmV1alphaSource[];
19162
+ /**
19163
+ * Optional. The title of the notebook.
19164
+ */
19165
+ title?: string | null;
19166
+ }
19167
+ /**
19168
+ * Metadata for a notebook.
19169
+ */
19170
+ export interface Schema$GoogleCloudNotebooklmV1alphaNotebookMetadata {
19171
+ /**
19172
+ * The time at which this project was created.
19173
+ */
19174
+ createTime?: string | null;
19175
+ /**
19176
+ * True if the project is shareable.
19177
+ */
19178
+ isShareable?: boolean | null;
19179
+ /**
19180
+ * True if this project is currently shared with other people, false otherwise.
19181
+ */
19182
+ isShared?: boolean | null;
19183
+ /**
19184
+ * A timestamp indicating the time that the current in session user has last viewed the project.
19185
+ */
19186
+ lastViewed?: string | null;
19187
+ }
19188
+ /**
19189
+ * Request for NotebookService.ShareNotebook method.
19190
+ */
19191
+ export interface Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest {
19192
+ /**
19193
+ * Required. The list of accounts and roles to share the notebook with.
19194
+ */
19195
+ accountAndRoles?: Schema$GoogleCloudNotebooklmV1alphaAccountAndRole[];
19196
+ /**
19197
+ * Required. Whether to notify the shared users via email.
19198
+ */
19199
+ notifyViaEmail?: boolean | null;
19200
+ }
19201
+ /**
19202
+ * Response for NotebookService.ShareNotebook method.
19203
+ */
19204
+ export interface Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse {
19205
+ }
19206
+ /**
19207
+ * Source represents a single source of content.
19208
+ */
19209
+ export interface Schema$GoogleCloudNotebooklmV1alphaSource {
19210
+ /**
19211
+ * Output only. Metadata about the source.
19212
+ */
19213
+ metadata?: Schema$GoogleCloudNotebooklmV1alphaSourceMetadata;
19214
+ /**
19215
+ * Identifier. The full resource name of the source. Format: `projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
19216
+ */
19217
+ name?: string | null;
19218
+ /**
19219
+ * Output only. Status of the source, and any failure reasons.
19220
+ */
19221
+ settings?: Schema$GoogleCloudNotebooklmV1alphaSourceSettings;
19222
+ /**
19223
+ * Optional. Output only. Source id, which is the last segment of the source's resource name.
19224
+ */
19225
+ sourceId?: Schema$GoogleCloudNotebooklmV1alphaSourceId;
19226
+ /**
19227
+ * Optional. Title of the source.
19228
+ */
19229
+ title?: string | null;
19230
+ }
18756
19231
  /**
18757
19232
  * SourceId is the last segment of the source's resource name.
18758
19233
  */
@@ -18762,6 +19237,155 @@ export declare namespace discoveryengine_v1alpha {
18762
19237
  */
18763
19238
  id?: string | null;
18764
19239
  }
19240
+ /**
19241
+ * Represents the metadata of a source and some additional information.
19242
+ */
19243
+ export interface Schema$GoogleCloudNotebooklmV1alphaSourceMetadata {
19244
+ /**
19245
+ * Metadata for an agentspace source.
19246
+ */
19247
+ agentspaceMetadata?: Schema$GoogleCloudNotebooklmV1alphaAgentspaceMetadata;
19248
+ /**
19249
+ * Metadata for a google doc source.
19250
+ */
19251
+ googleDocsMetadata?: Schema$GoogleCloudNotebooklmV1alphaGoogleDocsSourceMetadata;
19252
+ /**
19253
+ * The timestamp the source was added.
19254
+ */
19255
+ sourceAddedTimestamp?: string | null;
19256
+ /**
19257
+ * The number of tokens in the source.
19258
+ */
19259
+ tokenCount?: number | null;
19260
+ /**
19261
+ * The word count of the source.
19262
+ */
19263
+ wordCount?: number | null;
19264
+ /**
19265
+ * Metadata for a youtube video source.
19266
+ */
19267
+ youtubeMetadata?: Schema$GoogleCloudNotebooklmV1alphaYoutubeMetadata;
19268
+ }
19269
+ /**
19270
+ * Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request).
19271
+ */
19272
+ export interface Schema$GoogleCloudNotebooklmV1alphaSourceSettings {
19273
+ /**
19274
+ * Failure reason containing details about why a source failed to ingest.
19275
+ */
19276
+ failureReason?: Schema$GoogleCloudNotebooklmV1alphaFailureReason;
19277
+ /**
19278
+ * Status of the source.
19279
+ */
19280
+ status?: string | null;
19281
+ }
19282
+ /**
19283
+ * The "Content" messages refer to data the user wants to upload.
19284
+ */
19285
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContent {
19286
+ /**
19287
+ * Agentspace content uploaded as source.
19288
+ */
19289
+ agentspaceContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent;
19290
+ /**
19291
+ * The content from Google Drive.
19292
+ */
19293
+ googleDriveContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent;
19294
+ /**
19295
+ * The text content uploaded as source.
19296
+ */
19297
+ textContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentTextContent;
19298
+ /**
19299
+ * The video content uploaded as source.
19300
+ */
19301
+ videoContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentVideoContent;
19302
+ /**
19303
+ * The web content uploaded as source.
19304
+ */
19305
+ webContent?: Schema$GoogleCloudNotebooklmV1alphaUserContentWebContent;
19306
+ }
19307
+ /**
19308
+ * Agentspace content uploaded as source.
19309
+ */
19310
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentAgentspaceContent {
19311
+ /**
19312
+ * Optional. The full resource name of the Agentspace document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`.
19313
+ */
19314
+ documentName?: string | null;
19315
+ /**
19316
+ * Optional. Engine to verify the permission of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`.
19317
+ */
19318
+ engineName?: string | null;
19319
+ /**
19320
+ * Optional. Resource name of the idea forge instance. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/sessions/{session\}/ideaForgeInstances/{instance\}`
19321
+ */
19322
+ ideaforgeIdeaName?: string | null;
19323
+ }
19324
+ /**
19325
+ * The content from Google Drive.
19326
+ */
19327
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentGoogleDriveContent {
19328
+ /**
19329
+ * The document id of the selected document.
19330
+ */
19331
+ documentId?: string | null;
19332
+ /**
19333
+ * The mime type of the selected document. This can be used to differentiate type of content selected in the drive picker. Use application/vnd.google-apps.document for Google Docs or application/vnd.google-apps.presentation for Google Slides.
19334
+ */
19335
+ mimeType?: string | null;
19336
+ /**
19337
+ * The name to be displayed for the source.
19338
+ */
19339
+ sourceName?: string | null;
19340
+ }
19341
+ /**
19342
+ * The text content uploaded as source.
19343
+ */
19344
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentTextContent {
19345
+ /**
19346
+ * The name to be displayed for the source.
19347
+ */
19348
+ content?: string | null;
19349
+ /**
19350
+ * The display name of the text source.
19351
+ */
19352
+ sourceName?: string | null;
19353
+ }
19354
+ /**
19355
+ * Video content uploaded as source.
19356
+ */
19357
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentVideoContent {
19358
+ /**
19359
+ * The youtube url of the video content.
19360
+ */
19361
+ youtubeUrl?: string | null;
19362
+ }
19363
+ /**
19364
+ * The web content uploaded as source.
19365
+ */
19366
+ export interface Schema$GoogleCloudNotebooklmV1alphaUserContentWebContent {
19367
+ /**
19368
+ * The name to be displayed for the source.
19369
+ */
19370
+ sourceName?: string | null;
19371
+ /**
19372
+ * If URL is supplied, will fetch the webpage in the backend.
19373
+ */
19374
+ url?: string | null;
19375
+ }
19376
+ /**
19377
+ * Metadata about a youtube video source.
19378
+ */
19379
+ export interface Schema$GoogleCloudNotebooklmV1alphaYoutubeMetadata {
19380
+ /**
19381
+ * Output only. The channel name of the youtube video.
19382
+ */
19383
+ channelName?: string | null;
19384
+ /**
19385
+ * Output only. The id of the youtube video.
19386
+ */
19387
+ videoId?: string | null;
19388
+ }
18765
19389
  /**
18766
19390
  * Associates `members`, or principals, with a `role`.
18767
19391
  */
@@ -51915,7 +52539,423 @@ export declare namespace discoveryengine_v1alpha {
51915
52539
  export class Resource$Projects$Locations$Notebooks {
51916
52540
  context: APIRequestContext;
51917
52541
  audioOverviews: Resource$Projects$Locations$Notebooks$Audiooverviews;
52542
+ sources: Resource$Projects$Locations$Notebooks$Sources;
51918
52543
  constructor(context: APIRequestContext);
52544
+ /**
52545
+ * Batch deletes Notebooks.
52546
+ * @example
52547
+ * ```js
52548
+ * // Before running the sample:
52549
+ * // - Enable the API at:
52550
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
52551
+ * // - Login into gcloud by running:
52552
+ * // ```sh
52553
+ * // $ gcloud auth application-default login
52554
+ * // ```
52555
+ * // - Install the npm module by running:
52556
+ * // ```sh
52557
+ * // $ npm install googleapis
52558
+ * // ```
52559
+ *
52560
+ * const {google} = require('googleapis');
52561
+ * const discoveryengine = google.discoveryengine('v1alpha');
52562
+ *
52563
+ * async function main() {
52564
+ * const auth = new google.auth.GoogleAuth({
52565
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
52566
+ * scopes: [
52567
+ * 'https://www.googleapis.com/auth/cloud-platform',
52568
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
52569
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
52570
+ * ],
52571
+ * });
52572
+ *
52573
+ * // Acquire an auth client, and bind it to all future calls
52574
+ * const authClient = await auth.getClient();
52575
+ * google.options({auth: authClient});
52576
+ *
52577
+ * // Do the magic
52578
+ * const res = await discoveryengine.projects.locations.notebooks.batchDelete({
52579
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
52580
+ * parent: 'projects/my-project/locations/my-location',
52581
+ *
52582
+ * // Request body metadata
52583
+ * requestBody: {
52584
+ * // request body parameters
52585
+ * // {
52586
+ * // "names": []
52587
+ * // }
52588
+ * },
52589
+ * });
52590
+ * console.log(res.data);
52591
+ *
52592
+ * // Example response
52593
+ * // {}
52594
+ * }
52595
+ *
52596
+ * main().catch(e => {
52597
+ * console.error(e);
52598
+ * throw e;
52599
+ * });
52600
+ *
52601
+ * ```
52602
+ *
52603
+ * @param params - Parameters for request
52604
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
52605
+ * @param callback - Optional callback that handles the response.
52606
+ * @returns A promise if used with async/await, or void if used with a callback.
52607
+ */
52608
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
52609
+ batchDelete(params?: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
52610
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
52611
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
52612
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Batchdelete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
52613
+ batchDelete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
52614
+ /**
52615
+ * Creates a notebook.
52616
+ * @example
52617
+ * ```js
52618
+ * // Before running the sample:
52619
+ * // - Enable the API at:
52620
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
52621
+ * // - Login into gcloud by running:
52622
+ * // ```sh
52623
+ * // $ gcloud auth application-default login
52624
+ * // ```
52625
+ * // - Install the npm module by running:
52626
+ * // ```sh
52627
+ * // $ npm install googleapis
52628
+ * // ```
52629
+ *
52630
+ * const {google} = require('googleapis');
52631
+ * const discoveryengine = google.discoveryengine('v1alpha');
52632
+ *
52633
+ * async function main() {
52634
+ * const auth = new google.auth.GoogleAuth({
52635
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
52636
+ * scopes: [
52637
+ * 'https://www.googleapis.com/auth/cloud-platform',
52638
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
52639
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
52640
+ * ],
52641
+ * });
52642
+ *
52643
+ * // Acquire an auth client, and bind it to all future calls
52644
+ * const authClient = await auth.getClient();
52645
+ * google.options({auth: authClient});
52646
+ *
52647
+ * // Do the magic
52648
+ * const res = await discoveryengine.projects.locations.notebooks.create({
52649
+ * // Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
52650
+ * parent: 'projects/my-project/locations/my-location',
52651
+ *
52652
+ * // Request body metadata
52653
+ * requestBody: {
52654
+ * // request body parameters
52655
+ * // {
52656
+ * // "cmekConfig": {},
52657
+ * // "emoji": "my_emoji",
52658
+ * // "metadata": {},
52659
+ * // "name": "my_name",
52660
+ * // "notebookId": "my_notebookId",
52661
+ * // "sources": [],
52662
+ * // "title": "my_title"
52663
+ * // }
52664
+ * },
52665
+ * });
52666
+ * console.log(res.data);
52667
+ *
52668
+ * // Example response
52669
+ * // {
52670
+ * // "cmekConfig": {},
52671
+ * // "emoji": "my_emoji",
52672
+ * // "metadata": {},
52673
+ * // "name": "my_name",
52674
+ * // "notebookId": "my_notebookId",
52675
+ * // "sources": [],
52676
+ * // "title": "my_title"
52677
+ * // }
52678
+ * }
52679
+ *
52680
+ * main().catch(e => {
52681
+ * console.error(e);
52682
+ * throw e;
52683
+ * });
52684
+ *
52685
+ * ```
52686
+ *
52687
+ * @param params - Parameters for request
52688
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
52689
+ * @param callback - Optional callback that handles the response.
52690
+ * @returns A promise if used with async/await, or void if used with a callback.
52691
+ */
52692
+ create(params: Params$Resource$Projects$Locations$Notebooks$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
52693
+ create(params?: Params$Resource$Projects$Locations$Notebooks$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaNotebook>>;
52694
+ create(params: Params$Resource$Projects$Locations$Notebooks$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
52695
+ create(params: Params$Resource$Projects$Locations$Notebooks$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52696
+ create(params: Params$Resource$Projects$Locations$Notebooks$Create, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52697
+ create(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52698
+ /**
52699
+ * Gets a notebook.
52700
+ * @example
52701
+ * ```js
52702
+ * // Before running the sample:
52703
+ * // - Enable the API at:
52704
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
52705
+ * // - Login into gcloud by running:
52706
+ * // ```sh
52707
+ * // $ gcloud auth application-default login
52708
+ * // ```
52709
+ * // - Install the npm module by running:
52710
+ * // ```sh
52711
+ * // $ npm install googleapis
52712
+ * // ```
52713
+ *
52714
+ * const {google} = require('googleapis');
52715
+ * const discoveryengine = google.discoveryengine('v1alpha');
52716
+ *
52717
+ * async function main() {
52718
+ * const auth = new google.auth.GoogleAuth({
52719
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
52720
+ * scopes: [
52721
+ * 'https://www.googleapis.com/auth/cloud-platform',
52722
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
52723
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
52724
+ * ],
52725
+ * });
52726
+ *
52727
+ * // Acquire an auth client, and bind it to all future calls
52728
+ * const authClient = await auth.getClient();
52729
+ * google.options({auth: authClient});
52730
+ *
52731
+ * // Do the magic
52732
+ * const res = await discoveryengine.projects.locations.notebooks.get({
52733
+ * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`.
52734
+ * name: 'projects/my-project/locations/my-location/notebooks/my-notebook',
52735
+ * });
52736
+ * console.log(res.data);
52737
+ *
52738
+ * // Example response
52739
+ * // {
52740
+ * // "cmekConfig": {},
52741
+ * // "emoji": "my_emoji",
52742
+ * // "metadata": {},
52743
+ * // "name": "my_name",
52744
+ * // "notebookId": "my_notebookId",
52745
+ * // "sources": [],
52746
+ * // "title": "my_title"
52747
+ * // }
52748
+ * }
52749
+ *
52750
+ * main().catch(e => {
52751
+ * console.error(e);
52752
+ * throw e;
52753
+ * });
52754
+ *
52755
+ * ```
52756
+ *
52757
+ * @param params - Parameters for request
52758
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
52759
+ * @param callback - Optional callback that handles the response.
52760
+ * @returns A promise if used with async/await, or void if used with a callback.
52761
+ */
52762
+ get(params: Params$Resource$Projects$Locations$Notebooks$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
52763
+ get(params?: Params$Resource$Projects$Locations$Notebooks$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaNotebook>>;
52764
+ get(params: Params$Resource$Projects$Locations$Notebooks$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
52765
+ get(params: Params$Resource$Projects$Locations$Notebooks$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52766
+ get(params: Params$Resource$Projects$Locations$Notebooks$Get, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52767
+ get(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaNotebook>): void;
52768
+ /**
52769
+ * Lists the notebooks ordered by last view time.
52770
+ * @example
52771
+ * ```js
52772
+ * // Before running the sample:
52773
+ * // - Enable the API at:
52774
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
52775
+ * // - Login into gcloud by running:
52776
+ * // ```sh
52777
+ * // $ gcloud auth application-default login
52778
+ * // ```
52779
+ * // - Install the npm module by running:
52780
+ * // ```sh
52781
+ * // $ npm install googleapis
52782
+ * // ```
52783
+ *
52784
+ * const {google} = require('googleapis');
52785
+ * const discoveryengine = google.discoveryengine('v1alpha');
52786
+ *
52787
+ * async function main() {
52788
+ * const auth = new google.auth.GoogleAuth({
52789
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
52790
+ * scopes: [
52791
+ * 'https://www.googleapis.com/auth/cloud-platform',
52792
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
52793
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
52794
+ * ],
52795
+ * });
52796
+ *
52797
+ * // Acquire an auth client, and bind it to all future calls
52798
+ * const authClient = await auth.getClient();
52799
+ * google.options({auth: authClient});
52800
+ *
52801
+ * // Do the magic
52802
+ * const res =
52803
+ * await discoveryengine.projects.locations.notebooks.listRecentlyViewed({
52804
+ * // Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value.
52805
+ * pageSize: 'placeholder-value',
52806
+ * // Optional. The page token, provide this to retrieve the subsequent page.
52807
+ * pageToken: 'placeholder-value',
52808
+ * // Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
52809
+ * parent: 'projects/my-project/locations/my-location',
52810
+ * });
52811
+ * console.log(res.data);
52812
+ *
52813
+ * // Example response
52814
+ * // {
52815
+ * // "nextPageToken": "my_nextPageToken",
52816
+ * // "notebooks": []
52817
+ * // }
52818
+ * }
52819
+ *
52820
+ * main().catch(e => {
52821
+ * console.error(e);
52822
+ * throw e;
52823
+ * });
52824
+ *
52825
+ * ```
52826
+ *
52827
+ * @param params - Parameters for request
52828
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
52829
+ * @param callback - Optional callback that handles the response.
52830
+ * @returns A promise if used with async/await, or void if used with a callback.
52831
+ */
52832
+ listRecentlyViewed(params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
52833
+ listRecentlyViewed(params?: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse>>;
52834
+ listRecentlyViewed(params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
52835
+ listRecentlyViewed(params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse>): void;
52836
+ listRecentlyViewed(params: Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse>): void;
52837
+ listRecentlyViewed(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaListRecentlyViewedNotebooksResponse>): void;
52838
+ /**
52839
+ * Shares a notebook to other accounts.
52840
+ * @example
52841
+ * ```js
52842
+ * // Before running the sample:
52843
+ * // - Enable the API at:
52844
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
52845
+ * // - Login into gcloud by running:
52846
+ * // ```sh
52847
+ * // $ gcloud auth application-default login
52848
+ * // ```
52849
+ * // - Install the npm module by running:
52850
+ * // ```sh
52851
+ * // $ npm install googleapis
52852
+ * // ```
52853
+ *
52854
+ * const {google} = require('googleapis');
52855
+ * const discoveryengine = google.discoveryengine('v1alpha');
52856
+ *
52857
+ * async function main() {
52858
+ * const auth = new google.auth.GoogleAuth({
52859
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
52860
+ * scopes: [
52861
+ * 'https://www.googleapis.com/auth/cloud-platform',
52862
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
52863
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
52864
+ * ],
52865
+ * });
52866
+ *
52867
+ * // Acquire an auth client, and bind it to all future calls
52868
+ * const authClient = await auth.getClient();
52869
+ * google.options({auth: authClient});
52870
+ *
52871
+ * // Do the magic
52872
+ * const res = await discoveryengine.projects.locations.notebooks.share({
52873
+ * // Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`.
52874
+ * name: 'projects/my-project/locations/my-location/notebooks/my-notebook',
52875
+ *
52876
+ * // Request body metadata
52877
+ * requestBody: {
52878
+ * // request body parameters
52879
+ * // {
52880
+ * // "accountAndRoles": [],
52881
+ * // "notifyViaEmail": false
52882
+ * // }
52883
+ * },
52884
+ * });
52885
+ * console.log(res.data);
52886
+ *
52887
+ * // Example response
52888
+ * // {}
52889
+ * }
52890
+ *
52891
+ * main().catch(e => {
52892
+ * console.error(e);
52893
+ * throw e;
52894
+ * });
52895
+ *
52896
+ * ```
52897
+ *
52898
+ * @param params - Parameters for request
52899
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
52900
+ * @param callback - Optional callback that handles the response.
52901
+ * @returns A promise if used with async/await, or void if used with a callback.
52902
+ */
52903
+ share(params: Params$Resource$Projects$Locations$Notebooks$Share, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
52904
+ share(params?: Params$Resource$Projects$Locations$Notebooks$Share, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse>>;
52905
+ share(params: Params$Resource$Projects$Locations$Notebooks$Share, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
52906
+ share(params: Params$Resource$Projects$Locations$Notebooks$Share, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse>): void;
52907
+ share(params: Params$Resource$Projects$Locations$Notebooks$Share, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse>): void;
52908
+ share(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaShareNotebookResponse>): void;
52909
+ }
52910
+ export interface Params$Resource$Projects$Locations$Notebooks$Batchdelete extends StandardParameters {
52911
+ /**
52912
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
52913
+ */
52914
+ parent?: string;
52915
+ /**
52916
+ * Request body metadata
52917
+ */
52918
+ requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteNotebooksRequest;
52919
+ }
52920
+ export interface Params$Resource$Projects$Locations$Notebooks$Create extends StandardParameters {
52921
+ /**
52922
+ * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`.
52923
+ */
52924
+ parent?: string;
52925
+ /**
52926
+ * Request body metadata
52927
+ */
52928
+ requestBody?: Schema$GoogleCloudNotebooklmV1alphaNotebook;
52929
+ }
52930
+ export interface Params$Resource$Projects$Locations$Notebooks$Get extends StandardParameters {
52931
+ /**
52932
+ * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`.
52933
+ */
52934
+ name?: string;
52935
+ }
52936
+ export interface Params$Resource$Projects$Locations$Notebooks$Listrecentlyviewed extends StandardParameters {
52937
+ /**
52938
+ * Optional. Maximum number of Notebooks to return. If unspecified, defaults to "500". The maximum allowed value is "500". If this field is negative, will use the default value.
52939
+ */
52940
+ pageSize?: number;
52941
+ /**
52942
+ * Optional. The page token, provide this to retrieve the subsequent page.
52943
+ */
52944
+ pageToken?: string;
52945
+ /**
52946
+ * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}`.
52947
+ */
52948
+ parent?: string;
52949
+ }
52950
+ export interface Params$Resource$Projects$Locations$Notebooks$Share extends StandardParameters {
52951
+ /**
52952
+ * Required. Full resource name of Notebook, such as `projects/{project\}/locations/{location\}/notebooks/{notebook_id\}`.
52953
+ */
52954
+ name?: string;
52955
+ /**
52956
+ * Request body metadata
52957
+ */
52958
+ requestBody?: Schema$GoogleCloudNotebooklmV1alphaShareNotebookRequest;
51919
52959
  }
51920
52960
  export class Resource$Projects$Locations$Notebooks$Audiooverviews {
51921
52961
  context: APIRequestContext;
@@ -52073,6 +53113,249 @@ export declare namespace discoveryengine_v1alpha {
52073
53113
  */
52074
53114
  name?: string;
52075
53115
  }
53116
+ export class Resource$Projects$Locations$Notebooks$Sources {
53117
+ context: APIRequestContext;
53118
+ constructor(context: APIRequestContext);
53119
+ /**
53120
+ * Creates a list of Sources.
53121
+ * @example
53122
+ * ```js
53123
+ * // Before running the sample:
53124
+ * // - Enable the API at:
53125
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
53126
+ * // - Login into gcloud by running:
53127
+ * // ```sh
53128
+ * // $ gcloud auth application-default login
53129
+ * // ```
53130
+ * // - Install the npm module by running:
53131
+ * // ```sh
53132
+ * // $ npm install googleapis
53133
+ * // ```
53134
+ *
53135
+ * const {google} = require('googleapis');
53136
+ * const discoveryengine = google.discoveryengine('v1alpha');
53137
+ *
53138
+ * async function main() {
53139
+ * const auth = new google.auth.GoogleAuth({
53140
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
53141
+ * scopes: [
53142
+ * 'https://www.googleapis.com/auth/cloud-platform',
53143
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
53144
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
53145
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
53146
+ * ],
53147
+ * });
53148
+ *
53149
+ * // Acquire an auth client, and bind it to all future calls
53150
+ * const authClient = await auth.getClient();
53151
+ * google.options({auth: authClient});
53152
+ *
53153
+ * // Do the magic
53154
+ * const res =
53155
+ * await discoveryengine.projects.locations.notebooks.sources.batchCreate({
53156
+ * // Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}
53157
+ * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook',
53158
+ *
53159
+ * // Request body metadata
53160
+ * requestBody: {
53161
+ * // request body parameters
53162
+ * // {
53163
+ * // "userContents": []
53164
+ * // }
53165
+ * },
53166
+ * });
53167
+ * console.log(res.data);
53168
+ *
53169
+ * // Example response
53170
+ * // {
53171
+ * // "sources": []
53172
+ * // }
53173
+ * }
53174
+ *
53175
+ * main().catch(e => {
53176
+ * console.error(e);
53177
+ * throw e;
53178
+ * });
53179
+ *
53180
+ * ```
53181
+ *
53182
+ * @param params - Parameters for request
53183
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
53184
+ * @param callback - Optional callback that handles the response.
53185
+ * @returns A promise if used with async/await, or void if used with a callback.
53186
+ */
53187
+ batchCreate(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
53188
+ batchCreate(params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse>>;
53189
+ batchCreate(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
53190
+ batchCreate(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse>): void;
53191
+ batchCreate(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse>): void;
53192
+ batchCreate(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesResponse>): void;
53193
+ /**
53194
+ * Deletes multiple sources
53195
+ * @example
53196
+ * ```js
53197
+ * // Before running the sample:
53198
+ * // - Enable the API at:
53199
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
53200
+ * // - Login into gcloud by running:
53201
+ * // ```sh
53202
+ * // $ gcloud auth application-default login
53203
+ * // ```
53204
+ * // - Install the npm module by running:
53205
+ * // ```sh
53206
+ * // $ npm install googleapis
53207
+ * // ```
53208
+ *
53209
+ * const {google} = require('googleapis');
53210
+ * const discoveryengine = google.discoveryengine('v1alpha');
53211
+ *
53212
+ * async function main() {
53213
+ * const auth = new google.auth.GoogleAuth({
53214
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
53215
+ * scopes: [
53216
+ * 'https://www.googleapis.com/auth/cloud-platform',
53217
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
53218
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
53219
+ * ],
53220
+ * });
53221
+ *
53222
+ * // Acquire an auth client, and bind it to all future calls
53223
+ * const authClient = await auth.getClient();
53224
+ * google.options({auth: authClient});
53225
+ *
53226
+ * // Do the magic
53227
+ * const res =
53228
+ * await discoveryengine.projects.locations.notebooks.sources.batchDelete({
53229
+ * // Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}
53230
+ * parent: 'projects/my-project/locations/my-location/notebooks/my-notebook',
53231
+ *
53232
+ * // Request body metadata
53233
+ * requestBody: {
53234
+ * // request body parameters
53235
+ * // {
53236
+ * // "names": []
53237
+ * // }
53238
+ * },
53239
+ * });
53240
+ * console.log(res.data);
53241
+ *
53242
+ * // Example response
53243
+ * // {}
53244
+ * }
53245
+ *
53246
+ * main().catch(e => {
53247
+ * console.error(e);
53248
+ * throw e;
53249
+ * });
53250
+ *
53251
+ * ```
53252
+ *
53253
+ * @param params - Parameters for request
53254
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
53255
+ * @param callback - Optional callback that handles the response.
53256
+ * @returns A promise if used with async/await, or void if used with a callback.
53257
+ */
53258
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
53259
+ batchDelete(params?: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
53260
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
53261
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
53262
+ batchDelete(params: Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete, callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
53263
+ batchDelete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
53264
+ /**
53265
+ * Gets a Source.
53266
+ * @example
53267
+ * ```js
53268
+ * // Before running the sample:
53269
+ * // - Enable the API at:
53270
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
53271
+ * // - Login into gcloud by running:
53272
+ * // ```sh
53273
+ * // $ gcloud auth application-default login
53274
+ * // ```
53275
+ * // - Install the npm module by running:
53276
+ * // ```sh
53277
+ * // $ npm install googleapis
53278
+ * // ```
53279
+ *
53280
+ * const {google} = require('googleapis');
53281
+ * const discoveryengine = google.discoveryengine('v1alpha');
53282
+ *
53283
+ * async function main() {
53284
+ * const auth = new google.auth.GoogleAuth({
53285
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
53286
+ * scopes: [
53287
+ * 'https://www.googleapis.com/auth/cloud-platform',
53288
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
53289
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
53290
+ * ],
53291
+ * });
53292
+ *
53293
+ * // Acquire an auth client, and bind it to all future calls
53294
+ * const authClient = await auth.getClient();
53295
+ * google.options({auth: authClient});
53296
+ *
53297
+ * // Do the magic
53298
+ * const res = await discoveryengine.projects.locations.notebooks.sources.get({
53299
+ * // Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\}
53300
+ * name: 'projects/my-project/locations/my-location/notebooks/my-notebook/sources/my-source',
53301
+ * });
53302
+ * console.log(res.data);
53303
+ *
53304
+ * // Example response
53305
+ * // {
53306
+ * // "metadata": {},
53307
+ * // "name": "my_name",
53308
+ * // "settings": {},
53309
+ * // "sourceId": {},
53310
+ * // "title": "my_title"
53311
+ * // }
53312
+ * }
53313
+ *
53314
+ * main().catch(e => {
53315
+ * console.error(e);
53316
+ * throw e;
53317
+ * });
53318
+ *
53319
+ * ```
53320
+ *
53321
+ * @param params - Parameters for request
53322
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
53323
+ * @param callback - Optional callback that handles the response.
53324
+ * @returns A promise if used with async/await, or void if used with a callback.
53325
+ */
53326
+ get(params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
53327
+ get(params?: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudNotebooklmV1alphaSource>>;
53328
+ get(params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
53329
+ get(params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaSource>, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaSource>): void;
53330
+ get(params: Params$Resource$Projects$Locations$Notebooks$Sources$Get, callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaSource>): void;
53331
+ get(callback: BodyResponseCallback<Schema$GoogleCloudNotebooklmV1alphaSource>): void;
53332
+ }
53333
+ export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchcreate extends StandardParameters {
53334
+ /**
53335
+ * Required. The parent resource where the sources will be created. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}
53336
+ */
53337
+ parent?: string;
53338
+ /**
53339
+ * Request body metadata
53340
+ */
53341
+ requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchCreateSourcesRequest;
53342
+ }
53343
+ export interface Params$Resource$Projects$Locations$Notebooks$Sources$Batchdelete extends StandardParameters {
53344
+ /**
53345
+ * Required. The parent resource where the sources will be deleted. Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}
53346
+ */
53347
+ parent?: string;
53348
+ /**
53349
+ * Request body metadata
53350
+ */
53351
+ requestBody?: Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest;
53352
+ }
53353
+ export interface Params$Resource$Projects$Locations$Notebooks$Sources$Get extends StandardParameters {
53354
+ /**
53355
+ * Required. The resource name for source Format: projects/{project\}/locations/{location\}/notebooks/{notebook\}/sources/{source\}
53356
+ */
53357
+ name?: string;
53358
+ }
52076
53359
  export class Resource$Projects$Locations$Operations {
52077
53360
  context: APIRequestContext;
52078
53361
  constructor(context: APIRequestContext);