docs: restructure LLM model configs API documentation for nested config object

Update API documentation to reflect new nested `config` object structure in LLM model configurations endpoints. The response format now encapsulates provider-specific fields (provider, base_url, model, temperature, api_key, max_tokens) within a `config` object, while moving ownership metadata (user_id, group_id, is_default, version, created_at, updated_at) to the top level. This aligns the user-facing endpoints with the group configuration structure and improves API consistency.
This commit is contained in:
YueGuobin 2026-03-03 22:47:36 +08:00
parent 176b39145b
commit f4723cd083
3 changed files with 80 additions and 46 deletions

View File

@ -192,15 +192,15 @@ The `model_type` field accepts the following values:
| `config_id` | UUID | Configuration ID | | `config_id` | UUID | Configuration ID |
| `name` | string | Configuration name | | `name` | string | Configuration name |
| `model_type` | string | Model type | | `model_type` | string | Model type |
| `config` | LLMModelConfigData | Configuration data (provider, base_url, model, temperature, etc.) |
| `user_id` | UUID (nullable) | Owner user ID |
| `group_id` | UUID (nullable) | Owner group ID |
| `is_default` | boolean | Default flag |
| `version` | integer | Optimistic locking version |
| `created_at` | TIMESTAMP | Creation time |
| `updated_at` | TIMESTAMP | Last update time |
| `source` | string | Source: "user" or "group" | | `source` | string | Source: "user" or "group" |
| `group_name` | string (nullable) | Group name if source is "group" | | `group_name` | string (nullable) | Group name if source is "group" |
| `is_default` | boolean | Default flag |
| `provider` | string | LLM provider |
| `base_url` | string | API base URL |
| `model` | string | Model name |
| `temperature` | float | Temperature |
| `api_key` | string (nullable) | API key |
| `max_tokens` | integer (nullable) | Max tokens |
--- ---
@ -279,37 +279,55 @@ curl -X GET http://localhost:3080/v3/access/users/{user_id}/llm-model-configs \
"config_id": "uuid-1", "config_id": "uuid-1",
"name": "GPT-4", "name": "GPT-4",
"model_type": "text", "model_type": "text",
"source": "user", "config": {
"group_name": null, "provider": "openai",
"base_url": "https://api.openai.com/v1",
"model": "gpt-4",
"temperature": 0.7,
"api_key": "sk-xxx"
},
"user_id": "uuid-user",
"group_id": null,
"is_default": true, "is_default": true,
"provider": "openai", "version": 0,
"model": "gpt-4", "created_at": "2026-03-03T14:32:48.158880Z",
"base_url": "https://api.openai.com/v1", "updated_at": "2026-03-03T14:32:48.158880Z",
"temperature": 0.7, "source": "user",
"api_key": "sk-xxx" "group_name": null
}, },
{ {
"config_id": "uuid-2", "config_id": "uuid-2",
"name": "Claude-3", "name": "Claude-3",
"model_type": "text", "model_type": "text",
"source": "group", "config": {
"group_name": "Developers", "provider": "anthropic",
"base_url": "https://api.anthropic.com",
"model": "claude-3-opus-20240229",
"temperature": 0.7,
"api_key": null
},
"user_id": null,
"group_id": "uuid-group",
"is_default": true, "is_default": true,
"provider": "anthropic", "version": 0,
"model": "claude-3-opus-20240229", "created_at": "2026-03-03T14:32:48.158880Z",
"base_url": "https://api.anthropic.com", "updated_at": "2026-03-03T14:32:48.158880Z",
"temperature": 0.7, "source": "group",
"api_key": null "group_name": "Developers"
} }
], ],
"default_config": { "default_config": {
"config_id": "uuid-1", "config_id": "uuid-1",
"name": "GPT-4", "name": "GPT-4",
"model_type": "text", "model_type": "text",
"source": "user", "config": {
"group_name": null, "provider": "openai",
...
},
"user_id": "uuid-user",
"group_id": null,
"is_default": true, "is_default": true,
"provider": "openai", "version": 0,
... ...
}, },
"total": 2 "total": 2
@ -317,10 +335,11 @@ curl -X GET http://localhost:3080/v3/access/users/{user_id}/llm-model-configs \
``` ```
**Note:** **Note:**
- User's own config shows `api_key: "sk-xxx"` (visible to owner) - User's own config shows `config.api_key: "sk-xxx"` (visible to owner)
- Inherited group config shows `api_key: null` (hidden from users) - Inherited group config shows `config.api_key: null` (hidden from users)
- `source: "user"` indicates the config belongs to the user - `source: "user"` indicates the config belongs to the user
- `source: "group"` indicates the config is inherited from a group - `source: "group"` indicates the config is inherited from a group
- Configuration fields are nested in the `config` object (same structure as group endpoints)
### 4. Get group configurations ### 4. Get group configurations
@ -598,13 +617,19 @@ The API implements strict API key visibility controls to protect sensitive crede
"configs": [ "configs": [
{ {
"config_id": "uuid-1", "config_id": "uuid-1",
"name": "GPT-4",
"source": "user", "source": "user",
"api_key": "sk-xxx" // Visible (own config) "config": {
"api_key": "sk-xxx" // Visible (own config)
}
}, },
{ {
"config_id": "uuid-2", "config_id": "uuid-2",
"name": "Claude-3",
"source": "group", "source": "group",
"api_key": null // Hidden (inherited from group) "config": {
"api_key": null // Hidden (inherited from group)
}
} }
] ]
} }
@ -614,8 +639,11 @@ The API implements strict API key visibility controls to protect sensitive crede
"configs": [ "configs": [
{ {
"config_id": "uuid-1", "config_id": "uuid-1",
"name": "GPT-4",
"source": "user", "source": "user",
"api_key": null // Hidden (another user's config) "config": {
"api_key": null // Hidden (another user's config)
}
} }
] ]
} }

View File

@ -465,10 +465,15 @@ class LLMModelConfigsRepository(BaseRepository):
"config_id": config.config_id, "config_id": config.config_id,
"name": config.name, "name": config.name,
"model_type": config.model_type, "model_type": config.model_type,
"source": "user", "config": config_dict,
"group_name": None, "user_id": config.user_id,
"group_id": config.group_id,
"is_default": config.is_default, "is_default": config.is_default,
**config_dict "version": config.version,
"created_at": config.created_at,
"updated_at": config.updated_at,
"source": "user",
"group_name": None
}) })
if config.is_default and default_config is None: if config.is_default and default_config is None:
@ -487,10 +492,15 @@ class LLMModelConfigsRepository(BaseRepository):
"config_id": config.config_id, "config_id": config.config_id,
"name": config.name, "name": config.name,
"model_type": config.model_type, "model_type": config.model_type,
"source": "group", "config": config_dict,
"group_name": group_names_map[group_id], "user_id": config.user_id,
"group_id": config.group_id,
"is_default": config.is_default, "is_default": config.is_default,
**config_dict "version": config.version,
"created_at": config.created_at,
"updated_at": config.updated_at,
"source": "group",
"group_name": group_names_map[group_id]
}) })
if config.is_default and default_config is None: if config.is_default and default_config is None:

View File

@ -99,25 +99,21 @@ class LLMModelConfigResponse(DateTimeModelMixin):
model_config = ConfigDict(from_attributes=True) model_config = ConfigDict(from_attributes=True)
class LLMModelConfigWithSource(BaseModel): class LLMModelConfigWithSource(DateTimeModelMixin):
"""Model configuration with source information (for inheritance).""" """Model configuration with source information (for inheritance)."""
config_id: UUID config_id: UUID
name: str name: str
model_type: ModelType model_type: ModelType
config: LLMModelConfigData
user_id: Optional[UUID] = None
group_id: Optional[UUID] = None
is_default: bool
version: int
source: str = Field(..., description="Source: 'user' or 'group'") source: str = Field(..., description="Source: 'user' or 'group'")
group_name: Optional[str] = Field(None, description="Group name if source is 'group'") group_name: Optional[str] = Field(None, description="Group name if source is 'group'")
is_default: bool
# Config fields
provider: str
base_url: str
model: str
temperature: float
api_key: Optional[str] = None
max_tokens: Optional[int] = None
# Allow extra config fields model_config = ConfigDict(from_attributes=True, extra="allow")
model_config = ConfigDict(extra="allow")
class LLMModelConfigInheritedResponse(BaseModel): class LLMModelConfigInheritedResponse(BaseModel):