Skip to content

Docs: ChromaDotNet.Embeddings, the embeddings of the Python client - #146

Merged
Laurianti merged 1 commit into
mainfrom
docs-embeddings-package
Oct 21, 2026
Merged

Laurianti merged 1 commit into
mainfrom
docs-embeddings-package

Conversation

@Laurianti

Copy link
Copy Markdown
Member

Documentation only: ChromaDotNet.Embeddings in the docs of the client.

docs/embeddings.md starts with ChromaDotNet.Embeddings, which computes the vectors of the default embedding function of Chroma, the ones of the Python client, before the example with OpenAI, which stays:

  • a short example: ChromaDefaultEmbeddingGenerator.CreateAsync(), a ChromaCollectionDefinition that declares the function default, WithEmbeddingGenerator, AddAsync with documents only and QueryAsync by text;
  • one sentence on the limits: a preview, 64-bit processes only, not on Intel Macs, with the link to its repository;
  • the SearchByText sample of ChromaDotNet.Local and its Codespace.

The README links it next to the line of ChromaDotNet.Local.

The example was built and run as written, against ChromaDotNet.Client 2.18.0 and ChromaDotNet.Embeddings 1.0.0-preview.3 from nuget.org, on Chroma 1.5.9: "something sour" finds the lemon, and the collection stores {"type":"known","name":"default"} as its embedding function.

No code changes, no new version.

docs/embeddings.md starts with ChromaDotNet.Embeddings and a short example, run against the packages of nuget.org on Chroma 1.5.9,
with its limits and the SearchByText sample of ChromaDotNet.Local; the README links it next to ChromaDotNet.Local.
@Laurianti
Laurianti requested a review from a team as a code owner October 21, 2026 13:39
Copilot AI balanced review requested due to automatic review settings October 21, 2026 13:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation matches the client APIs and linked package documentation, with no unresolved issues.

No open issues 🎉

What changed in this PR

Documents ChromaDotNet.Embeddings as a way to generate Python-compatible default embeddings in .NET.

Changes:

  • Adds a README link to the embeddings package and guide.
  • Adds a usage example, platform limitations, and sample/Codespace links while retaining the OpenAI example.
File Description
README.md Links to ChromaDotNet.Embeddings and its guide.
docs/​embeddings.md Introduces default embeddings with setup, usage, limitations, and sample links.

Review effort: Balanced

@Laurianti
Laurianti merged commit 81c4f2f into main Oct 21, 2026
16 checks passed
@Laurianti
Laurianti deleted the docs-embeddings-package branch October 21, 2026 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants