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
|
<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.media.html">media</a></h1>
<h2>Instance Methods</h2>
<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="#upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</a></code></p>
<p class="firstline">Upload a file into a RagCorpus.</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="upload">upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)</code>
<pre>Upload a file into a RagCorpus.
Args:
parent: string, Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for VertexRagDataService.UploadRagFile.
"ragFile": { # A RagFile contains user data for chunking, embedding and indexing. # Required. The RagFile to upload.
"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.
},
"uploadRagFileConfig": { # Config for uploading RagFile. # Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.
"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.
},
},
},
},
}
media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
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.UploadRagFile.
"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 that occurred while processing the RagFile.
"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.
},
"ragFile": { # A RagFile contains user data for chunking, embedding and indexing. # The RagFile that had been uploaded into the RagCorpus.
"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>
</body></html>
|
