You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

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.

  1. 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.
  2. 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

  3. 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

PropertyDescriptionDefaultTypeRequired
typeStage class name-stringYes
enableEnable stage for executiontruebooleanNo
nameName for this specific stage"vector"stringNo
save_to_intermediateIf true, the result of the stage will be stored in the intermediate instead of the final sectionfalsebooleanNo
expand_resultIndicates if the result of this stage should be expanded into the final data dictionary instead of being appended as usualfalsebooleanNo
halt_on_exceptionIndicates if the pipeline should be interrupted in case of an exceptiontruebooleanNo
modelIndicates the model to be used to calculate or retrieve the vectors. Its restricted by the types allowed by the enum.

EnumSaga.SAGA

EnumYes

open_ai_api_key

This is your Open AI key to use the chat from your service provideros.environ.get('OPEN_AI_API_KEY', 'default_key')stringNo

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')stringNo

open_ai_api_type

API type, its restricted by the types allowed by the enum.EnumOpenAiType.AZUREEnumNo

open_ai_api_version

API version of the Open AI chatos.environ.get('OPEN_AI_API_VERSION', '2023-03-15-preview')stringNo

path_to_input

Path to the input in the intermediate that is going to be targeted by this stage to calculate the vectorqstringNo


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.


ParameterDescription
qA string query for performing a search, this is the target text for the calculate vector. Its path is specified in path_to_input property

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

_calculate_vector = CalculateVectorStage(
    type='CalculateVectorStage',
    enable=True,
    name='VectorStage',
    model=EnumOpenAI.OPENAI_EMBEDDING_ADA,
    open_ai_api_key='yourapikey',
    open_ai_api_base_url='baseurl',
    open_ai_api_type=EnumOpenAiType.AZURE,
	path_to_input='q'
)
  • No labels