Vector

The Calculate Vector Stage is the first step of semantic search. In this stage the vector is calculated or retrieved based on the model given by the user. There are 3 types of models enumerated.

Saga model: This model retrieves the vector from saga, an entry with the value is require in saga. The value needs to be the same as the saga stage name.
Open AI model: This model calculates the vector with Open AI API, this needs the credentials to make calls to the API as environment variables. These are the supported Open AI models:
1. text-embedding-ada-002
2. text-search-ada-doc-001
3. text-search-curie-doc-001
Sentence Transformer GTR: This model calculates the vector with the GTR component of the python library sentence_transformer. These are the supported GTR models:
1. sentence-transformers/gtr-t5-base
2. sentence-transformers/gtr-t5-large
3. sentence-transformers/gtr-t5-xl
4. sentence-transformers/gtr-t5-xxl

The Calculate Vector Stage stores the vector on intermediate for the Create Query Stage usage.

Properties

Property	Description	Default	Type	Required	QPL Config?
type	Stage class name	-	string	Yes	No
enable	Enable stage for execution	true	boolean	No	No
name	Name for this specific stage	"vector"	string	No	No
save_to_intermediate	If true, the result of the stage will be stored in the intermediate instead of the final section	false	boolean	No	No
expand_result	Indicates if the result of this stage should be expanded into the final data dictionary instead of being appended as usual	false	boolean	No	No
halt_on_exception	Indicates if the pipeline should be interrupted in case of an exception	true	boolean	No	No
model	Indicates the model to be used to calculate or retrieve the vectors. Its restricted by the types allowed by the enum.	EnumSaga.SAGA	Enum	Yes	No
open_ai_api_key	This is your Open AI key to use the chat from your service provider	os.environ.get('OPEN_AI_API_KEY', 'default_key')	string	No	No
open_ai_api_base_url	Base url of your service provider for Open AI chat.	os.environ.get('OPEN_AI_API_BASE_URL', 'default_url')	string	No	No
open_ai_api_type	API type, its restricted by the types allowed by the enum.	EnumOpenAiType.AZURE	Enum	No	No
open_ai_api_version	API version of the Open AI chat	os.environ.get('OPEN_AI_API_VERSION', '2023-03-15-preview')	string	No	No

Calculate Vector Stage Intermediate Parameters

The Calculate Vector Stage offers a range of parameters that can be passed via the intermediate input to customize your search request or modify the configuration of the current stage. These parameters provide flexibility and control over the search process.

Parameter	Description
q	A string query for performing a search. Can be transformed into engine-specific queries using PyQPL (Query Parser Language).
query	Engine-specific queries for the search.
knn	Engine-specific queries specifically for k-nearest neighbor (KNN) searches.
filters	Calculated filters for search. This with knn parameter get stored on the same variable as a tuple, this is the second parameter of the tuple.
size	Number of results to return from the search request. Overrides the size specified in the configuration.
from/start	Indicates the starting point for retrieving search results. Can be used interchangeably with the page parameter.
page	It can be an alternative to from/start. It calculates the start based on the size parameter.
fetch_fields	List of fields to fetch for each search result. Overrides the fields specified in the configuration.
exclude_fields	List of fields to exclude from the search results. Overrides the fields specified in the configuration.
scroll	Scroll ID used to retrieve large numbers of results from a single search request, similar to a cursor in a traditional database.
operator	The default operator for query string queries: AND or OR. Overrides the default operator specified in the configuration.
vector	Calculated vectors use to create the knn query.

Remember that the intermediate can be fill with either other stages or the original request body that trigger the pipeline, making this essentially REST API parameters

Example Configuration

_vector_stage = CalculateVectorStage(
    enable=True,
    save_to_intermediate=True,
    expand_result=False,
    halt_on_exception=False,
    name=VECTOR_STAGE_NAME,
    model=EnumOpenAI.OPENAI_EMBEDDING_ADA,
    open_ai_api_key=os.environ.get('OPEN_AI_API_KEY'),
    open_ai_api_base_url=os.environ.get('OPEN_AI_API_BASE_URL'),
    open_ai_api_type=EnumOpenAiType.AZURE,
    open_ai_api_version='2023-03-15-preview',
    type='CalculateVectorStage'
)

Space shortcuts

Page tree

Properties

Calculate Vector Stage Intermediate Parameters

Example Configuration