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
|
<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="aiplatform_v1.html">Vertex AI API</a> . <a href="aiplatform_v1.projects.html">projects</a> . <a href="aiplatform_v1.projects.locations.html">locations</a> . <a href="aiplatform_v1.projects.locations.ragCorpora.html">ragCorpora</a> . <a href="aiplatform_v1.projects.locations.ragCorpora.ragFiles.html">ragFiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="aiplatform_v1.projects.locations.ragCorpora.ragFiles.operations.html">operations()</a></code>
</p>
<p class="firstline">Returns the operations Resource.</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="#delete">delete(name, forceDelete=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a RagFile.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a RagFile.</p>
<p class="toc_element">
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Import files from Google Cloud Storage or Google Drive into a RagCorpus.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists RagFiles in a RagCorpus.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, forceDelete=None, x__xgafv=None)</code>
<pre>Deletes a RagFile.
Args:
name: string, Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
forceDelete: boolean, Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a RagFile.
Args:
name: string, Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A RagFile contains user data for chunking, embedding and indexing.
"createTime": "A String", # Output only. Timestamp when this RagFile was created.
"description": "A String", # Optional. The description of the RagFile.
"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
},
"displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"fileStatus": { # RagFile status. # Output only. State of the RagFile.
"errorStatus": "A String", # Output only. Only when the `state` field is ERROR.
"state": "A String", # Output only. RagFile state.
},
"gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"googleDriveSource": { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
"resourceIds": [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
"resourceId": "A String", # Required. The ID of the Google Drive resource.
"resourceType": "A String", # Required. The type of the Google Drive resource.
},
],
},
"jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
"jiraQueries": [ # Required. The Jira queries.
{ # JiraQueries contains the Jira queries and corresponding authentication.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key. See [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
"A String",
],
"email": "A String", # Required. The Jira email address.
"projects": [ # A list of Jira projects to import in their entirety.
"A String",
],
"serverUri": "A String", # Required. The Jira server URI.
},
],
},
"name": "A String", # Output only. The resource name of the RagFile.
"sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
"sharePointSources": [ # The SharePoint sources.
{ # An individual SharePointSource.
"clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
"clientSecret": { # The API secret. # The application secret for the app registered in Azure.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"driveId": "A String", # The ID of the drive to download from.
"driveName": "A String", # The name of the drive to download from.
"fileId": "A String", # Output only. The SharePoint file id. Output only.
"sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
"sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
"sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
"tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
},
],
},
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"channels": [ # Required. The Slack channel IDs.
{ # SlackChannel contains the Slack channel ID and the time range to import.
"channelId": "A String", # Required. The Slack channel ID.
"endTime": "A String", # Optional. The ending timestamp for messages to import.
"startTime": "A String", # Optional. The starting timestamp for messages to import.
},
],
},
],
},
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
"userMetadata": "A String", # Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.
}</pre>
</div>
<div class="method">
<code class="details" id="import_">import_(parent, body=None, x__xgafv=None)</code>
<pre>Import files from Google Cloud Storage or Google Drive into a RagCorpus.
Args:
parent: string, Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for VertexRagDataService.ImportRagFiles.
"importRagFilesConfig": { # Config for importing RagFiles. # Required. The config for the RagFiles to be synced and imported into the RagCorpus. VertexRagDataService.ImportRagFiles.
"gcsSource": { # The Google Cloud Storage location for the input content. # Google Cloud Storage location. Supports importing individual files as well as entire Google Cloud Storage directories. Sample formats: - `gs://bucket_name/my_directory/object_name/my_file.txt` - `gs://bucket_name/my_directory`
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"googleDriveSource": { # The Google Drive location for the input content. # Google Drive location. Supports importing individual files as well as Google Drive folders.
"resourceIds": [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
"resourceId": "A String", # Required. The ID of the Google Drive resource.
"resourceType": "A String", # Required. The type of the Google Drive resource.
},
],
},
"importResultBigquerySink": { # The BigQuery location for the output content. # The BigQuery destination to write import result to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table.
"outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
},
"importResultGcsSink": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage path to write import result to.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"jiraSource": { # The Jira source for the ImportRagFilesRequest. # Jira queries with their corresponding authentication.
"jiraQueries": [ # Required. The Jira queries.
{ # JiraQueries contains the Jira queries and corresponding authentication.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key. See [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
"A String",
],
"email": "A String", # Required. The Jira email address.
"projects": [ # A list of Jira projects to import in their entirety.
"A String",
],
"serverUri": "A String", # Required. The Jira server URI.
},
],
},
"maxEmbeddingRequestsPerMin": 42, # Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.
"partialFailureBigquerySink": { # The BigQuery location for the output content. # The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). The dataset must exist. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. Deprecated. Prefer to use `import_result_bq_sink`.
"outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`.
},
"partialFailureGcsSink": { # The Google Cloud Storage location where the output is to be written to. # The Cloud Storage path to write partial failures to. Deprecated. Prefer to use `import_result_gcs_sink`.
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
"ragFileParsingConfig": { # Specifies the parsing config for RagFiles. # Optional. Specifies the parsing config for RagFiles. RAG will use the default parser if this field is not set.
"layoutParser": { # Document AI Layout Parser config. # The Layout Parser to use for RagFiles.
"maxParsingRequestsPerMin": 42, # The maximum number of requests the job is allowed to make to the Document AI processor per minute. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If unspecified, a default value of 120 QPM would be used.
"processorName": "A String", # The full resource name of a Document AI processor or processor version. The processor must have type `LAYOUT_PARSER_PROCESSOR`. If specified, the `additional_config.parse_as_scanned_pdf` field must be false. Format: * `projects/{project_id}/locations/{location}/processors/{processor_id}` * `projects/{project_id}/locations/{location}/processors/{processor_id}/processorVersions/{processor_version_id}`
},
"llmParser": { # Specifies the LLM parsing for RagFiles. # The LLM Parser to use for RagFiles.
"customParsingPrompt": "A String", # The prompt to use for parsing. If not specified, a default prompt will be used.
"maxParsingRequestsPerMin": 42, # The maximum number of requests the job is allowed to make to the LLM model per minute. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If unspecified, a default value of 5000 QPM would be used.
"modelName": "A String", # The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`
},
},
"ragFileTransformationConfig": { # Specifies the transformation config for RagFiles. # Specifies the transformation config for RagFiles.
"ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the chunking config for RagFiles.
"fixedLengthChunking": { # Specifies the fixed length chunking config. # Specifies the fixed length chunking config.
"chunkOverlap": 42, # The overlap between chunks.
"chunkSize": 42, # The size of the chunks.
},
},
},
"rebuildAnnIndex": True or False, # Rebuilds the ANN index to optimize for recall on the imported data. Only applicable for RagCorpora running on RagManagedDb with `retrieval_strategy` set to `ANN`. The rebuild will be performed using the existing ANN config set on the RagCorpus. To change the ANN config, please use the UpdateRagCorpus API. Default is false, i.e., index is not rebuilt.
"sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # SharePoint sources.
"sharePointSources": [ # The SharePoint sources.
{ # An individual SharePointSource.
"clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
"clientSecret": { # The API secret. # The application secret for the app registered in Azure.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"driveId": "A String", # The ID of the drive to download from.
"driveName": "A String", # The name of the drive to download from.
"fileId": "A String", # Output only. The SharePoint file id. Output only.
"sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
"sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
"sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
"tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
},
],
},
"slackSource": { # The Slack source for the ImportRagFilesRequest. # Slack channels with their corresponding access tokens.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"channels": [ # Required. The Slack channel IDs.
{ # SlackChannel contains the Slack channel ID and the time range to import.
"channelId": "A String", # Required. The Slack channel ID.
"endTime": "A String", # Optional. The ending timestamp for messages to import.
"startTime": "A String", # Optional. The starting timestamp for messages to import.
},
],
},
],
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists RagFiles in a RagCorpus.
Args:
parent: string, Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for VertexRagDataService.ListRagFiles.
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagFilesRequest.page_token to obtain that page.
"ragFiles": [ # List of RagFiles in the requested page.
{ # A RagFile contains user data for chunking, embedding and indexing.
"createTime": "A String", # Output only. Timestamp when this RagFile was created.
"description": "A String", # Optional. The description of the RagFile.
"directUploadSource": { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
},
"displayName": "A String", # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
"fileStatus": { # RagFile status. # Output only. State of the RagFile.
"errorStatus": "A String", # Output only. Only when the `state` field is ERROR.
"state": "A String", # Output only. RagFile state.
},
"gcsSource": { # The Google Cloud Storage location for the input content. # Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.
"uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards.
"A String",
],
},
"googleDriveSource": { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
"resourceIds": [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
"resourceId": "A String", # Required. The ID of the Google Drive resource.
"resourceType": "A String", # Required. The type of the Google Drive resource.
},
],
},
"jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
"jiraQueries": [ # Required. The Jira queries.
{ # JiraQueries contains the Jira queries and corresponding authentication.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key. See [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
"A String",
],
"email": "A String", # Required. The Jira email address.
"projects": [ # A list of Jira projects to import in their entirety.
"A String",
],
"serverUri": "A String", # Required. The Jira server URI.
},
],
},
"name": "A String", # Output only. The resource name of the RagFile.
"sharePointSources": { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
"sharePointSources": [ # The SharePoint sources.
{ # An individual SharePointSource.
"clientId": "A String", # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
"clientSecret": { # The API secret. # The application secret for the app registered in Azure.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"driveId": "A String", # The ID of the drive to download from.
"driveName": "A String", # The name of the drive to download from.
"fileId": "A String", # Output only. The SharePoint file id. Output only.
"sharepointFolderId": "A String", # The ID of the SharePoint folder to download from.
"sharepointFolderPath": "A String", # The path of the SharePoint folder to download from.
"sharepointSiteName": "A String", # The name of the SharePoint site to download from. This can be the site name or the site id.
"tenantId": "A String", # Unique identifier of the Azure Active Directory Instance.
},
],
},
"slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
"channels": [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
"apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
"apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
"apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
},
"channels": [ # Required. The Slack channel IDs.
{ # SlackChannel contains the Slack channel ID and the time range to import.
"channelId": "A String", # Required. The Slack channel ID.
"endTime": "A String", # Optional. The ending timestamp for messages to import.
"startTime": "A String", # Optional. The starting timestamp for messages to import.
},
],
},
],
},
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
"userMetadata": "A String", # Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_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>
</body></html>
|
