openai

OpenAI

The OpenAI provider for facades.AI() of Goravel.

Version

Install

Run the command below in your project to install the package automatically:

./artisan package:install github.com/goravel/openai

This registers the service provider and updates config/ai.go so ai.providers.openai.via resolves through openaifacades.OpenAI("openai").

Or check the setup file to install the package manually.

Custom Failover

The provider marks these OpenAI HTTP errors as failoverable by default:

Configure failover rules to add OpenAI-specific error message mappings. Plain strings use substring matching, and slash-delimited strings use Go regular expressions.

"openai": map[string]any{
	"key": config.Env("OPENAI_API_KEY", ""),
	"failover": map[string][]string{
		"context_length_exceeded": {
			"maximum context length",
			"/(?i)context.*length/",
		},
	},
	"via": func() (ai.Provider, error) {
		return openaifacades.OpenAI("openai")
	},
}

Testing

Run command below to run all tests:

go test ./...

Run the live OpenAI smoke test with a real API key:

OPENAI_API_KEY=your-key go test -run '^TestProviderPromptIntegration$' -v ./...

The smoke test skips automatically when OPENAI_API_KEY is not set.