Classes and methods

Reference to API classes and methods provided by the Python SDK.

• Datapipeline APIs
  • Submodules
  • vianops_client.api.datapipeline.extraction_metadata module
    • ExtractionMetadataV1Api
  • Module contents
• Feature store APIs
  • vianops_client.api.featurestore.feature_sources
    • FeatureSourcesV1Api
• Inference store APIs
  • vianops_client.api.inferencestore.inference_mapping
    • InferenceMappingV1Api
  • vianops_client.api.inferencestore.inference_tracking
    • InferenceTrackingV1Api
  • vianops_client.api.inferencestore.performance_metrics
    • PerformanceMetricsV1Api
• Job maker APIs
  • vianops_client.api.jobmaker.dataloading
    • DataloadingV1Api
  • vianops_client.api.jobmaker.driftdetection
    • DriftdetectionV1Api
  • vianops_client.api.jobmaker.model_artifacts
    • ModelArtifactsV1Api
  • vianops_client.api.jobmaker.model_deployment
    • ModelDeploymentV1Api
  • vianops_client.api.jobmaker.modelperformance
    • ModelPerformanceV1Api
  • vianops_client.api.jobmaker.preprocessing
    • PreprocessingV1Api
  • vianops_client.api.jobmaker.util
    • JobApiBaseClass
• Model store APIs
  • vianops_client.api.modelstore.alerts
    • AlertsV1API
  • vianops_client.api.modelstore.feature_importance_file_utils
    • check_absolute_percentage_and_sum()
    • check_and_convert_file_to_json()
  • vianops_client.api.modelstore.model_tags
    • ModelsTagsV1Api
  • vianops_client.api.modelstore.models
    • ModelsV1Api
  • vianops_client.api.modelstore.policies
    • PoliciesV1Api
  • vianops_client.api.modelstore.segments
    • SegmentsV1Api
• QNA store APIs
  • Submodules
  • vianops_client.api.qnastore.jargon_lexicon module
    • JargonLexiconV1Api
  • vianops_client.api.qnastore.qna_conversation module
    • QNAConversationV1Api
  • vianops_client.api.qnastore.qna_io module
    • QNAIoV1Api
  • vianops_client.api.qnastore.qna_jargon_identification module
    • QNAJargonIdentificationV1Api
  • vianops_client.api.qnastore.qna_metadata module
    • QNAMetedataV1Api
  • vianops_client.api.qnastore.qna_prompt_generation module
    • QNAPromptGenerationV1Api
  • vianops_client.api.qnastore.qna_report module
    • QNAReportV1Api
  • vianops_client.api.qnastore.qna_sqlgpt module
    • QNASqlGptV1Api
  • vianops_client.api.qnastore.qna_text2sql module
    • QNAText2sqlV1Api
  • vianops_client.api.qnastore.qna_thread module
    • QNAThreadV1Api
  • Module contents
• Risk store APIs
  • vianops_client.api.riskstore.drift
    • DriftV1Api
  • vianops_client.api.riskstore.explainability
    • ExplainabilityV1Api
  • vianops_client.api.riskstore.uncertainty
    • UncertaintyV1Api
  • vianops_client.api.riskstore.model_metrics
    • ModelMetricsV1Api
• User service APIs
  • vianops_client.api.userservice.projects
    • ProjectsV1Api
  • vianops_client.api.userservice.userpreference
    • UserPreferenceV1Api
• Utilities APIs
  • Submodules
  • vianops_client.api.utilities.directories module
    • DirectoryUtilsV1Api
  • Module contents
• Web services APIs
  • vianops_client.api.webservices.external_connection
    • ExternalConnectionV1Api

Utility APIs

vianops_client.api.auth

class AuthV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

get_auth(success_codes=None)

is_authenticated()

login(username=None, password=None)

async login_async(username=None, password=None)

login_using_access_token(access_token: str = None)

logout()

logout_memory()

logout_memory_and_config_file()

setApiKey(api_key=None)

vianops_client.api.cache

class CacheV1Api(config: Config | None = None)

Bases: ConfiguredBaseApiClass

download(upload_key: str, local_output_path: Path)

Download a file from the stack cache.

Parameters:

• upload_key (str) –

• local_output_path (str, Path) – path of output file. Will be overwritten.

request_upload(filename: IO | Path) → str

Upload a file to the cache

Parameters:

filename (str, file-like object, or pathlib.Path) –

Returns:

The response json document

upload(filename: IO | Path) → str

Upload a file to the stack cache

Parameters:

filename – str, file-like object, or pathlib.Path instance

The same as request_upload() expect this function extracts and returns the upload_key instad of the json response document

Returns:

The upload_key