citrine.resources.catalyst module

class citrine.resources.catalyst.CatalystResource(session: Session)

Bases: object

Encapsulates th ability to invoke Catalyst.

assistant(query: str, *, predictor: GraphPredictor) AssistantResponse

Invoke the model assistant.

Parameters:
  • query (str) – The query or instruction to pass to the assistant

  • predictor (GraphPredictor) – The predictor you wish for the assistant to consider or act on in your query

Return type:

The assistant response, containing details of the result of your query which vary by type.

insights(query: str) InsightsResponse

Invoke the insights.

Parameters:

query (str) – The query or instruction to pass to the insights

Return type:

The insights response, containing details of the result of your query which vary by type.