4.6.3 VECTOR_STORE_LOAD

The VECTOR_STORE_LOAD routine generates vector embedding for the specified files or folders that are stored in the Object Storage bucket, and loads the embeddings into a new vector store table.

This routine creates an asynchronous task which loads vector store tables in the background. It also returns a query that you can run to track the status of the vector store load task that is running in the background.

Note

It is recommended that you create five or less vector store load tasks at a time. Too many tasks running at the same time might cause overloading issues.

VECTOR_STORE_LOAD Syntax

mysql> call sys.VECTOR_STORE_LOAD('URI', [options]);

options: {
  JSON_OBJECT('key','value'[,'key','value'] ...)
    'key','value': {
    ['formats', JSON_ARRAY('Format1'[,'Format2'] ...)]
    ['schema_name', 'SchemaName']
    ['table_name', 'TableName']
    ['region', 'Region']
    ['task_name', 'TaskName']
    ['language', 'Language']
    ['description', 'Description']
    ['uris', JSON_ARRAY(JSON_OBJECT('uri','URI1','table_name','TableName1')[,JSON_OBJECT('uri','URI2','table_name','TableName2')] ...)]
    ['autopilot_disable_check', {true|false}]
    }
}

Following are VECTOR_STORE_LOAD parameters:

• URI: specifies the unique reference index (URI) or pre-authenticated request (PAR) of the Object Storage bucket files or folders to be ingested into the vector store.

  A URI is considered to be one of the following:

  • A glob pattern, if it contains at least one unescaped ? or * character.

  • A prefix, if it is not a pattern and ends with a / character like a folder path.

  • A file path, if it is neither a glob pattern nor a prefix.

  To learn how to create PAR for your object storage, see Creating a PAR request in Object Storage.

• options: specifies optional parameters as key-value pairs in JSON format. It can include the following parameters:

  • formats: specifies the list of formats to be loaded. The supported file formats are pdf, ppt, txt, html, and doc. By default, the routine uses all the supported formats.

    If the routine detects multiple files with the same or different file formats in a single load, it creates a separate table for every format it finds. The table name for each format is the specified or default table name followed by the format: TableName_Format.

  • schema_name: specifies the name of the schema where the vector embeddings are to be loaded. By default, this procedure uses the current schema from the session.

  • table_name: specifies the name of the vector store table to create. By default, the routine generates a unique table name with format vector_store_data_x, where x is a counter.

  • region: specifies the region of the bucket. Default value is the region where the current DB System is running.

  • task_name: specifies a name for the loading task to be mentioned in the task status. Default value is Vector Store Loader.

  • language: specifies the text content language used in the files to be ingested into the vector store. To set the value of the language parameter, use the two-letter ISO 639-1 code for the language. This parameter is supported in HeatWave 9.0.1-u1 and later versions.

    Default value is en.

    For possible values, to view the list of supported languages, see Languages.

  • description: specifies a description of document collection being loaded to be mentioned in the task status. Default value is NULL.

  • uris: specifies a list of additional URIs to include along with an optional name for the vector store table to be created for the specified URI. Default value is NULL.

    This parameter accepts the following values:

    • uri: specifies the additional URI. If only uri is provided, the routine uses the specified URI as an additional URI, and loads it into the main table options.table_name or the generated table with the unique table name.

    • table_name: if only table_name is provided, the routine loads the specified vector store table into HeatWave.

      If both uri and table_name are provided, the routine loads the specified URI into the specified table.

  • autopilot_disable_check: if set to true, turns autopilot checks off, so HeatWave GenAI does not perform checks when the load task is running. Therefore, checks such as memory checks for estimating memory needed for tables and checking memory capacity in HeatWave for the load to complete are not performed. Default value is false.

Syntax Examples

• Specifying the file to ingest using the URI in VECTOR_STORE_LOAD:

  call sys.VECTOR_STORE_LOAD('oci://demo_bucket@demo_namespace/demo_folder/demo_file.pdf', '{"table_name": "demo_embeddings"}');

• Specifying the file to ingest using the PAR in VECTOR_STORE_LOAD:

  call sys.VECTOR_STORE_LOAD('https://demo.objectstorage.us-ashburn-1.oci.customer-oci.com/p/demo-url/n/demo/b/demo-bucket/o/demo_doc.pdf', '{"table_name": "demo_embeddings"}');