Batch process all your records to store structured outputs in a SingleStore account.
The requirements are as follows.
To get the values for the hostname, port, username, and password:
<user-name>
is the username.<password>
is the user’s password.<host>
is the workspace’s hostname.<post>
is the host’s port.To get the values for the database and table names:
The SingleStore connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
These environment variables:
SINGLESTORE_HOST
- The hostname for the SingleStore deployment, represented by --host
(CLI) or host
(Python).SINGLESTORE_PORT
- The port for the host, represented by --port
(CLI) or port
(Python).SINGLESTORE_USER
- The username for the deployment, represented by --user
(CLI) or user
(Python).SINGLESTORE_PASSWORD
- The password for the user, represented by --password
(CLI) or password
(Python).SINGLESTORE_DB
- The name of the database in the deployment, represented by --database
(CLI) or database
(Python).SINGLESTORE_TABLE
- The name of the table in the database, represented by --table-name
(CLI) or table_name
(Python).The table’s schema must match the schema of the documents that Unstructured produces.
During insertion, JSON objects are flattened, and underscores are placed between nested object names.
For example, the following JSON object matches a column in the table named data_source_date_created
:
The metadata
object itself is also flattened in a similar way. However, for nested objects in metadata
,
the column in the table does not start with metadata_
. For example, the following JSON object matches a
column in the table named last_modified
:
Unstructured cannot provide a table schema that is guaranteed to work in all circumstances. This is because these schemas will vary based on your source files’ types; how you want Unstructured to partition, chunk, and generate embeddings; any custom post-processing code that you run; and other factors.
You can adapt the following table schema example for your own needs:
See also:
Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The source connector can be any of the ones supported. This example uses the local source connector.
This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.
For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
To do local file processing, omit --partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_by_api=False
(Python).
Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
To send files to the Unstructured Partition Endpoint for processing, specify --partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.
The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.
If you do not have an API key, get one now.
If the Unstructured API is self-hosted, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For details, contact Unstructured Sales at sales@unstructured.io.
Batch process all your records to store structured outputs in a SingleStore account.
The requirements are as follows.
To get the values for the hostname, port, username, and password:
<user-name>
is the username.<password>
is the user’s password.<host>
is the workspace’s hostname.<post>
is the host’s port.To get the values for the database and table names:
The SingleStore connector dependencies:
You might also need to install additional dependencies, depending on your needs. Learn more.
These environment variables:
SINGLESTORE_HOST
- The hostname for the SingleStore deployment, represented by --host
(CLI) or host
(Python).SINGLESTORE_PORT
- The port for the host, represented by --port
(CLI) or port
(Python).SINGLESTORE_USER
- The username for the deployment, represented by --user
(CLI) or user
(Python).SINGLESTORE_PASSWORD
- The password for the user, represented by --password
(CLI) or password
(Python).SINGLESTORE_DB
- The name of the database in the deployment, represented by --database
(CLI) or database
(Python).SINGLESTORE_TABLE
- The name of the table in the database, represented by --table-name
(CLI) or table_name
(Python).The table’s schema must match the schema of the documents that Unstructured produces.
During insertion, JSON objects are flattened, and underscores are placed between nested object names.
For example, the following JSON object matches a column in the table named data_source_date_created
:
The metadata
object itself is also flattened in a similar way. However, for nested objects in metadata
,
the column in the table does not start with metadata_
. For example, the following JSON object matches a
column in the table named last_modified
:
Unstructured cannot provide a table schema that is guaranteed to work in all circumstances. This is because these schemas will vary based on your source files’ types; how you want Unstructured to partition, chunk, and generate embeddings; any custom post-processing code that you run; and other factors.
You can adapt the following table schema example for your own needs:
See also:
Now call the Unstructured Ingest CLI or the Unstructured Ingest Python library. The source connector can be any of the ones supported. This example uses the local source connector.
This example sends files to Unstructured for processing by default. To process files locally instead, see the instructions at the end of this page.
For the Unstructured Ingest CLI and the Unstructured Ingest Python library, you can use the --partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
To do local file processing, omit --partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_by_api=False
(Python).
Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
To send files to the Unstructured Partition Endpoint for processing, specify --partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.You must specify the API URL only if you are not using the default API URL for Unstructured Ingest, for example, if you are using a self-hosted instance of the Unstructured API.
The default API URL for Unstructured Ingest is https://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.
If you do not have an API key, get one now.
If the Unstructured API is self-hosted, the process for generating Unstructured API keys, and the Unstructured API URL that you use, are different. For details, contact Unstructured Sales at sales@unstructured.io.