Skip to content

Document remote embedding API configuration#73

Open
cbcoutinho wants to merge 1 commit intogramps-project:mainfrom
cbcoutinho:feature/remote-embedding-docs
Open

Document remote embedding API configuration#73
cbcoutinho wants to merge 1 commit intogramps-project:mainfrom
cbcoutinho:feature/remote-embedding-docs

Conversation

@cbcoutinho
Copy link
Copy Markdown

Summary

  • Add VECTOR_EMBEDDING_BASE_URL and VECTOR_EMBEDDING_API_KEY to the AI features configuration table in install_setup/configuration.md
  • Add a new "Using a remote embedding API" section to install_setup/chat.md with:
    • Overview of the feature and when to use it
    • Docker Compose example for Ollama embeddings
    • Example for OpenAI embeddings
    • Notes about memory savings and reindexing requirements

Companion to gramps-project/gramps-web-api#776.

Test plan

  • Verify configuration table renders correctly in install_setup/configuration.md
  • Verify new section in install_setup/chat.md flows between existing sections
  • Verify cross-link from configuration page to chat page works

This PR was generated with the help of AI, and reviewed by a Human

Add VECTOR_EMBEDDING_BASE_URL and VECTOR_EMBEDDING_API_KEY to the
configuration reference, and add a new "Using a remote embedding API"
section to the AI chat setup guide with Ollama and OpenAI examples.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant