What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
Feature: Prefixes
What is the current behavior? (You can also link to an open issue here)
Currently we do not prepend prefixes by default to e-5 models, nor do we allow prepending custom prefixes to any other model.
What is the new behavior (if this is a feature change)?
e-5 models will have prefixes for queries and chunks by default, as defined in the model registry. Users will also be able to define their own custom prefixes for chunks to be added as documents and their queries.
In the embed endpoint, we have a new field: content_type with 3 Options: ‘query’, ‘document’, None. Defaults to ‘query’.
If the user wants to use the default text_query_prefix, leave it as ‘query’.
If the user wants to use the default text_chunk_prefix, leave it as ‘document’.
If the user wants a custom prefix, they must put it in the content itself.
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
None Identified. the new fields are optional
Have unit tests been run against this PR? (Has there also been any additional testing?
Tests have been created and passed
Related Python client changes (link commit/PR here)
Related documentation changes (link commit/PR here)
Other information:
Please check if the PR fulfills these requirements
[ ] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes/features)
[ ] Docs have been added / updated (for bug fixes / features)
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) Feature: Prefixes
What is the current behavior? (You can also link to an open issue here) Currently we do not prepend prefixes by default to e-5 models, nor do we allow prepending custom prefixes to any other model.
What is the new behavior (if this is a feature change)? e-5 models will have prefixes for
queries
andchunks
by default, as defined in the model registry. Users will also be able to define their own custom prefixes forchunks
to be added as documents and theirqueries
.In the
embed
endpoint, we have a new field:content_type
with 3 Options: ‘query’, ‘document’, None. Defaults to ‘query’.Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?) None Identified. the new fields are optional
Have unit tests been run against this PR? (Has there also been any additional testing? Tests have been created and passed
Related Python client changes (link commit/PR here)
Related documentation changes (link commit/PR here)
Other information:
Please check if the PR fulfills these requirements
[ ] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes/features)
[ ] Docs have been added / updated (for bug fixes / features)