Skip to content

DOC-913 | Supported LLM models - #1015

Open
nicos-arango wants to merge 23 commits into
mainfrom
DOC-913
Open

DOC-913 | Supported LLM models#1015
nicos-arango wants to merge 23 commits into
mainfrom
DOC-913

Conversation

@nicos-arango

@nicos-arango nicos-arango commented May 27, 2026

Copy link
Copy Markdown
Contributor

Description

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 4.0:

Summary by CodeRabbit

  • New Features

    • Added a supported models section that shows which LLM and embedding models are available for the suite and for the Importer service.
    • Introduced a clearer model list format with provider groupings and default selections where applicable.
  • Documentation

    • Updated the main suite overview and Importer configuration docs to include the new supported models information.

@arangodb-docs-automation

Copy link
Copy Markdown
Contributor

Deploy Preview Available Via
https://deploy-preview-1015--docs-hugo.netlify.app

@cla-bot cla-bot Bot added the cla-signed label May 27, 2026
@coderabbitai

coderabbitai Bot commented May 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Adds a centralized supported-model catalog, a Hugo shortcode to render it, and documentation updates that surface the supported LLM and embedding models for the suite and importer.

Changes

LLM Model Registry and Documentation System

Layer / File(s) Summary
Model catalog data schema
site/data/llm_models.yaml
Defines the YAML service map, provider groupings, per-model entries, supported services, and optional default selections used by the shortcode.
Model rendering shortcode template
site/themes/arangodb-docs-theme/layouts/shortcodes/llm-models.md
Loads llm_models data, filters by an optional service or the core services set, normalizes type labels, and renders a table with an optional default marker.
Documentation pages and integration
site/content/agentic-ai-suite/_index.md, site/content/agentic-ai-suite/importer/llm-configuration.md
Adds the supported-llm-models front matter entry, replaces suite overview body content with a supported-models section, and adds an importer supported-models subsection that invokes the shortcode.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • arangodb/docs-hugo#993: Updates importer model defaults in the same llm-configuration.md page, which overlaps with the new importer supported-models section.

Suggested reviewers

  • maxkernbach
  • diegomendez40

Poem

A bunny hopped through YAML rows,
Then shortcode bells began to glow.
Supported models lined up neat,
In docs they now do softly greet.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding documentation for supported LLM models.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-913

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
site/themes/arangodb-docs-theme/layouts/shortcodes/llm-models.md (1)

19-19: ⚡ Quick win

Consider extracting complex inline logic into template variables.

Line 19 contains deeply nested conditionals that build the type label, default indicator, and services list all in a single expression. While functional, this reduces readability and makes the template harder to maintain.

♻️ Proposed refactor to improve readability
 {{ range $models -}}
+{{- $typeLabel := .type -}}
+{{- if eq .type "chat" }}{{ $typeLabel = "Chat (LLM)" }}{{ else if eq .type "embedding" }}{{ $typeLabel = "Embedding" }}{{ end -}}
+{{- $isDefault := in (.default_for | default slice) $service -}}
+{{- $serviceNames := slice }}{{ range .services }}{{ $serviceNames = $serviceNames | append (index $svcMap .) }}{{ end -}}
-| `{{ .name }}` | {{ if eq .type "chat" }}Chat (LLM){{ else if eq .type "embedding" }}Embedding{{ else }}{{ .type }}{{ end }} |{{ if $service }}{{ if in (.default_for | default slice) $service }} Yes |{{ else }} |{{ end }}{{ else }} {{ $names := slice }}{{ range .services }}{{ $names = $names | append (index $svcMap .) }}{{ end }}{{ delimit $names ", " }} |{{ end }}
+| `{{ .name }}` | {{ $typeLabel }} |{{ if $service }}{{ if $isDefault }} Yes |{{ else }} |{{ end }}{{ else }} {{ delimit $serviceNames ", " }} |{{ end }}
 {{ end -}}
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@site/themes/arangodb-docs-theme/layouts/shortcodes/llm-models.md` at line 19,
The table row on line 19 is hard to read due to nested inline conditionals;
extract the logic into template variables like $typeLabel (compute from .type
with eq checks), $defaultIndicator (check $service against .default_for using in
or default slice), and $serviceNames (map .services via $svcMap and delimit)
then replace the long inline expression with those variables in the row;
reference the fields .name, .type, .default_for, .services and the map $svcMap
when creating these variables so the table cell simply uses $typeLabel,
$defaultIndicator, and $serviceNames.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@site/data/llm_models.yaml`:
- Around line 32-48: The YAML defines conflicting default_for: [importer] for
both gpt-5.4-nano and mistralai/mistral-nemo, causing ambiguity; fix by removing
the default_for entry from the provider-specific model (remove default_for from
mistralai/mistral-nemo), keep gpt-5.4-nano as the canonical default_for:
[importer], and add a brief inline comment near the OpenRouter/models block
stating that provider URL overrides defaults (OpenAI -> gpt-5.4-nano, OpenRouter
-> mistralai/mistral-nemo) so the behavior is documented until a
conditional-default schema (e.g., default_for with provider) is implemented.
- Around line 19-59: The services map defines graphrag but no model lists
include graphrag, so templates like {{% llm-models "graphrag" %}} return
nothing; either add "graphrag" to the relevant providers' models' services
arrays (e.g., include graphrag in the services for appropriate chat and
embedding models such as gpt-5.4-nano, mistralai/mistral-nemo,
mistral-nemo-instruct, nomic-embed-text-v1) to associate those models with
GraphRAG, or remove the graphrag key from the top-level services section if
GraphRAG is not a selectable service; update llm_models.yaml accordingly so
graphrag is consistently present only where intended.

---

Nitpick comments:
In `@site/themes/arangodb-docs-theme/layouts/shortcodes/llm-models.md`:
- Line 19: The table row on line 19 is hard to read due to nested inline
conditionals; extract the logic into template variables like $typeLabel (compute
from .type with eq checks), $defaultIndicator (check $service against
.default_for using in or default slice), and $serviceNames (map .services via
$svcMap and delimit) then replace the long inline expression with those
variables in the row; reference the fields .name, .type, .default_for, .services
and the map $svcMap when creating these variables so the table cell simply uses
$typeLabel, $defaultIndicator, and $serviceNames.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d0c4af65-31fd-40bf-962e-e4a3960bf4e5

📥 Commits

Reviewing files that changed from the base of the PR and between 62c0d56 and 8c4898e.

📒 Files selected for processing (4)
  • site/content/agentic-ai-suite/importer/llm-configuration.md
  • site/content/agentic-ai-suite/supported-llm-models.md
  • site/data/llm_models.yaml
  • site/themes/arangodb-docs-theme/layouts/shortcodes/llm-models.md

Comment thread site/data/llm_models.yaml
Comment thread site/data/llm_models.yaml Outdated
@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Actionable comments posted: 0

@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown
Contributor

Actionable comments posted: 0

@nerpaula
nerpaula requested a review from pratham-ara June 22, 2026 12:27
Comment thread site/content/agentic-ai-suite/_index.md Outdated
Comment thread site/content/images/data-science-background.png Outdated
Comment thread site/content/agentic-ai-suite/importer/llm-configuration.md
Comment thread site/content/agentic-ai-suite/importer/llm-configuration.md Outdated
Comment thread site/content/agentic-ai-suite/autograph/llm-configuration.md

@bluepal-satya-lenka bluepal-satya-lenka left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @nicos-arango, for your work. I've left a few comments for your consideration. Please take a look before merging.

Comment thread site/data/llm_models.yaml Outdated
Comment thread site/data/llm_models.yaml Outdated
Comment thread site/data/llm_models.yaml Outdated
Comment thread site/data/llm_models.yaml Outdated
Comment thread site/data/llm_models.yaml Outdated
@pratham-ara

Copy link
Copy Markdown
Contributor

Our recommendation is OpenAI as the provider, with the OpenAI model list. Nothing else should be listed as a provider of its own.

Anthropic, Google Gemini and OpenRouter are not separate providers in any of the three services. They are all custom endpoints that a user sets up themselves, using the OpenAI client with a different chat_api_url / embedding_api_url. We do not officially recommend any of them beyond the OpenAI list above.

@nicos-arango

Copy link
Copy Markdown
Contributor Author

@pratham-ara , thank you for the feedback, I amended the PR

Comment thread site/content/agentic-ai-suite/_index.md Outdated
- `chat_model`: Specific language model to use for text generation and analysis.
- **OpenAI**: Defaults to `gpt-5.4-nano`.
- **OpenRouter**: Defaults to `mistralai/mistral-nemo`.
- **Other OpenAI-compatible APIs**: Defaults to `gpt-5.4-nano`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the OpenRouter default is right, but this line is inaccurate on two counts.

The Retriever code still has the special case: ConfigHelper.get_chat_model returns mistralai/mistral-nemo whenever chat_api_url contains openrouter.ai.

And a custom endpoint is not expected to fall back to an OpenAI model name at all. The Importer already has no default for custom, the caller has to supply chat_model. The Model Defaults list at line 62 carries the same claim.

### {{ .name }}{{ with .api }} ({{ . }}){{ end }}

{{ end -}}
| Model | Type | Default |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This column renders each model's supported services, not its default status, so every row on every page reads "Importer, AutoGraph, Retriever" and the header does not match the content. This is the empty-defaults point from the June review, still open.

The field doc at llm_models.yaml line 27 describes services as "the service ids the model is a recommended default for", but it is the support list.

The actual defaults, gpt-5.4-nano for chat and text-embedding-3-small for embeddings, are not marked anywhere in the table.


A model is listed as supported by the suite only if it works seamlessly across
the Importer, Retriever, and AutoGraph services. Individual services may also
work with additional models — for the full list available to a specific

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Every model in the data file is tagged for all three core services, so the suite table and the three per-service tables render identically. This sentence sends the reader to a copy of the same table.

The Importer page previously listed gpt-5.5, gpt-5.4 and its variants, gpt-5.2, gpt-5.1, gpt-4.1, gpt-4.1-mini, gpt-4o and gpt-4o-mini. Those are gone with nothing replacing them, so the docs now claim a narrower set of supported models than before.

your own environment. For the models served through Triton, see
[Using Triton Inference Server](#using-triton-inference-server).

{{% llm-models "autograph" %}}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Chat payload compatibility section further down this page still says to set chat_model to "for example gpt-5.4-nano, gpt-5.4-mini, gpt-4.1, gpt-4o". gpt-4.1 and gpt-4o are not in the table above, so the page contradicts itself. The Retriever page has the same problem and additionally names gpt-5.4 and gpt-5.1.

@nicos-arango

Copy link
Copy Markdown
Contributor Author

Thanks @pratham-ara , I addressed the comments. Could you please verify these points?

  1. Does openai plus a non-OpenAI URL still work?
  2. Does custom require an API key?
  3. Does AutoGraph's custom have no model default?
  4. Does NL2AQL have custom too?

@pratham-ara

pratham-ara commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

1. No. That is not supposed to work, and we will be fixing it. Use custom.

2. Yes, in all three. The key check runs on the resolved client family, which includes custom. Note that a self-hosted endpoint with no auth still needs a placeholder value.

3. No, AutoGraph does default. Under custom it falls back to gpt-5.4-nano for chat, text-embedding-3-small for embeddings, and https://api.openai.com/v1 for the endpoint.

4. Not sure. @maxkernbach can you confirm whether NL2AQL is getting custom?

@nicos-arango

Copy link
Copy Markdown
Contributor Author

Thanks @pratham-ara , addressed the comments as discussed on the call today

@nerpaula nerpaula added this to the platform 4.1.0 milestone Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants