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
|
<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> . <a href="discoveryengine_v1alpha.projects.locations.notebooks.sources.html">sources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchCreate">batchCreate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a list of Sources.</p>
<p class="toc_element">
<code><a href="#batchDelete">batchDelete(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes multiple sources</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Source.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchCreate">batchCreate(parent, body=None, x__xgafv=None)</code>
<pre>Creates a list of Sources.
Args:
parent: string, Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
body: object, The request body.
The object takes the form of:
{ # Request for SourceService.BatchCreateSources method.
"userContents": [ # Required. The UserContents to be uploaded.
{ # The "Content" messages refer to data the user wants to upload.
"agentspaceContent": { # Agentspace content uploaded as source. # Agentspace content uploaded as source.
"documentName": "A String", # Optional. The full resource name of the Agentspace document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.
"engineName": "A String", # Optional. Engine to verify the permission of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`.
"ideaforgeIdeaName": "A String", # Optional. Resource name of the idea forge instance. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/ideaForgeInstances/{instance}`
},
"googleDriveContent": { # The content from Google Drive. # The content from Google Drive.
"documentId": "A String", # The document id of the selected document.
"mimeType": "A String", # 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.
"sourceName": "A String", # The name to be displayed for the source.
},
"textContent": { # The text content uploaded as source. # The text content uploaded as source.
"content": "A String", # The name to be displayed for the source.
"sourceName": "A String", # The display name of the text source.
},
"videoContent": { # Video content uploaded as source. # The video content uploaded as source.
"youtubeUrl": "A String", # The youtube url of the video content.
},
"webContent": { # The web content uploaded as source. # The web content uploaded as source.
"sourceName": "A String", # The name to be displayed for the source.
"url": "A String", # If URL is supplied, will fetch the webpage in the backend.
},
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for SourceService.BatchCreateSources method.
"sources": [ # The Sources.
{ # 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.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="batchDelete">batchDelete(parent, body=None, x__xgafv=None)</code>
<pre>Deletes multiple sources
Args:
parent: string, Required. The parent resource where the sources will be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook} (required)
body: object, The request body.
The object takes the form of:
{ # Request for SourceService.BatchDeleteSourcesRequest method.
"names": [ # Required. Names of sources to be deleted. Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source}
"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="get">get(name, x__xgafv=None)</code>
<pre>Gets a Source.
Args:
name: string, Required. The resource name for source Format: projects/{project}/locations/{location}/notebooks/{notebook}/sources/{source} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
}</pre>
</div>
</body></html>
|
