Redis Vector - Retriever

Redis Vector Retriever

Purpose

Retrieves response for a query from a Redis vector store.

Description

The Redis Vector Retriever component enables to retrieve a response from a Redis vector store. In the given example, the response if fetched from the Redis vector store by sending a request at the required endpoint.

Properties

Property	Data Type	Description
General
Display Name*	String	Display name of the component.
Enable Pause	-NA-	Option to pause the bot execution based upon the signal received from the Cockpit application. The checkbox is selected by default.
Input
Embedding Connection*	IEmbedding	An embedding connection that is to be used to generate the vector embedding for the query text.
EndPoint^#	String	URL to which the HTTP request (seeking a response to the query) is to be sent.
Index Name*	Contents	Name of the index within the vector store that is to be searched for fetching a response to the query.
Password^#	SecureString	Password for authenticating the user name. See also User name.
Port^#	Int32	Port number to be used for accessing the Redis service.
Query*	String	Query for which a response is sought.
Redis URL^@	String	URL to access the Redis service.
User Name^#	String	User name for authorizing access to the required Redis vector store. See also Password.
Misc
Enable Bookmark	-NA-	Option to set a bookmark.
Is Reserved	-NA-	Option to disable data tracing related to the component.
Output
Result*	IVectorStore	An object containing the response to the query.
Preferences
TopK	Int32	Indicates preference about receiving the top K generated responses, where K can be 1, 2, and so on.
Note: Fields marked with * sign are mandatory.