fix: Update Context Grounding SDK Contract#1355
Conversation
| preprocessing_request: Optional[str] = LLMV4_REQUEST, | ||
| extraction_strategy: Optional[str] = None, | ||
| embeddings_enabled: Optional[bool] = None, | ||
| is_encrypted: Optional[bool] = None, |
There was a problem hiding this comment.
This is a breaking-change in the public contracts. You need to increment minor and release notes
There was a problem hiding this comment.
I think it's best if we wait a bit for the uipath-platform refactor and include this change with that PR @radu-mocanu
| default=None, alias="dataSource" | ||
| ) | ||
| pre_processing: Any = Field(default=None, alias="preProcessing") | ||
| fields: Optional[List[ContextGroundingField]] = Field(default=None, alias="fields") |
There was a problem hiding this comment.
are the changes deployed to all rings? pydantic validation will fail otherwise
There was a problem hiding this comment.
we have done it in stages - right now we have both new and old, but want to now drop old (preProcessing, and fields)
There was a problem hiding this comment.
let s wait a bit with this PR
we are preparing a big refactor -> extracting platform module into another library. we will need to cherry pick those changes there, once this PR is merged
Why not creating a new branch for that? Timeline? |
already did #1354. since this PR contains breaking changes we can increase minor only once. will merge those changes on Monday |
There was a problem hiding this comment.
changes cherry picked 🍒 https://github.com/UiPath/uipath-platform-python/pull/2/changes/88032b69340ea118b05ac103620682e5c5c9042d
@JeremyReist2 we can keep the sdk reference changes and merge them after the above mentioned PR
extraction_strategy,embeddings_enabled,is_encryptedv2.9.0
Breaking Changes
Context Grounding API: Simplified Index Configuration
The Context Grounding SDK has been updated to align with the OData v2.0 Index API contract. The PreProcessing OData-typed object and fields array have been removed in favor of simpler top-level fields.
Removed classes:
PreProcessingContextGroundingFieldRemoved ContextGroundingIndex fields:
pre_processingfieldsRemoved
create_index()/create_index_async()parameters:advanced_ingestionpreprocessing_requestNew
create_index()/create_index_async()parameters:extraction_strategy: Optional[str]— "NativeV1" or "LLMV4" (defaults to NativeV1 server-side)embeddings_enabled: Optional[bool]— Whether to generate embeddings (defaults to true server-side)is_encrypted: Optional[bool]— Whether to encrypt the index (defaults to false server-side)Migration example: