citrine.informatics.catalyst.insights module

class citrine.informatics.catalyst.insights.InsightsRequest(*, question: str, temperature: float | None = 0.0, language_model: LanguageModelChoice | None = LanguageModelChoice.GPT_35_TURBO, n_documents: int | None = 5, response_size: int | None = 100)

Bases: Serializable[InsightsRequest]

A query to the model insights.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

language_model = 'gpt-3.5-turbo'

n_documents = 5

question = None

response_size = 100

temperature = 0.0

class citrine.informatics.catalyst.insights.InsightsResponse

Bases: Serializable[InsightsResponse]

A response from the model insights.

classmethod build(data: dict) → Self

Build an instance of this object from given data.

dump() → dict

Dump this instance.

document_metadata = None

relevant_documents = None

response = None