Production use of this feature is available for specific editions only. Contact our sales team for more information.
- Read Available regions to check whether Snowpark Container Services is available in your preferred region.
- Read Service Specification Reference for detailed information about the Snowpark Container Services specification.
Properties
A human-readable name for the component.
The Snowflake database. The special value
[Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.The Snowflake schema. The special value
[Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.Select your Snowpark Container Services service. The services available in this list will depend on the selected database and schema.
Select the endpoint name representing the TCP network port that your application exposes.
The path to your selected endpoint.
Optionally supply key:value metadata pairs such as
top_p, n, max_tokens, and so on to be sent to the large language model.Ensure that no personal data, sensitive data, export-controlled data, or other regulated data is entered as metadata in the specification file.The Snowflake source database. The special value
[Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.The Snowflake source schema. The special value
[Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.An existing Snowflake table to use as the input.
Set a column as the primary key. Join the results back to the input table.
Set a limit for the numbers of rows from the table to load. The default is 1000.
Provide your prompt. When Output Format is TEXT, this property is where you must specify all of the questions that you wish the LLM to provide answers to.Prompts should define the following information:
- A persona. Who or what should the model impersonate when contextualizing their generative responses?
- A context. Contextualize the situation for the model to enhance its responses.
- A tone. What kind of language do you want the model to use?
Select the source columns to feed as input to the prompt component.
- Column Name: A column from the input table.
- Descriptive Name: An alternate descriptive name to better contextualize the column. Recommended if your column names are low-context.
Choose TEXT or JSON. Choosing JSON will activate an additional property, Outputs.
JSON only.Define the output columns the prompt component will generate.
- Output: Key of a
key:valueJSON pair. For example, an output might be “review_score”. - Context: Text that defines the output you expect the model to provide—that is, some task for the model to perform. For example, “Give a score between 0 and 10 on the level of satisfaction you feel in the user’s review where 0 is completely dissatisfied and 10 is extremely satisfied.” You may wish to use this parameter to configure the tone of the model (where applicable).
The Snowflake destination database. The special value
[Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.The Snowflake destination schema. The special value
[Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.The new Snowflake table to load your prompt output into. Will create a new table if one does not exist. Otherwise, will replace any existing table of the same name.
- Replace if Table Exists: The pipeline will run despite the table already existing. The table will be recreated.
- Fail if Table Exists: If the table already exists, the pipeline will fail to run.
- Append: If the table already exists, any new rows (records) will be added to the table without modifying or deleting existing rows. If the table does not exist, it is created and any new rows are inserted.
Click Yes to enable Retrieval-Augmented Generation (RAG). Using RAG optimizes an LLM output by invoking an authoritative knowledge base outside of the LLM’s initial training data sources. By using RAG, you can extend an LLM’s capabilities to specific domains, such as your organization’s documentation, without needing to retrain the model.Defaults to No.
Add text to your LLM prompt before the RAG data is listed, thus instructing the LLM what to do with the RAG data. For example, you might wish to use RAG to search relevant documentation snippets to answer a question.Example:“Use any of the following documentation snippets in your response, if relevant:”
Choose a column in the source table that contains a search term for the vector database. The value is then taken from that column and a vector search is performed. For example, a column value might be a user question such as “How do I log in?”. A search is then performed on the vector database using the value string, which will return N number of relevant data. N is defined by the Top K parameter, further down.If your vector database contained vectors created from chunks of text documentation, in this scenario the RAG data returned may include the chunk “to log in, click on the key button in the top right and enter your username and password”. This data is then inserted into the llm prompt to help provide relevant context.
The embedding provider is the API service used to convert the search term into a vector. Choose either OpenAI or Amazon Bedrock. The embedding provider receives a search term (e.g. “How do I log in?”) and returns a vector.Choose your provider:
- OpenAI
- Amazon Bedrock
Use the drop-down menu to select the corresponding secret definition that denotes the value of your OpenAI API key.Read Secrets and secret definitions to learn how to create a new secret definition.To create a new OpenAI API key:
- Log in to OpenAI.
- Click your avatar in the top-right of the UI.
- Click View API keys.
- Click + Create new secret key.
- Give a name for your new secret key and click Create secret key.
- Copy your new secret key and save it. Then click Done.
Select an embedding model.Currently supports:
- text-embedding-ada-002
- text-embedding-3-small
- text-embedding-3-large
Select a vector database to use.Currently supports Pinecone and Postgres.
- Pinecone
- Postgres
Use the drop-down menu to select the corresponding secret definition that denotes the value of your Pinecone API key.Read Secrets and secret definitions to learn how to create a new secret definition.
The name of the Pinecone vector search index to connect to. To retrieve an index name:
- Log in to Pinecone.
- Click PROJECTS in the left sidebar.
- Click a project tile. This action will open the list of vector search indexes in your project.
The name of the Pinecone namespace. Pinecone lets you partition records in an index into namespaces. To retrieve a namespace name:
- Log in to Pinecone.
- Click PROJECTS in the left sidebar.
- Click a project tile. This action will open the list of vector search indexes in your project.
- Click on your vector search index tile.
- Click the NAMESPACES tab. Your namespaces will be listed.
The number of results to return from the vector database query.Between 1-100.Default is 3.
Select the data lookup strategy. Pinecone only stores the vector associated with text data, and a JSON metadata blob. While the text data can be stored in the metadata blob, size limitations can affect coverage—for example when a user has a larger blob of text to be converted to a vector.
- Raw data in metadata: Choosing this option adds an additional property, Data Path, to provide the path to text data within the metadata JSON blob.
- Table details in metadata: Database, schema, and table information is used in the metadata to look up the text data in your warehouse table.
Set the path to the data in the metadata JSON blob.Default is
data.
