-
Notifications
You must be signed in to change notification settings - Fork 3
fix: Validate the completion params that are passed as input to the API #3 #17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
katwinkl3
wants to merge
6
commits into
main
Choose a base branch
from
katwinkl3/validate_completion_params
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3230d76
Only checks if message key exists. LiteLLM raises an exception if th…
katwinkl3 cd50c93
lint
katwinkl3 555932a
add messages checks
katwinkl3 7e19ee6
clean import
katwinkl3 a83295b
Update tlm/utils/chat_completion_validation.py
katwinkl3 11e2985
review comments
katwinkl3 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| import pytest | ||
|
|
||
| from tlm.utils.chat_completion_validation import _validate_chat_completion_params | ||
|
|
||
|
|
||
| def test_validate_chat_completion_params_allows_valid_openai_keys() -> None: | ||
| params = {"messages": [], "model": "gpt-4.1", "temperature": 0.5} | ||
|
|
||
| _validate_chat_completion_params(params) | ||
|
|
||
|
|
||
| def test_validate_chat_completion_params_allows_provider_as_none() -> None: | ||
| params = {"messages": [], "model": "gpt-4.1", "temperature": 0.5} | ||
|
|
||
| _validate_chat_completion_params(params) | ||
|
|
||
|
|
||
| def test_validate_chat_completion_params_requires_messages() -> None: | ||
| params = {"model": "gpt-4.1-mini"} | ||
|
|
||
| with pytest.raises(ValueError) as exc_info: | ||
| _validate_chat_completion_params(params) | ||
|
|
||
| assert "openai_args must include the following parameter(s): messages" in str(exc_info.value) |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| """Validation helpers for chat completion parameter dictionaries.""" | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| # from litellm import get_supported_openai_params | ||
| from tlm.types.base import CompletionParams | ||
| from typing import FrozenSet | ||
|
|
||
|
|
||
| REQUIRED_CHAT_COMPLETION_PARAMS: FrozenSet[str] = frozenset({"messages"}) | ||
|
|
||
|
|
||
| def _validate_chat_completion_params(params: CompletionParams) -> None: | ||
| """Ensure only supported chat completion params are passed into inference.""" | ||
|
|
||
| missing_required = [param for param in REQUIRED_CHAT_COMPLETION_PARAMS if param not in params] | ||
| if missing_required: | ||
| required_str = ", ".join(sorted(REQUIRED_CHAT_COMPLETION_PARAMS)) | ||
| raise ValueError(f"openai_args must include the following parameter(s): {required_str}") | ||
|
|
||
| return | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we also check that messages is non-empty? (i'm not sure if a chat completion can be generated without any messages)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and can we also validate that the message items are properly formatted, e.g. include role and content?
https://docs.litellm.ai/docs/completion/input#required-fields