Documentation Index
Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt
Use this file to discover all available pages before exploring further.
First time creating a connector? Read this first.
Requirements
You will need:- A Google Cloud service account. Create a service account.
-
A service account key for the service account. See Create a service account key in
Create and delete service account keys.
To ensure maximum compatibility across Unstructured service offerings, you should give the service account key information to Unstructured as
a single-line string that contains the contents of the downloaded service account key file (and not the service account key file itself).
To print this single-line string without line breaks, suitable for copying, you can run one of the following commands from your Terminal or Command Prompt.
In this command, replace
<path-to-downloaded-key-file>with the path to the service account key file that you downloaded by following the preceding instructions.- For macOS or Linux:
- For Windows:
- For macOS or Linux:
-
The URI for a Google Cloud Storage bucket. This URI consists of the target bucket name, plus any target folder within the bucket, expressed as
gs://<bucket-name>[/folder-name]. Create a bucket. This bucket must have, at minimum, one of the following roles applied to the target Google Cloud service account:Storage Object Viewerfor bucket read access.Storage Object Userfor bucket write access.- The
Storage Object Adminrole provides read and write access, plus access to additional bucket operations.
Examples
To create a Google Cloud Storage destination connector, see the following examples. For more information on working with destination connectors using the Unstructured API, see Destination endpoints.Configuration settings
Replace the preceding placeholders as follows:A unique name for this connector.
The contents of a service account key file, expressed as a single string without line breaks, for a Google Cloud service account that has the required access permissions to the bucket.
The URI for the Google Cloud Storage bucket and any target folder path within the bucket. This URI takes the format
gs://<bucket-name>[/folder-name].Source connector only. Set to
true to ingest data recursively from any subfolders, starting from the path specified by remote_url.
