[![Module Version](https://img.shields.io/hexpm/v/lang_schema.svg)](https://hex.pm/packages/lang_schema)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/lang_schema)

# LangSchema

Converts an abstract schema into JSON schemas required by various AI providers, minimizing code changes when switching providers.

## Design Goals

LangSchema aims to define an abstract schema that can be commonly applied across different AI providers, allowing you to switch providers without modifying your original schema. While provider-specific features are not entirely excluded, supporting every custom feature is not the primary goal. Instead, LangSchema prioritizes raising errors when a schema might implicitly behave incorrectly due to differences between providers, making such issues explicit and easier to fix.

## Concepts

- **Abstract Schema**: A subset of JSON Schema that is primarily used to define structured outputs or function parameters for AI providers. It aims to maintain an independent expression without being tied to any specific provider. For an example, see [schema.ex](https://github.com/nallwhy/lang_schema/blob/main/test/support/schema.ex).
- **JSON Schema**: The concrete output generated by converting the abstract schema to match the specific requirements of each AI provider.

## Converters

Converters are the core components that transform abstract schemas into provider-specific JSON schemas. Each converter implements the `LangSchema.Converter` behaviour and handles the specific requirements and limitations of different AI providers.

Key features of converters:
- **Type Mapping**: Define how abstract types (`:string`, `:integer`, etc.) map to provider-specific implementations
- **Schema Wrapping**: Format the final JSON schema according to provider requirements (e.g., OpenAI's `name` + `schema` structure)
- **Combination Support**: Specify which JSON Schema combinations (`:any_of`, `:one_of`, `:all_of`) the provider supports
- **Custom Keywords**: Handle provider-specific schema keywords and extensions

### Built-in Converters

- OpenAI: [LangSchema.Converter.OpenAI](./lib/lang_schema/converter/openai.ex)
- Gemini: [LangSchema.Converter.Gemini](./lib/lang_schema/converter/gemini.ex)

### Writing a Custom Converter

You can create your own converter for a new AI provider by implementing the `LangSchema.Converter` behaviour.

Here's a simple example based on the OpenAI converter:

```elixir
defmodule MyApp.LangSchema.Converter.MyProvider do
  use LangSchema.Converter

  @impl LangSchema.Converter
  def wrap(json_schema, opts) do
    name = Keyword.get(opts, :name, "response")

    %{
      "name" => name,
      "schema" => json_schema
    }
  end

  @impl LangSchema.Converter
  def types() do
    # Add type converters
    %{
      integer: MyApp.LangSchema.Type.MyProvider.Integer,
      number: MyApp.LangSchema.Type.MyProvider.Number,
      string: MyApp.LangSchema.Type.MyProvider.String,
      array: MyApp.LangSchema.Type.MyProvider.Array,
      object: MyApp.LangSchema.Type.MyProvider.Object,
      null: LangSchema.Type.Null
    }
  end

  @impl LangSchema.Converter
  def allowed_combinations() do
    # List only the combinations your provider supports, e.g., :any_of, :one_of, :all_of
    [:any_of] 
  end

  @impl LangSchema.Converter
  def keywords() do
    %{
      # Add keyword converters
      nullable: MyApp.LangSchema.Keyword.MyProvider.Nullable
    }
  end
end
```

## Adapters

LangSchema provides adapters that convert various input types into abstract schemas or JSON schemas, making it easier to integrate different data structures into the LangSchema ecosystem.

Adapters implement the `LangSchema.Adapter` behaviour and provide a standardized way to convert inputs like:
- Struct typespecs
- `LangChain.FunctionParam` 
- Ash Resources
- Other custom data structures

into LangSchema-compatible abstract schemas or JSON schemas.

## Installation

The package can be installed by adding `lang_schema` to your list of dependencies
in `mix.exs`:

```elixir
def deps do
  [
    {:lang_schema, "~> 0.4.0"}
  ]
end
```

## Relationship with Elixir LangChain

Elixir [LangChain](https://hex.pm/packages/langchain) provides support for structured output using `json_schema` for chat and `parameters_schema` for functions. By leveraging LangSchema with LangChain, you can seamlessly switch between AI providers without changing your code, maintaining a unified schema approach across different integrations.