The target-pinecone loader sends data into Pinecone after it was pulled from a source using an extractor
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the target-pinecone loader to your
project using
:meltano add -
Configure the target-pinecone
settings using
:meltano config
meltano add loader target-pineconemeltano config target-pinecone set --interactiveNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
target-pinecone
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this loader. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this loader.
This plugin has the following capabilities:
- about
- schema-flattening
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
target-pinecone settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
api_keydimensionsdocument_text_propertyembeddings_propertyenvironmentindex_namemetadata_propertypinecone_metadata_text_key
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config target-pinecone list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
API Key (api_key)
-
Environment variable:
TARGET_PINECONE_API_KEY
Your Pinecone API key.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set api_key [value]Dimensions (dimensions)
-
Environment variable:
TARGET_PINECONE_DIMENSIONS -
Default Value:
1536
The amount of dimensions to use if creating a new index. An index is only created if it doesn't already exist. The default is 1536 which is the dimensions of the embeddings using OpenAI's text-embedding-ada-002 model.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set dimensions [value]Document Text Property (document_text_property)
-
Environment variable:
TARGET_PINECONE_DOCUMENT_TEXT_PROPERTY -
Default Value:
text
The property containing the document text in the input records.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set document_text_property [value]Embeddings Property (embeddings_property)
-
Environment variable:
TARGET_PINECONE_EMBEDDINGS_PROPERTY -
Default Value:
embeddings
The property containing the embeddings in the input records.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set embeddings_property [value]Environment (environment)
-
Environment variable:
TARGET_PINECONE_ENVIRONMENT
Your Pinecone index name to write data to.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set environment [value]Index Name (index_name)
-
Environment variable:
TARGET_PINECONE_INDEX_NAME
Your Pinecone index name to write data to.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set index_name [value]Metadata Property (metadata_property)
-
Environment variable:
TARGET_PINECONE_METADATA_PROPERTY -
Default Value:
metadata
The property containing the document metadata in the input records.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set metadata_property [value]Pinecone Metadata Text Key (pinecone_metadata_text_key)
-
Environment variable:
TARGET_PINECONE_PINECONE_METADATA_TEXT_KEY -
Default Value:
text
The key in the Pinecone metadata entry that will contain the text document.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set pinecone_metadata_text_key [value]Expand To Show SDK Settings
Add Record Metadata (add_record_metadata)
-
Environment variable:
TARGET_PINECONE_ADD_RECORD_METADATA
Add metadata to records.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set add_record_metadata [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TARGET_PINECONE_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TARGET_PINECONE_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set flattening_max_depth [value]Load Method (load_method)
-
Environment variable:
TARGET_PINECONE_LOAD_METHOD -
Default Value:
append-only
The method to use when loading data into the destination. append-only will always write all input records whether that records already exists or not. upsert will update existing records and insert new records. overwrite will delete all existing records and insert all input records.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set load_method [value]Stream Map Config (stream_map_config)
-
Environment variable:
TARGET_PINECONE_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TARGET_PINECONE_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config target-pinecone set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
-27-c0c0c4){kind=icon}
-1-c0c0c4){kind=icon}
