Skip to content

Index

Module to interact with Knowledge Models.

This module contains class to interact with Knowledge Models in Studio.

Typical usage example 
knowledge_model = package.get_knowledge_model(ANALYSIS_ID)
knowledge_model = package.create_knowledge_model(content)
knowledge_model.delete()

KnowledgeModel

Bases: ContentNode

Knowledge model object to interact with knowledge model specific studio endpoints.

get_content 

get_content(
    with_variable_replacement=True,
    with_autogenerated_data_model_data=True,
    with_default_values=True,
    validate_pql=True,
    with_unknown_variables_validation=True,
)

Returns content of knowledge model.

resolve_query 

resolve_query(query, draft=True, **kwargs)

Returns Data Query and Query environment for a knowledge model.

Use this method to resolve queries that are based on Knowledge Model content. The returned DataQuery and QueryEnvironment can than be used to query data via DataModel.export_data_frame.

Parameters:

  • query (PQL) –

    PQL query to be resolved.

  • draft (bool) –

    If true, uses draft of knowledge model, if false uses published version.

  • **kwargs (typing.Any) –

    Key word arguments are passed to get_content function.

Returns: