Skip to main content

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.

Teradata Enterprise Vector Store is a specialized database designed to store and manage high-dimensional vectors (numeric arrays that encode meaning or similarity). Destination connectors support Version 2 (V2) of the Teradata Enterprise Vector Store APIs. For more information, see Functional Reference of V2 APIs (Vector Collections) in the Teradata Enterprise Vector Store User Guide.

Requirements

You will need:
  • The base URL for the Teradata Analytics REST API endpoint. The format depends on your VantageCloud Enterprise deployment type:
    • For private VPC: https://<site-id>.private.cloud.teradata.com
    • For public site gateway: https://<site-id>.gateway.cloud.teradata.com
    Replace <site-id> with your Teradata site ID. Contact your Teradata system administrator if you do not know your site ID. For more information, see Vector Store Service Access and Authentication in the Teradata Enterprise Vector Store User Guide.
    The REST API URL is not available for VantageCloud Lake (VCL) deployments. VCL deployments use JWT or PAT token-based authentication and are not currently supported by this connector.
  • The username and password for your Teradata database account. This connector uses Basic Authentication (TD2), supported on AI-on-premises and VantageCloud Enterprise deployments. The account must have been granted the TD_AIAdmin role. This role is required to create vector collections. Contact your Teradata system administrator to confirm that your account has been granted this role. If you do not know your credentials, contact your Teradata system administrator. For more information, see Authenticating Users in the Teradata Enterprise Vector Store User Guide.
  • The name of the collection to create or add data to. A vector collection refers to an instance of Vector Store. An enterprise vector store may comprise thousands of vector collections, each tailored for a specific use case or workflow. Collection names must be unique within the vector store. They can only contain letters, numbers, and underscores, matching the following regex pattern: ^[a-zA-Z0-9_]+$.
    • To use an existing collection, contact your Teradata system administrator for the collection name, or use the Collection Manager to list available collections.
    • To create a new collection, provide a unique name. The connector creates the collection automatically on first use.
    For more information, see Creating a Vector Collection in the Teradata Enterprise Vector Store User Guide.

Examples

The following examples show how to create a Teradata Enterprise Vector Store destination connector using the Python SDK or REST API. For more information on working with destination connectors using the Unstructured API, see Destination endpoints.
import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateDestinationRequest
from unstructured_client.models.shared import CreateDestinationConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.destinations.create_destination(
        request=CreateDestinationRequest(
            create_destination_connector=CreateDestinationConnector(
                name="<name>",
                type="teradatavector_v2",
                config={
                    "base_url": "<base-url>",
                    "user": "<user>",
                    "password": "<password>",
                    "host": "<host>",
                    "database": "<database>",
                    "collection_name": "<collection-name>",
                    "use_precomputed_embeddings": <True|False>,
                    "deduplicate": <True|False>
                }
            )
        )
    )

    print(response.destination_connector_information)

Configuration settings

Replace the preceding placeholders as follows:
name
string
required
A unique name for this connector.
base_url
string
required
The base URL for the Teradata Analytics REST API endpoint. The format depends on your VantageCloud Enterprise deployment type:
  • For private VPC: https://<site-id>.private.cloud.teradata.com
  • For public site gateway: https://<site-id>.gateway.cloud.teradata.com
Replace <site-id> with your Teradata site ID. Contact your Teradata system administrator if you do not know your site ID.For more information, see Vector Store Service Access and Authentication in the Teradata Enterprise Vector Store User Guide.
user
string
required
The username for your Teradata database account.The account must have been granted the TD_AIAdmin role. This role is required to create vector collections. Contact your Teradata system administrator to confirm that your account has been granted this role.
password
string
required
The password for your Teradata database account.
host
string
The database host. Defaults to the base URL if not otherwise specified.
database
string
The name of the database.
collection_name
string
required
The name of the collection to create or add data to.Collection names must be unique within the vector store and can only contain letters, numbers, and underscores, matching the following regex pattern: ^[a-zA-Z0-9_]+$.To create a new collection, provide a unique name. The connector creates the collection automatically on first use.
use_precomputed_embeddings
boolean
default:"true"
Set to true if your Unstructured workflow is configured to generate embedding vectors. Set to false to have Teradata generate embeddings automatically.
deduplicate
boolean
default:"false"
Set to true delete existing documents with the same filename before uploading new versions. This enables idempotent re-runs without destroying the entire collection. Set to false to preserve existing documents.