gollama

Easy Ollama package for Golang

Example use

go get -u github.com/jonathanhecl/gollama

package main

import (
	"context"
	"fmt"

	"github.com/jonathanhecl/gollama"
)

func main() {
	ctx := context.Background()
	g := gollama.New("llama3.2") // Create a new Gollama with the default model
	g.Verbose = true // Enable verbose mode
	if err := g.PullIfMissing(ctx); err != nil { // Pull the model if it is not available
		fmt.Println("Error:", err)
		return
	}

	prompt := "what is the capital of Argentina?" // The prompt to send to the model

	type Capital struct {
		Capital string `required:"true"`
	}

	option := gollama.StructToStructuredFormat(Capital{}) // Convert the struct to a structured format

	fmt.Printf("Option: %+v\n", option)

	output, err := g.Chat(ctx, prompt, option) // Generate a response
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Printf("\n%s\n", output.Content) // Print the response
}

Features

• Support Vision models
• Support Tools models
• Support Structured format
• Downloads model if missing
• Chat with model
• Generates embeddings with model
• Get model details
• Get list of available models

Functions

• New(model string) *Gollama - Create a new Gollama
• NewWithConfig(config Gollama) *Gollama - Create a new Gollama with a pre-populated config
• Chat(prompt string, ...ChatOption) (*gollama.ChatOutput, error) - Generate a response
• Embedding(prompt string) ([]float64, error) - Generate embeddings
• ListModels() ([]ModelInfo, error) - List models available on ollama
• HasModel(model string) (bool, error) - Check if model is available
• ModelSize(model string) (int, error) - Get model size from ollama
• PullModel(model string) error - Pull model
• PullIfMissing(model ...string) error - Pull model if missing
• GetModels() ([]string, error) - Get list of available models
• GetDetails(model ...string) ([]ModelDetails, error) - Get model details from ollama
• Version() (string, error) - Get ollama version
• StructToStructuredFormat(interface{}) StructuredFormat - Converts a Go struct to a Gollama structured format
• CosenoSimilarity(vector1, vector2 []float64) float64 - Calculates the cosine similarity between two vectors
• output.DecodeContent(output interface{}) error - Decodes the content of a Gollama response