Skip to content

feat: Adding retrieve_online_documents endpoint #5002

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.

Sign up for GitHub

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

Merged
franciscojavierarceo merged 2 commits into from
Feb 3, 2025
Merged

feat: Adding retrieve_online_documents endpoint #5002

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cb6803
feat: Adding retrieve_online_documents endpoint
franciscojavierarceo Feb 3, 2025
889362b
updated feature server
franciscojavierarceo Feb 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/reference/feature-servers/python-feature-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,14 @@ feast serve --key /path/to/key.pem --cert /path/to/cert.pem

## API Endpoints and Permissions

| Endpoint | Resource Type | Permission | Description |
| ---------------------------- |---------------------------------|-------------------------------------------------------| ------------------------------------------------------------------------ |
| /get-online-features | FeatureView,OnDemandFeatureView | Read Online | Get online features from the feature store |
| /push | FeatureView | Write Online, Write Offline, Write Online and Offline | Push features to the feature store (online, offline, or both) |
| /write-to-online-store | FeatureView | Write Online | Write features to the online store |
| /materialize | FeatureView | Write Online | Materialize features within a specified time range |
| /materialize-incremental | FeatureView | Write Online | Incrementally materialize features up to a specified timestamp |
| Endpoint | Resource Type | Permission | Description |
|----------------------------|---------------------------------|-------------------------------------------------------|----------------------------------------------------------------|
| /get-online-features | FeatureView,OnDemandFeatureView | Read Online | Get online features from the feature store |
| /retrieve-online-documents | FeatureView | Read Online | Retrieve online documents from the feature store for RAG |
| /push | FeatureView | Write Online, Write Offline, Write Online and Offline | Push features to the feature store (online, offline, or both) |
| /write-to-online-store | FeatureView | Write Online | Write features to the online store |
| /materialize | FeatureView | Write Online | Materialize features within a specified time range |
| /materialize-incremental | FeatureView | Write Online | Incrementally materialize features up to a specified timestamp |

## How to configure Authentication and Authorization ?

Expand Down
35 changes: 34 additions & 1 deletion sdk/python/feast/feature_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ class GetOnlineFeaturesRequest(BaseModel):
feature_service: Optional[str] = None
features: Optional[List[str]] = None
full_feature_names: bool = False
query_embedding: Optional[List[float]] = None


def _get_features(request: GetOnlineFeaturesRequest, store: "feast.FeatureStore"):
Expand Down Expand Up @@ -104,7 +105,6 @@ def _get_features(request: GetOnlineFeaturesRequest, store: "feast.FeatureStore"
resource=od_feature_view, actions=[AuthzedAction.READ_ONLINE]
)
features = request.features # type: ignore

return features


Expand Down Expand Up @@ -177,6 +177,39 @@ async def get_online_features(request: GetOnlineFeaturesRequest) -> Dict[str, An
)
return response_dict

@app.post(
"/retrieve-online-documents",
dependencies=[Depends(inject_user_details)],
)
async def retrieve_online_documents(
request: GetOnlineFeaturesRequest,
) -> Dict[str, Any]:
logger.warn(
"This endpoint is in alpha and will be moved to /get-online-features when stable."
)
# Initialize parameters for FeatureStore.retrieve_online_documents_v2(...) call
features = await run_in_threadpool(_get_features, request, store)

read_params = dict(
features=features,
entity_rows=request.entities,
full_feature_names=request.full_feature_names,
query=request.query_embedding,
)

response = await run_in_threadpool(
lambda: store.retrieve_online_documents_v2(**read_params) # type: ignore
)

# Convert the Protobuf object to JSON and return it
response_dict = await run_in_threadpool(
MessageToDict,
response.proto,
preserving_proto_field_name=True,
float_precision=18,
)
return response_dict

@app.post("/push", dependencies=[Depends(inject_user_details)])
async def push(request: PushFeaturesRequest) -> None:
df = pd.DataFrame(request.df)
Expand Down
Loading