Google Git
Sign in
android/platform/external/python/google-api-python-client/22bd31c062d2f22ab3ab52564e28635ea3852c92/./docs/dyn/aiplatform_v1beta1.media.html
blob: 8b133f1f9f6facce823f321a544a2823d3072d58 [file]
<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_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.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.
&quot;ragFile&quot;: { # A RagFile contains user data for chunking, embedding and indexing. # Required. The RagFile to upload.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this RagFile was created.
&quot;description&quot;: &quot;A String&quot;, # Optional. The description of the RagFile.
&quot;directUploadSource&quot;: { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
&quot;fileStatus&quot;: { # RagFile status. # Output only. State of the RagFile.
&quot;errorStatus&quot;: &quot;A String&quot;, # Output only. Only when the `state` field is ERROR.
&quot;state&quot;: &quot;A String&quot;, # Output only. RagFile state.
},
&quot;gcsSource&quot;: { # 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.
&quot;uris&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;googleDriveSource&quot;: { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
&quot;resourceIds&quot;: [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
&quot;resourceId&quot;: &quot;A String&quot;, # Required. The ID of the Google Drive resource.
&quot;resourceType&quot;: &quot;A String&quot;, # Required. The type of the Google Drive resource.
},
],
},
&quot;jiraSource&quot;: { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
&quot;jiraQueries&quot;: [ # Required. The Jira queries.
{ # JiraQueries contains the Jira queries and corresponding authentication.
&quot;apiKeyConfig&quot;: { # 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/).
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;customQueries&quot;: [ # 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/
&quot;A String&quot;,
],
&quot;email&quot;: &quot;A String&quot;, # Required. The Jira email address.
&quot;projects&quot;: [ # A list of Jira projects to import in their entirety.
&quot;A String&quot;,
],
&quot;serverUri&quot;: &quot;A String&quot;, # Required. The Jira server URI.
},
],
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the RagFile.
&quot;ragFileType&quot;: &quot;A String&quot;, # Output only. The type of the RagFile.
&quot;sharePointSources&quot;: { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
&quot;sharePointSources&quot;: [ # The SharePoint sources.
{ # An individual SharePointSource.
&quot;clientId&quot;: &quot;A String&quot;, # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions &quot;Files.ReadAll&quot;, &quot;Sites.ReadAll&quot; and BrowserSiteLists.Read.All.
&quot;clientSecret&quot;: { # The API secret. # The application secret for the app registered in Azure.
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;driveId&quot;: &quot;A String&quot;, # The ID of the drive to download from.
&quot;driveName&quot;: &quot;A String&quot;, # The name of the drive to download from.
&quot;fileId&quot;: &quot;A String&quot;, # Output only. The SharePoint file id. Output only.
&quot;sharepointFolderId&quot;: &quot;A String&quot;, # The ID of the SharePoint folder to download from.
&quot;sharepointFolderPath&quot;: &quot;A String&quot;, # The path of the SharePoint folder to download from.
&quot;sharepointSiteName&quot;: &quot;A String&quot;, # The name of the SharePoint site to download from. This can be the site name or the site id.
&quot;tenantId&quot;: &quot;A String&quot;, # Unique identifier of the Azure Active Directory Instance.
},
],
},
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the RagFile in bytes.
&quot;slackSource&quot;: { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
&quot;channels&quot;: [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
&quot;apiKeyConfig&quot;: { # 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.
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;channels&quot;: [ # Required. The Slack channel IDs.
{ # SlackChannel contains the Slack channel ID and the time range to import.
&quot;channelId&quot;: &quot;A String&quot;, # Required. The Slack channel ID.
&quot;endTime&quot;: &quot;A String&quot;, # Optional. The ending timestamp for messages to import.
&quot;startTime&quot;: &quot;A String&quot;, # Optional. The starting timestamp for messages to import.
},
],
},
],
},
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this RagFile was last updated.
&quot;userMetadata&quot;: &quot;A String&quot;, # Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.
},
&quot;uploadRagFileConfig&quot;: { # Config for uploading RagFile. # Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.
&quot;ragFileChunkingConfig&quot;: { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after uploading RagFile.
&quot;chunkOverlap&quot;: 42, # The overlap between chunks.
&quot;chunkSize&quot;: 42, # The size of the chunks.
&quot;fixedLengthChunking&quot;: { # Specifies the fixed length chunking config. # Specifies the fixed length chunking config.
&quot;chunkOverlap&quot;: 42, # The overlap between chunks.
&quot;chunkSize&quot;: 42, # The size of the chunks.
},
},
&quot;ragFileMetadataConfig&quot;: { # Metadata config for RagFile. # Optional. Specifies the metadata config for RagFiles. Including paths for metadata schema and metadata. Alteratively, inline metadata schema and metadata can be provided. Deprecated: Not in use.
&quot;gcsMetadataSchemaSource&quot;: { # 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/metadata_schema.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata schema will be read from the files that ends with &quot;metadata_schema.json&quot; in the directory.
&quot;uris&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;gcsMetadataSource&quot;: { # 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/metadata.json` - `gs://bucket_name/my_directory` If the user provides a directory, the metadata will be read from the files that ends with &quot;metadata.json&quot; in the directory.
&quot;uris&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;googleDriveMetadataSchemaSource&quot;: { # The Google Drive location for the input content. # Google Drive location. Supports importing individual files as well as Google Drive folders. If the user provides a folder, the metadata schema will be read from the files that ends with &quot;metadata_schema.json&quot; in the directory.
&quot;resourceIds&quot;: [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
&quot;resourceId&quot;: &quot;A String&quot;, # Required. The ID of the Google Drive resource.
&quot;resourceType&quot;: &quot;A String&quot;, # Required. The type of the Google Drive resource.
},
],
},
&quot;googleDriveMetadataSource&quot;: { # The Google Drive location for the input content. # Google Drive location. Supports importing individual files as well as Google Drive folders. If the user provides a directory, the metadata will be read from the files that ends with &quot;metadata.json&quot; in the directory.
&quot;resourceIds&quot;: [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
&quot;resourceId&quot;: &quot;A String&quot;, # Required. The ID of the Google Drive resource.
&quot;resourceType&quot;: &quot;A String&quot;, # Required. The type of the Google Drive resource.
},
],
},
&quot;inlineMetadataSchemaSource&quot;: &quot;A String&quot;, # Inline metadata schema source. Must be a JSON string.
&quot;inlineMetadataSource&quot;: &quot;A String&quot;, # Inline metadata source. Must be a JSON string.
},
&quot;ragFileParsingConfig&quot;: { # 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.
&quot;advancedParser&quot;: { # Specifies the advanced parsing for RagFiles. # The Advanced Parser to use for RagFiles.
&quot;useAdvancedPdfParsing&quot;: True or False, # Whether to use advanced PDF parsing.
},
&quot;layoutParser&quot;: { # Document AI Layout Parser config. # The Layout Parser to use for RagFiles.
&quot;globalMaxParsingRequestsPerMin&quot;: 42, # The maximum number of requests the job is allowed to make to the Document AI processor per minute in this project. Consult https://cloud.google.com/document-ai/quotas and the Quota page for your project to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline as the global limit.
&quot;maxParsingRequestsPerMin&quot;: 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.
&quot;processorName&quot;: &quot;A String&quot;, # 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}`
},
&quot;llmParser&quot;: { # Specifies the LLM parsing for RagFiles. # The LLM Parser to use for RagFiles.
&quot;customParsingPrompt&quot;: &quot;A String&quot;, # The prompt to use for parsing. If not specified, a default prompt will be used.
&quot;globalMaxParsingRequestsPerMin&quot;: 42, # The maximum number of requests the job is allowed to make to the LLM model per minute in this project. Consult https://cloud.google.com/vertex-ai/generative-ai/docs/quotas and your document size to set an appropriate value here. If this value is not specified, max_parsing_requests_per_min will be used by indexing pipeline job as the global limit.
&quot;maxParsingRequestsPerMin&quot;: 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.
&quot;modelName&quot;: &quot;A String&quot;, # The name of a LLM model used for parsing. Format: * `projects/{project_id}/locations/{location}/publishers/{publisher}/models/{model}`
},
&quot;useAdvancedPdfParsing&quot;: True or False, # Whether to use advanced PDF parsing.
},
&quot;ragFileTransformationConfig&quot;: { # Specifies the transformation config for RagFiles. # Specifies the transformation config for RagFiles.
&quot;ragFileChunkingConfig&quot;: { # Specifies the size and overlap of chunks for RagFiles. # Specifies the chunking config for RagFiles.
&quot;chunkOverlap&quot;: 42, # The overlap between chunks.
&quot;chunkSize&quot;: 42, # The size of the chunks.
&quot;fixedLengthChunking&quot;: { # Specifies the fixed length chunking config. # Specifies the fixed length chunking config.
&quot;chunkOverlap&quot;: 42, # The overlap between chunks.
&quot;chunkSize&quot;: 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.
&quot;error&quot;: { # 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.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # 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.
},
&quot;ragFile&quot;: { # A RagFile contains user data for chunking, embedding and indexing. # The RagFile that had been uploaded into the RagCorpus.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this RagFile was created.
&quot;description&quot;: &quot;A String&quot;, # Optional. The description of the RagFile.
&quot;directUploadSource&quot;: { # The input content is encapsulated and uploaded in the request. # Output only. The RagFile is encapsulated and uploaded in the UploadRagFile request.
},
&quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.
&quot;fileStatus&quot;: { # RagFile status. # Output only. State of the RagFile.
&quot;errorStatus&quot;: &quot;A String&quot;, # Output only. Only when the `state` field is ERROR.
&quot;state&quot;: &quot;A String&quot;, # Output only. RagFile state.
},
&quot;gcsSource&quot;: { # 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.
&quot;uris&quot;: [ # 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.
&quot;A String&quot;,
],
},
&quot;googleDriveSource&quot;: { # The Google Drive location for the input content. # Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.
&quot;resourceIds&quot;: [ # Required. Google Drive resource IDs.
{ # The type and ID of the Google Drive resource.
&quot;resourceId&quot;: &quot;A String&quot;, # Required. The ID of the Google Drive resource.
&quot;resourceType&quot;: &quot;A String&quot;, # Required. The type of the Google Drive resource.
},
],
},
&quot;jiraSource&quot;: { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
&quot;jiraQueries&quot;: [ # Required. The Jira queries.
{ # JiraQueries contains the Jira queries and corresponding authentication.
&quot;apiKeyConfig&quot;: { # 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/).
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;customQueries&quot;: [ # 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/
&quot;A String&quot;,
],
&quot;email&quot;: &quot;A String&quot;, # Required. The Jira email address.
&quot;projects&quot;: [ # A list of Jira projects to import in their entirety.
&quot;A String&quot;,
],
&quot;serverUri&quot;: &quot;A String&quot;, # Required. The Jira server URI.
},
],
},
&quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the RagFile.
&quot;ragFileType&quot;: &quot;A String&quot;, # Output only. The type of the RagFile.
&quot;sharePointSources&quot;: { # The SharePointSources to pass to ImportRagFiles. # The RagFile is imported from a SharePoint source.
&quot;sharePointSources&quot;: [ # The SharePoint sources.
{ # An individual SharePointSource.
&quot;clientId&quot;: &quot;A String&quot;, # The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions &quot;Files.ReadAll&quot;, &quot;Sites.ReadAll&quot; and BrowserSiteLists.Read.All.
&quot;clientSecret&quot;: { # The API secret. # The application secret for the app registered in Azure.
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;driveId&quot;: &quot;A String&quot;, # The ID of the drive to download from.
&quot;driveName&quot;: &quot;A String&quot;, # The name of the drive to download from.
&quot;fileId&quot;: &quot;A String&quot;, # Output only. The SharePoint file id. Output only.
&quot;sharepointFolderId&quot;: &quot;A String&quot;, # The ID of the SharePoint folder to download from.
&quot;sharepointFolderPath&quot;: &quot;A String&quot;, # The path of the SharePoint folder to download from.
&quot;sharepointSiteName&quot;: &quot;A String&quot;, # The name of the SharePoint site to download from. This can be the site name or the site id.
&quot;tenantId&quot;: &quot;A String&quot;, # Unique identifier of the Azure Active Directory Instance.
},
],
},
&quot;sizeBytes&quot;: &quot;A String&quot;, # Output only. The size of the RagFile in bytes.
&quot;slackSource&quot;: { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
&quot;channels&quot;: [ # Required. The Slack channels.
{ # SlackChannels contains the Slack channels and corresponding access token.
&quot;apiKeyConfig&quot;: { # 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.
&quot;apiKeySecretVersion&quot;: &quot;A String&quot;, # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
&quot;apiKeyString&quot;: &quot;A String&quot;, # The API key string. Either this or `api_key_secret_version` must be set.
},
&quot;channels&quot;: [ # Required. The Slack channel IDs.
{ # SlackChannel contains the Slack channel ID and the time range to import.
&quot;channelId&quot;: &quot;A String&quot;, # Required. The Slack channel ID.
&quot;endTime&quot;: &quot;A String&quot;, # Optional. The ending timestamp for messages to import.
&quot;startTime&quot;: &quot;A String&quot;, # Optional. The starting timestamp for messages to import.
},
],
},
],
},
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when this RagFile was last updated.
&quot;userMetadata&quot;: &quot;A String&quot;, # Output only. The metadata for metadata search. The user_metadata Needs to be in JSON format.
},
}</pre>
</div>
</body></html>