1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.notebooks.html">notebooks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html">audioOverviews()</a></code>
</p>
<p class="firstline">Returns the audioOverviews Resource.</p>
<p class="toc_element">
<code><a href="discoveryengine_v1alpha.projects.locations.notebooks.sources.html">sources()</a></code>
</p>
<p class="firstline">Returns the sources Resource.</p>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch deletes Notebooks.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a notebook.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a notebook.</p>
<p class="toc_element">
<code><a href="#listRecentlyViewed">listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the notebooks ordered by last view time.</p>
<p class="toc_element">
<code><a href="#listRecentlyViewed_next">listRecentlyViewed_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#share">share(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Shares a notebook to other accounts.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Batch deletes Notebooks.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for NotebookService.BatchDeleteNotebooks method.
"names": [ # Required. Full resource names of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a notebook.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # 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.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # 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.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a notebook.
Args:
name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # 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.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
}</pre>
</div>
<div class="method">
<code class="details" id="listRecentlyViewed">listRecentlyViewed(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the notebooks ordered by last view time.
Args:
parent: string, Required. The parent branch resource name, such as `projects/{project}/locations/{location}`. (required)
pageSize: integer, 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.
pageToken: string, Optional. The page token, provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for NotebookService.ListRecentlyViewedNotebooks method.
"nextPageToken": "A String", # The page token, provide this to retrieve the subsequent page.
"notebooks": [ # The list of recently viewed notebooks.
{ # Notebook is a resource where users can store their content (as sources) and interacts with the content.
"cmekConfig": { # Customer-managed encryption configuration for Notebooks. # Output only. CMEK-related information for the Notebook.
"kmsKey": "A String", # Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
},
"emoji": "A String", # Output only. The emoji of the notebook.
"metadata": { # Metadata for a notebook. # Output only. The metadata of the notebook.
"createTime": "A String", # The time at which this project was created.
"isShareable": True or False, # True if the project is shareable.
"isShared": True or False, # True if this project is currently shared with other people, false otherwise.
"lastViewed": "A String", # A timestamp indicating the time that the current in session user has last viewed the project.
},
"name": "A String", # Identifier. The identifier of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook_id}`. This field must be a UTF-8 encoded string.
"notebookId": "A String", # Output only. Notebook id, which is the last segment of the notebook's resource name.
"sources": [ # Output only. List of sources in the notebook. This is an output only field.
{ # Source represents a single source of content.
"metadata": { # Represents the metadata of a source and some additional information. # Output only. Metadata about the source.
"agentspaceMetadata": { # Metadata about an agentspace source. # Metadata for an agentspace source.
"documentName": "A String", # Output only. The full document name in Agentspace.
"documentTitle": "A String", # Output only. The title of the document.
},
"googleDocsMetadata": { # Metadata about a google doc source. # Metadata for a google doc source.
"documentId": "A String", # Output only. The document id of the google doc.
"revisionId": "A String", # Output only. Revision id for the doc.
},
"sourceAddedTimestamp": "A String", # The timestamp the source was added.
"tokenCount": 42, # The number of tokens in the source.
"wordCount": 42, # The word count of the source.
"youtubeMetadata": { # Metadata about a youtube video source. # Metadata for a youtube video source.
"channelName": "A String", # Output only. The channel name of the youtube video.
"videoId": "A String", # Output only. The id of the youtube video.
},
},
"name": "A String", # 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.
"settings": { # Allows extension of Source Settings in the BatchCreateSources (Formerly AddSource request). # Output only. Status of the source, and any failure reasons.
"failureReason": { # Failure reason containing details about why a source failed to ingest. # Failure reason containing details about why a source failed to ingest.
"audioTranscriptionError": { # An audio file transcription specific error. # An audio file transcription specific error.
"languageDetectionFailed": { # Could not detect language of the file (it may not be speech). # Could not detect language of the file (it may not be speech).
},
"noAudioDetected": { # No audio was detected in the input file. # No audio was detected in the input file (it may have been a video).
},
},
"domainBlocked": { # Error to indicate that the source was removed because the domain was blocked. # Error if the user tries to add a source from a blocked domain.
},
"googleDriveError": { # A google drive specific error. # A google drive specific error.
"downloadPrevented": { # The user was prevented from downloading the file. # The user was prevented from downloading the file.
},
},
"ingestionError": { # Indicates an error occurred while ingesting the source. # Indicates an error occurred while ingesting the source.
},
"paywallError": { # Indicates that the source is paywalled and cannot be ingested. # Indicates that the source is paywalled and cannot be ingested.
},
"sourceEmpty": { # Indicates that the source is empty. # Indicates that the source is empty.
},
"sourceLimitExceeded": { # Indicates that the user does not have space for this source. # Error if the user tries to update beyond their limits.
},
"sourceTooLong": { # Indicates source word count exceeded the user's limit. # Indicates source word count exceeded the user's limit.
"wordCount": 42, # The number of words in the source.
"wordLimit": 42, # The word count limit for the current user at the time of the upload.
},
"sourceUnreachable": { # Indicates that the source is unreachable. This is primarily used for sources that are added via URL. # Indicates that the source is unreachable.
"errorDetails": "A String", # Describes why the source is unreachable.
},
"unknown": { # Indicates an unknown error occurred. # Indicates an unknown error occurred.
},
"uploadError": { # Indicates an error occurred while uploading the source. # Indicates an error occurred while uploading the source.
},
"youtubeError": { # A youtube specific error. # A youtube specific error.
"videoDeleted": { # Error to indicate that the source was removed because the video was deleted. # Error to indicate that the source was removed because the video was deleted.
},
},
},
"status": "A String", # Status of the source.
},
"sourceId": { # SourceId is the last segment of the source's resource name. # Optional. Output only. Source id, which is the last segment of the source's resource name.
"id": "A String", # The id of the source.
},
"title": "A String", # Optional. Title of the source.
},
],
"title": "A String", # Optional. The title of the notebook.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="listRecentlyViewed_next">listRecentlyViewed_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="share">share(name, body=None, x__xgafv=None)</code>
<pre>Shares a notebook to other accounts.
Args:
name: string, Required. Full resource name of Notebook, such as `projects/{project}/locations/{location}/notebooks/{notebook_id}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request for NotebookService.ShareNotebook method.
"accountAndRoles": [ # Required. The list of accounts and roles to share the notebook with.
{ # Account and role information.
"email": "A String", # Required. The email address associated with the account.
"role": "A String", # Required. The role in the notebook.
},
],
"notifyViaEmail": True or False, # Required. Whether to notify the shared users via email.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for NotebookService.ShareNotebook method.
}</pre>
</div>
</body></html>
|
