[Embed] feat: Add api_key and url parameters for custom embedding services #137
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Allows using OpenAI-compatible APIs (Ollama, custom models) instead of only Typesense Cloud models for embeddings.
Validates that api_key and url parameters are properly accepted in embed.model_config without throwing exceptions.
npotier
reviewed
Nov 27, 2025
| 'token_separators' => $config['token_separators'], | ||
| 'symbols_to_index' => $config['symbols_to_index'], | ||
| 'enable_nested_fields' => $config['enable_nested_fields'] ?? false, | ||
| 'embed' => $config['embed'] ?? null, |
Member
There was a problem hiding this comment.
Hello @ahmed-bhs what is this embed attribute ? I don't see it in Typesense doc
Contributor
Author
There was a problem hiding this comment.
Hello @npotier ,
You're absolutely right! The embed attribute only exists at the field level in Typesense, not at the collection level.
However in your PR #121 , you added the $embed parameter to CollectionClient::create() and passed $definition['embed'] ?? null. Since this is always null (embed only exists in fields), what was the intended use case?
- Remove embed from collection config (only exists at field level) - Update CollectionClient and CollectionManager accordingly - Improve test coverage for embed field configuration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
api_keyandurlparameters toembed.model_config, enabling the use of custom embedding services (Ollama, OpenAI, local models) instead of being limited to TypesenseCloud models.
Usage Example