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.
This pull request introduces several enhancements and improvements to the API parameter handling across multiple modules. The main changes include expanding the use of
NotRequiredfor optional parameters, adding new fields for greater flexibility, and improving documentation for several TypedDicts. These updates make the API more robust and easier to use, allowing for more granular control and clearer parameter expectations.API Parameter Enhancements
dimensions,instruction,query) toEmbeddingV2Paramsinjigsawstack/embedding_v2.pyto support advanced embedding configurations.PredictionParamsinjigsawstack/prediction.pyso thatstepsis now optional, with improved documentation for valid ranges and defaults.nameas an optional field toPromptEngineCreateParamsinjigsawstack/prompt_engine.pyfor better prompt identification.max_resultsas an optional parameter toSearchParamsinjigsawstack/search.py, along with logic to include it in search requests. [1] [2] [3]fine_grainedas an optional parameter toVOCRParamsinjigsawstack/vision.pyto enable high-fidelity word-level bounding boxes.Type and Documentation Improvements
element_promptsinAIScrapeParams(jigsawstack/web.py) to accept either a list or a dictionary, with detailed documentation on limits and usage.NotRequiredfromtyping_extensionsin relevant files for consistency.Minor Refactoring
embedding_v2.pyandprompt_engine.py. [1] [2] [3] [4]