feat(examples): add custom HTTP embedding example for LM Studio / Ollama#149
Open
cluster2600 wants to merge 1 commit intoalibaba:mainfrom
Open
feat(examples): add custom HTTP embedding example for LM Studio / Ollama#149cluster2600 wants to merge 1 commit intoalibaba:mainfrom
cluster2600 wants to merge 1 commit intoalibaba:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR adds a self-contained example showing how to use any OpenAI-compatible HTTP embedding endpoint (LM Studio, Ollama, vLLM, LocalAI, …) as the embedding source in zvec.
What's added
examples/custom_http_embedding.pyHTTPEmbeddingFunction/v1/embeddingsendpoint, caches results with@lru_cache, and satisfies theDenseEmbeddingFunctionprotocol.--base-url,--model,--api-key,--collection-pathflags for easy customisation.Usage
Motivation
The existing extensions (
OpenAIDenseEmbedding, etc.) require theopenaipackage and are primarily designed for cloud APIs. Many developers want to use local inference servers without extra dependencies. This example shows the pattern using only Python stdlib, making it easy to adapt or inline.Testing
The example runs end-to-end against a live LM Studio instance on
localhost:1234. No new test infrastructure is required for a standalone script.