[NA] [SDK] alexkuzmik / Improve API of search_prompts, remove name param #3188
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
There was a problem hiding this comment.
Pull Request Overview
This PR removes the deprecated name parameter from the search_prompts method in the Python SDK, standardizing the API to use only the filter_string parameter with Opik Query Language (OQL) for filtering prompts by name and other criteria.
Key changes:
- Simplifies the
search_promptsAPI by removing the redundantnameparameter - Updates all usage to use OQL filtering via
filter_stringinstead - Maintains backward compatibility by providing equivalent functionality through OQL syntax
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
sdks/python/src/opik/api_objects/opik_client.py |
Removes name parameter from search_prompts method signature and implementation |
sdks/python/tests/e2e/test_prompt.py |
Updates test cases to use OQL filtering instead of the removed name parameter |
apps/opik-documentation/documentation/fern/docs/prompt_engineering/prompt_management.mdx |
Updates documentation examples to demonstrate OQL filtering syntax |
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.
Details
Remove obsolete name parameter from search_prompts method.
Change checklist
Issues
Testing
Updated e2e tests
Documentation
Updated docs