Skip to content

AiFoundation module Overview #3451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hidranarias wants to merge 4 commits into
base: master
Choose a base branch
from
Open

AiFoundation module Overview #3451

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1712d9b
Doc: Add instructions for Ollama setup and local configuration overri…
hidranarias Jan 26, 2026
f34a410
Update AiFoundation module Overview
hidranarias Jan 26, 2026
0a6a948
Fix vale md error related to i.e. content¨
hidranarias Feb 6, 2026
86cdb05
Merge branch 'spryker:master' into docs/update-ai-foundation-guide
hidranarias Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions docs/dg/dev/ai/ai-foundation/ai-foundation-module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This document describes how to integrate and use the AiFoundation module to inte

## Install the AiFoundation module

1. Require the package:
1. Access the CLI using `docker/sdk cli`, then require the package:

```bash
composer require spryker/ai-foundation
Expand Down Expand Up @@ -192,11 +192,12 @@ To run Ollama as a service within the Spryker Docker SDK:
- public
```

2. Reference the Ollama compose file in your `deploy.dev.yml`:
2. Reference the Ollama compose file in your current deploy file, for example `deploy.dev.yml`, under the `docker` section:

```yaml
compose:
yamls: ['./ollama.yml']
docker:
compose:
yamls: ['./ollama.yml']
```

3. Update your AI configuration to use the Ollama service URL:
Expand All @@ -220,8 +221,11 @@ To run Ollama as a service within the Spryker Docker SDK:

5. Pull the required Ollama model:

The container name is composed of the Docker deploy file namespace and the service name.
Example: `spryker_b2b_marketplace_ollama_1`

```bash
docker/sdk cli exec -c ollama ollama pull llama3.2
docker exec spryker_b2b_marketplace_ollama_1 ollama pull llama3.2
```

The Ollama data is stored in the `./data/tmp/ollama_data` directory, which you should exclude from version control (.gitignore or .dockerignore).
Expand Down Expand Up @@ -306,6 +310,27 @@ The Ollama data is stored in the `./data/tmp/ollama_data` directory, which you s
],
```

{% info_block infoBox "Local override of LLM settings" %}

To set up your local development settings and override the API key of your chosen provider:

Copy your provider's configuration into a git-ignored local configuration file, such as `config/Shared/config_local.php`, and define your modifications.

Example:

```php
'gemini-config' => [
'provider_name' => AiFoundationConstants::PROVIDER_GEMINI,
'provider_config' => [
'key' => 'my-secret-key', // required
'model' => 'gemini-2.0-flash', // required
'parameters' => [], // optional
],
],
```

{% endinfo_block %}

## Use the AiFoundation client

### Basic usage
Expand Down