Feature store APIs
Operations for managing and storing feature sets (data) in the platform for access and reference. Includes methods for creating, deleting, searching, etc for feature sets.
vianops_client.api.featurestore.feature_sources
- class FeatureSourcesV1Api(config: Config | None = None)
Bases:
ConfiguredBaseApiClass
- create(data: V1FeatureSourcesList, output_type: str = 'object') V1FeatureSourcesList
Add new feature sources to the system.
- Parameters:
data (V1FeatureSourcesList) – A list of feature sources to add.
- Returns:
The response from adding feature sources.
- Return type:
- delete(data: V1FeatureSourceFilters, deletetype: str = 'archive', output_type: str = 'object') V1FeatureSourcesList
Delete feature sources
- Parameters:
data (V1FeatureSourceFilters) – Instance containing the required data to select, and archive or delete the selected feature sources.
deletetype (str) – The deletion type. Supported values: archive, delete, force_delete. Default: archive.
- Returns:
nstance containing response from deletion of feature sources.
- Return type:
- delete_url = '/v1/feature-sources/{deletetype}'
- export(setname: str, limit: int | None = None, start: int | None = None, end: int | None = None, output: str | None = None, datetime: float | None = None)
Retrieve raw features from a feature set.
- Parameters:
setname (str) – The name of the feature set to retrieve.
limit (Optional[int]) – The maximum number of rows to retrieve.
start (Optional[int]) – The starting index for retrieval.
end (Optional[int]) – The ending index for retrieval.
output (Optional[str]) – The desired output format (e.g., “csv”, “parquet”, “json”).
datetime (Optional[float]) – A timestamp to filter features by datetime.
output_type (str) – The type of the output (e.g., “object”, “file”).
- Returns:
The raw features in the specified format or as a JSON response.
- Return type:
Union[FileResponse, JSONResponse, Any]
- list(output_type: str = 'objects', raw_response: bool = False)
List feature sources.
- Parameters:
output_type (str) – The type of the output (e.g., “objects”, “json”).
raw_response (bool) – If True, return the raw response from the API call.
- Returns:
The response from the API call, either raw or processed.
- Return type:
Union[Response, V1FeatureSourcesList]
- search(data: V1FeatureSourceSearch, output_type: str = 'object') V1FeatureSourceModelPage
Search for feature sources
- Parameters:
data (V1FeatureSourceSearch) – Instance containing data to search for feature sources.
- Returns:
Response containing results from search along with pagination details.
- Return type:
- search_url = '/v1/feature-sources/search'
- update(data: V1FeatureSourcesUpdates, output_type: str = 'object') V1FeatureSourcesList
Update existing feature sources
- Parameters:
data (V1FeatureSourcesUpdates) – Instance containing information about the updates for feature sources.
- Returns:
Instance containing information about the updated feature sources.
- Return type:
- url_suffix = '/v1/feature-sources'