The map-gpt-embeddings mapper is a plugin for transforming data between an extractor and a loader. Commonly used for obfuscating, filtering, or removing sensitive data from streams.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the map-gpt-embeddings mapper to your
project using
:meltano add
-
Configure the map-gpt-embeddings
settings using
:meltano config
meltano add mapper map-gpt-embeddings
meltano config map-gpt-embeddings set --interactive
Next steps
Follow the remaining steps of the Getting Started guide:
- Inline Data Mapping
- See the mappers documentation or the plugin repo's README.md for more details on configuration.
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
map-gpt-embeddings
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this mapper. 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 mapper.
This plugin has the following capabilities:
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml
by adding the capabilities
key.
Settings
The
map-gpt-embeddings
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:
Expand To Show SDK Settings
You can also list these settings using
with the meltano config
list
subcommand:
meltano config map-gpt-embeddings 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.
Document Metadata Property (document_metadata_property)
-
Environment variable:
MAP_GPT_EMBEDDINGS_DOCUMENT_METADATA_PROPERTY
-
Default Value:
metadata
The name of the property containing the document metadata.
Configure this setting directly using the following Meltano command:
meltano config map-gpt-embeddings set document_metadata_property [value]
Document Text Property (document_text_property)
-
Environment variable:
MAP_GPT_EMBEDDINGS_DOCUMENT_TEXT_PROPERTY
-
Default Value:
page_content
The name of the property containing the document text.
Configure this setting directly using the following Meltano command:
meltano config map-gpt-embeddings set document_text_property [value]
Openai API Key (openai_api_key)
-
Environment variable:
MAP_GPT_EMBEDDINGS_OPENAI_API_KEY
OpenAI API key. Optional if OPENAI_API_KEY
env var is set.
Configure this setting directly using the following Meltano command:
meltano config map-gpt-embeddings set openai_api_key [value]
Expand To Show SDK Settings
Stream Map Config (stream_map_config)
-
Environment variable:
MAP_GPT_EMBEDDINGS_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config map-gpt-embeddings set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
MAP_GPT_EMBEDDINGS_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 map-gpt-embeddings 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
channel.