Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 4 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,11 @@ export default defineConfig({
{ text: '介绍与定位', link: '/guide/loomy/introduction' },
{ text: '快速开始', link: '/guide/loomy/quick-start' },
{ text: '模型与聊天', link: '/guide/loomy/models' },
{ text: 'AI 搭子', link: '/guide/loomy/companions' },
{ text: '工具箱与技能系统', link: '/guide/loomy/toolbox' },
{ text: '定时任务与积分', link: '/guide/loomy/scheduled-tasks' },
{ text: '远程控制', link: '/guide/loomy/remote-control' },
{ text: '办公 CLI 集成', link: '/guide/loomy/office-cli' },
{ text: '典型工作场景', link: '/guide/loomy/scenarios' },
{ text: '常见问题', link: '/guide/loomy/faq' }
]
Expand Down Expand Up @@ -92,9 +94,11 @@ export default defineConfig({
{ text: 'Introduction', link: '/en/guide/loomy/introduction' },
{ text: 'Quick Start', link: '/en/guide/loomy/quick-start' },
{ text: 'Models & Chat', link: '/en/guide/loomy/models' },
{ text: 'AI Companions', link: '/en/guide/loomy/companions' },
{ text: 'Toolbox & Skills', link: '/en/guide/loomy/toolbox' },
{ text: 'Scheduled Tasks', link: '/en/guide/loomy/scheduled-tasks' },
{ text: 'Remote Control', link: '/en/guide/loomy/remote-control' },
{ text: 'Office CLI', link: '/en/guide/loomy/office-cli' },
{ text: 'Scenarios', link: '/en/guide/loomy/scenarios' },
{ text: 'FAQ', link: '/en/guide/loomy/faq' }
]
Expand Down
99 changes: 99 additions & 0 deletions docs/en/guide/loomy/companions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# AI Companions

Loomy's AI companions are not cold, mechanical tools, but digital partners with personality, an understanding of your tasks, and the ability to push work forward alongside you. A companion can help you break down tasks, organize your thoughts, and spark ideas, and gradually gets familiar with your rhythm through repeated collaboration to become a teammate who understands you better.

In terms of experience, switching companions means switching collaboration styles. Different companions have different names, avatars, personas, tones, and working preferences, but the tools they can call, their memory, and their basic task abilities remain the same. You can think of a companion as a different collaborative personality on the same set of Loomy capabilities.

![Your AI companion team has assembled](/loomy/companions/companion-team-hero.png)

## The Default Companion, Loomy
On first use, Loomy selects the official companion "Loomy" by default. Its style is warm, careful, and conscientious, suitable for daily office work, information organization, document processing, and task progression.

![Default Loomy companion selection](/loomy/companions/default-loomy.png)

You can ask directly in the input box, for example:

> Who are you?

Loomy will reply in its own identity and style.

![Asking Loomy's identity](/loomy/companions/ask-loomy-who.png)

## Switch or Create Companions
At the bottom of the chat box, hover over the current companion's avatar and click to expand the companion menu. Here you can switch between existing companions, or click "Create My Companion" to start creating a new one.

![Open companion dropdown menu](/loomy/companions/companion-dropdown.png)

After clicking "Create My Companion", Loomy starts a new task and shows the companion selection page. Two template companions are provided by default:

* **Xiaolin**: A calm and rational efficiency driver, suitable for task breakdown, plan evaluation, code debugging, and other scenarios that need priorities and structured results.
* **Xiaonuan**: A sunny and energetic creative partner, suitable for brainstorming, content creation, emotional companionship, and relaxed collaboration.

You can also choose "Custom" to create your own dedicated companion.

![Companion selection page](/loomy/companions/companion-selection.png)

## Using Template Companions
After selecting a template companion, Loomy displays its default persona. Take "Xiaolin" as an example: it is positioned as a calm and rational efficiency driver, with more direct expression and more structured output.

![Xiaolin template preview](/loomy/companions/template-lin-preview.png)

After confirming, reply "Save" to create it successfully. Once created, you can see the new companion in the companion menu of the input box and switch to it to continue the conversation.

After switching to Xiaolin, the reply style changes noticeably: more calm, rational, and results-oriented, with no small talk and no cuteness, better suited for breaking tasks into steps and pushing them forward.

![Conversation after switching to Xiaolin](/loomy/companions/chat-with-lin.png)

## Creating a Custom Companion
If you want a companion that better matches your preferences, click the "Custom" card on the companion selection page.

![Click to customize a companion](/loomy/companions/custom-card.png)

You can then tell Loomy directly what kind of companion you want to create, including the name, character temperament, positioning, speaking style, applicable scenarios, and more. For example:

> Help me create a Li Bai companion modeled after the ancient poet Li Bai.

Loomy will first help you sort out the companion's settings through conversation, and can also search for relevant character traits based on your requirements to generate a more complete persona.

![Creating a Li Bai companion through conversation](/loomy/companions/create-li-bai.png)

Once the persona is confirmed, Loomy generates a dedicated avatar for it. When there is nothing left to adjust, click or reply "Save" to create it successfully.

![Li Bai companion's dedicated avatar](/loomy/companions/li-bai-avatar.png)

After creation, switch to this companion to continue chatting, and it will collaborate with you according to the corresponding persona. For example, you can ask:

> Who are you? What's the weather like in Hefei today?

The companion keeps its own expressive style while still being able to call tools such as weather and web search to complete tasks.

![Chatting with the Li Bai companion and checking the weather](/loomy/companions/chat-with-li-bai-weather.png)

## View and Adjust Companions
In the companion dropdown menu of the input box, click the edit icon to the right of a companion to view its profile.

![Click the companion editing entry](/loomy/companions/edit-companion-entry.png)

The companion profile shows its name, positioning, avatar, persona, language style, and applicable scenarios. Here you can delete the companion or continue adjusting its settings.

If you want to keep modifying it, click "Adjust Partner Settings" in the lower right corner. Loomy starts a new task, and you can continue adjusting the companion's avatar, persona, tone, positioning, or applicable scenarios through conversation.

![Companion profile details](/loomy/companions/companion-profile.png)

> **Note**: The companion currently in use in the chat box cannot be deleted or adjusted, and the corresponding buttons are grayed out. Loomy's official built-in companions also cannot be modified or deleted.

## Select a Companion from a New Task
In addition to switching companions at the bottom of the chat box, you can also quickly select a companion from the "New Task" entry.

Hover over the "New Task" button on the left, and an expand arrow appears on the right. After expanding, you can directly select the companion you want to work with and start a new task with it.

![Select a companion from the new task entry](/loomy/companions/new-task-companion.png)

## Usage Suggestions
You can have multiple companions, letting companions of different personalities accompany you on different tasks:

* For steadier task progression, choose Loomy or Xiaolin.
* For more relaxed inspiration and companionship, choose Xiaonuan.
* For a specific character temperament, create a custom companion, such as a Zhang Fei type, Li Bai type, project manager type, editor type, or study companion.

Start by choosing one companion to work with, and create the one that understands you best whenever you like.
107 changes: 91 additions & 16 deletions docs/en/guide/loomy/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,89 @@ In the "Default Model Configuration" area, you can see the currently used model.

After the selection is complete, click the "Save" button, and then return to the homepage to use the newly selected model for conversations and task execution.

## Add Custom Providers
If you want to use other AI service providers or use your own deployed model services, you can add custom providers:
## Configure Custom Models
If you have your own model service provider, you can configure any provider compatible with the **OpenAI protocol** in Loomy. The following uses "Zhipu" as an example to walk through the full configuration process.

1. In the "AI Providers" area, click the "+ Add Custom Provider" button in the upper right corner
2. Fill in the relevant configuration information of the provider:
* API Key
* API Address
* Model Name
* Other necessary parameters
3. Click "Configure" or "Save" to complete the addition
### 1. Access Service Provider Configuration
1. Go to **"Settings" → "Models"** in the left sidebar.
2. Switch to the **"Service Provider Configuration"** tab.

After the addition is successful, the custom provider will appear in the provider list, and you can switch to use it in the model selector.
Here you can configure the built-in default providers (DeepSeek, Doubao, Qwen, Zhipu, etc.), or click **"+ Add Custom Service Provider"** in the upper right corner to add any provider compatible with the OpenAI protocol.

## Configure Existing Providers
For providers whose status is shown as "Disabled" in the list (such as OpenAI, Google Gemini, iFLYTEK Spark, Kimi, etc.), you need to configure them first before you can use them:
![Service Provider Configuration Page](/loomy/custom-models/cm-1.png)

1. Click the "Configure" button on the right side of the corresponding provider card
2. Fill in the API Key and other configuration information required by the provider
3. After saving the configuration, the provider's status will change to "Enabled"
4. Then you can select the provider's model in the model selector
### 2. Configure a Service Provider (Example: Zhipu)
**2.1 Enter the API Key**

1. Locate the provider card (such as "Zhipu") and click **"Configure"**.
2. Get your API Key from the [Zhipu Open Platform](https://open.bigmodel.cn/).
3. Paste the key into the input field.

![Configuring Zhipu Service Provider](/loomy/custom-models/cm-1.5.png)

**2.2 Fetch Available Models**

* **Auto-fetch**: Click **"Fetch from API"** in the "Available Models" section. The list will be populated automatically (such as `glm-4.6`, `cogview-4`).
* **Manual add**: If the provider does not support auto-fetch, add the model ID manually.

![Fetching Available Models](/loomy/custom-models/cm-2.png)

![Fetching Available Models](/loomy/custom-models/cm-2.5.png)

**2.3 Configure the Model Card**

Click a specific model to open its configuration card. Key settings include:

* **Input/Output Modalities:**
* **Multimodal models**: Check the relevant input modalities (`text`, `image`, `audio`) to make full use of capabilities.
* **Image generation models**: You must check the **output modality** as `image` (such as Zhipu's `cogview` series).
* **Token Limits:**
* **Context window**: The maximum supported context length.
* **Max output tokens**: The maximum tokens for a single generation.
* ⚠️ **Constraint**: If a context window is configured, **max output tokens is required**.

![Configure the Model Card](/loomy/custom-models/cm-2.6.png)

> **Best Practice**: Fully configuring modalities and token limits gives Loomy an accurate capability profile, resulting in more stable conversations and task outputs.

**2.4 Save and Apply**

Click **"Save and Apply"** at the bottom of the page to activate the current provider's configuration.

### 3. Enable Custom Models
Switch from Loomy's default models to your custom configuration:

1. Go to the **"Model Configuration"** tab.
2. Toggle **"Enable Custom Models"** to **ON**.
3. Select your configured model from the selector (such as `glm-4.6`).
4. Click **"Save"**.

![Enabling Custom Models](/loomy/custom-models/cm-4.png)

![Selecting a Custom Model](/loomy/custom-models/cm-5.png)

### 4. Configure the Default Image Generation Model
To allow the `Loomy_image` tool to use your custom provider for image generation:

1. In the **"Model Configuration"** tab, find **"Default Image Generation Model"**.
2. Select a configured model from the dropdown (ensure its **output modality** is set to `image`).
3. Click **"Save"**.

![Configure the Default Image Generation Model](/loomy/custom-models/cm-3.png)

When you trigger the tool with a prompt such as *"Generate a photo of a cute kitten sitting on a sunny windowsill, with blue sky and white clouds in the background"*, your specified model will be used.

![Image Generation Result](/loomy/custom-models/cm-6.png)

> **Troubleshooting**: If the model does not appear in the dropdown, verify that the **output modality** is set to `image` in the service provider configuration.

### 5. Verification
Perform these checks in the chat interface to confirm a successful configuration:

* **Chat model**: Ask *"Who are you? Which company developed you?"* to verify it returns the Zhipu GLM identity.
* **Image model**: Send an image generation prompt (such as *"Draw a Shiba Inu skateboarding on the moon"*) and verify that the `Loomy_image` tool returns an image.

![Verify Custom Models](/loomy/custom-models/cm-7.png)

## Data Security Instructions
**Local Storage**: All API Keys, configuration information, and model settings are saved on your local device. Loomy will not upload or obtain this sensitive information. You can configure and use various AI services with confidence.
Expand All @@ -60,6 +123,18 @@ No. After switching models and saving, return to the homepage to use the new mod
### Can I configure multiple providers at the same time?
Yes. You can configure multiple AI providers and switch between different models at any time when needed.

### What if "Fetch from API" fails?
* Verify that the API Key is correct and valid.
* Make sure you can access the provider's API domain.
* If the provider has no model-list endpoint, add the model ID manually.

### What if I set a context window but forgot to set max output tokens?
The system will block saving and prompt you to fill in the missing field. Refer to the `max_tokens` limit in the provider's official documentation.

### Why does the image generation model produce no image output?
* Make sure the **output modality** is checked as `image` in the model card.
* Make sure the model is selected as the **Default Image Generation Model** in "Model Configuration".

---

## Chat Function
Expand Down
Loading