API Reference mentor v0.2.2

The Mentor module facilitates interactions with Large Language Models (LLMs) by managing conversation state, configuring adapters, and validating responses against specified schemas.

Helper module to generate JSON Schema based on Ecto schema.

Provides functionality to integrate Ecto schemas with the Mentor framework, ensuring that schemas include comprehensive field documentation.

Mentor.Ecto.Type is a behaviour that lets your implement your own custom Ecto.Type that works natively with Instructor.

Defines the behaviour for HTTP client adapters within the Mentor framework.

An HTTP client adapter for the Mentor framework, utilizing the Finch library for efficient and performant HTTP requests.

Defines the behaviour for Large Language Model (LLM) adapters within the Mentor framework.

An adapter for integrating OpenAI's language models with the Mentor framework.

Responsible for verifying if all schema fields are present in the documentation either in the @moduledoc attribute or as the return of the llm_description/0 callback.

Defines the Mentor.Schema behaviour for integrating various data structures with the Mentor framework. This behaviour allows for the creation of schema adapters, enabling Mentor to work seamlessly with different data representations such as Ecto schemas, raw structs, and maps.

Fields

• series: an array of integers

A description of Brazilian Politicians and the offices that they held, you can specify only the most relevants held offices in the past 20 years.