Skip to content

Conversation

@Himanshu7921
Copy link

Description

This PR adds a focused, practical Python SDK reference page that documents the most commonly used client and API parameter objects in the Chroma Python client. The new page provides concise tables describing parameter keys, example values, and usage notes for:

  • Client initialization (ChromaClientParams)
  • Settings keys commonly used by clients
  • Collection creation and update
  • Insert, add, and upsert operations
  • Get and peek operations
  • Query/search operations

Each section includes short, copy-paste Python examples to support quick onboarding and diagnostics. An example end-to-end workflow is also included. This reference directly addresses the request in issue #5407 by making parameter keys and usage patterns discoverable and easy to validate.

In addition, the main Python reference index (chroma-reference.md) now links to the new page for improved discoverability.

No changes were made to runtime code or API behavior—this is a documentation-only update.


What changed

  • Added:
    • docs/docs.trychroma.com/markdoc/content/reference/python/client-params.md
      • Tables and examples for all major Python client parameter objects
      • Example values, usage notes, and validation caveats
      • End-to-end workflow example
  • Updated:
    • docs/docs.trychroma.com/markdoc/content/reference/chroma-reference.md
      • Added a discoverable link to the new Python SDK reference page

Motivation

Existing documentation does not clearly list the accepted keys and example values for client and API parameter objects. This PR provides a concise and approachable reference so contributors and integrators can quickly see:

  • Which arguments to pass for common operations
  • Example values and validation notes
  • Minimal runnable code snippets

This resource is designed to reduce onboarding friction for new contributors and prevent repetitive review questions about parameter usage.


How to review

  1. Open the new reference page:
    • docs/docs.trychroma.com/markdoc/content/reference/python/client-params.md
  2. Confirm that parameter tables accurately reflect canonical names and expected values.
  3. Spot-check Python examples—they are intended to be minimal, valid, and runnable.
  4. Verify that the link to the reference page was added to the Reference index:
    • docs/docs.trychroma.com/markdoc/content/reference/chroma-reference.md
  5. (Optional) Build the docs site locally using your standard workflow to preview the new page.

Addresses: #5407

@github-actions
Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@propel-code-bot
Copy link
Contributor

propel-code-bot bot commented Oct 24, 2025

Add Python SDK parameter reference docs and link from index

Documentation-only PR that introduces a new Markdown page (client-params.md) containing tabular references and code snippets for the most used Python SDK parameter objects and updates chroma-reference.md to surface the new page and fix two JavaScript spelling issues. No source code or runtime behaviour is modified.

Key Changes

• Added new reference file docs/docs.trychroma.com/markdoc/content/reference/python/client-params.md (~250 lines) with parameter tables, examples and an end-to-end workflow
• Updated docs/docs.trychroma.com/markdoc/content/reference/chroma-reference.md to: fix 'JavaScript' spelling, insert row label change, and add link to the new Python SDK reference section

Affected Areas

• Documentation site: Python reference section
• Reference index page links/spelling

This summary was automatically generated by @propel-code-bot

…ned in the table above. Either document `images` in the parameter table or remove it from this bullet to avoid confusion.
Copy link
Author

@Himanshu7921 Himanshu7921 left a comment

Choose a reason for hiding this comment

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

Applied all Suggestions

@Himanshu7921
Copy link
Author

Hi maintainers 👋

Could you please approve the workflow runs for this pull request?
It looks like the required GitHub Actions workflows are currently awaiting manual approval, which is blocking the status checks and further review.

Once the workflows are approved, all required checks should run and report their results, allowing the PR to move forward in the review and merge process.

If you have any feedback or requested changes after the checks complete, please let me know—I’m happy to address them promptly.

Thank you very much for your time and for helping with the approval and review!

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.

1 participant