Skip to content
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.

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

docs: update the LLM / Embedding models for Gitee AI #551

Merged
merged 2 commits into from
Dec 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion backend/app/rag/embed_model_option.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class EmbeddingModelOption(BaseModel):
provider_description="Gitee AI is a third-party model provider that offers ready-to-use cutting-edge model APIs for AI developers.",
provider_url="https://ai.gitee.com",
default_embedding_model="bge-large-zh-v1.5",
embedding_model_description=f"Find more information about Gitee AI Embeddings at https://ai.gitee.com/docs/openapi/v1#tag/serverless/POST/embeddings",
embedding_model_description=f"Find more information about Gitee AI Embeddings at https://ai.gitee.com/docs/openapi/v1#tag/%E7%89%B9%E5%BE%81%E6%8A%BD%E5%8F%96/POST/embeddings",
credentials_display_name="Gitee AI API Key",
credentials_description="The API key of Gitee AI, you can find it in https://ai.gitee.com/dashboard/settings/tokens",
credentials_type="str",
Expand Down
14 changes: 14 additions & 0 deletions frontend/app/src/pages/docs/embedding-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,20 @@ To use Ollama, you'll need to configure the API base URL in the **Advanced Setti

For more information, see the [Ollama embedding models documentation](https://ollama.com/blog/embedding-models).

### Gitee AI

Gitee AI is a third-party model provider that offers ready-to-use cutting-edge model APIs for AI developers.

**Supported Models**:

| Embedding Model | Vector Dimensions | Max Tokens |
| ------------------- | ----------------- | ---------- |
| `bge-m3` | 1024 | 8192 |
| `bge-large-zh-v1.5` | 1024 | 512 |
| `bge-small-zh-v1.5` | 512 | 512 |

For more information, see the [Gitee AI embedding models documentation](https://ai.gitee.com/docs/openapi/v1#tag/%E7%89%B9%E5%BE%81%E6%8A%BD%E5%8F%96/POST/embeddings).

### Local Embedding Server

Autoflow's local embedding server is a self-hosted embedding service built upon [sentence-transformers](https://www.sentence-transformers.org/) and deployed on your own infrastructure.
Expand Down
1 change: 1 addition & 0 deletions frontend/app/src/pages/docs/llm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Currently Autoflow supports the following LLM providers:
- [Google Gemini](https://gemini.google.com/)
- [Anthropic Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/partner-models/use-claude)
- [Amazon Bedrock](https://aws.amazon.com/bedrock/)
- [Gitee AI](https://ai.gitee.com/serverless-api)
- And all OpenAI-Like models:
- [OpenRouter](https://openrouter.ai/)
- Default config:
Expand Down
Loading