Repository navigation
Python: correct Ollama embedding truncate default documentation - #9672
Open
LI (ktz03) wants to merge 1 commit into
Open
LI (ktz03) wants to merge 1 commit into
LI (ktz03) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The narrowly scoped documentation correction matches the server default and introduces no runtime changes.
No open issues 🎉
What changed in this PR
Corrects the documented default for OllamaEmbeddingOptions.truncate in the Python Ollama integration to match the embed API.
Changes:
- Moves the default marker from
FalsetoTruein the attribute docstring. - Leaves runtime behavior, APIs, and dependencies unchanged.
| File | Description |
|---|---|
python/packages/ollama/agent_framework_ollama/_embedding_client.py |
Corrects the truncate default documentation. |
Review effort: Balanced
This branch was successfully deployed
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.
Motivation & Context
The
OllamaEmbeddingOptions.truncatedocumentation says the default isFalse. Ollama's embed API reference documentstrueas the default. When the option is omitted, the adapter leaves the server default in effect.Description & Review Guide
FalsetoTruein the existing option docstring.Related Issue
N/A - trivial change. This corrects a factual default in an attribute docstring to match the documented API. It does not change the implementation or introduce a behavior choice.
AI Assistance
AI assistance details: Documentation and this PR description.
Contribution Checklist