-
Notifications
You must be signed in to change notification settings - Fork 670
Expand file tree
/
Copy pathmodel.py
More file actions
1035 lines (821 loc) · 39.3 KB
/
Copy pathmodel.py
File metadata and controls
1035 lines (821 loc) · 39.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
from enum import Enum
from typing import Optional, Any, List, Dict
from pydantic import BaseModel, Field, EmailStr, ConfigDict
from nexent.core.agents.agent_model import ToolConfig
from consts.prompt_template import PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP
class ModelConnectStatusEnum(Enum):
"""Enum class for model connection status"""
NOT_DETECTED = "not_detected"
DETECTING = "detecting"
AVAILABLE = "available"
UNAVAILABLE = "unavailable"
@classmethod
def get_default(cls) -> str:
"""Get default value"""
return cls.NOT_DETECTED.value
@classmethod
def get_value(cls, status: Optional[str]) -> str:
"""Get value based on status, return default value if empty"""
if not status or status == "":
return cls.NOT_DETECTED.value
return status
# User authentication related request models
class UserSignUpRequest(BaseModel):
"""User registration request model"""
email: EmailStr
password: str = Field(..., min_length=6)
invite_code: Optional[str] = None
auto_login: Optional[bool] = True # Whether to return session after signup
class UserSignInRequest(BaseModel):
"""User login request model"""
email: EmailStr
password: str
class UserUpdateRequest(BaseModel):
"""User update request model"""
username: Optional[str] = Field(None, min_length=1, max_length=50)
email: Optional[EmailStr] = None
role: Optional[str] = Field(None, pattern="^(SUPER_ADMIN|ADMIN|DEV|USER)$")
class UserDeleteRequest(BaseModel):
"""User delete request model"""
new_owner_id: Optional[str] = None
class OAuthProviderDefinition(BaseModel):
name: str
display_name: str
icon: str
authorize_url: str
authorize_method: str = "GET"
authorize_params: Dict[str, str] = {}
authorize_fragment: str = ""
authorize_param_map: Dict[str, str] = {
"client_id": "client_id",
"redirect_uri": "redirect_uri",
"scope": "scope",
"state": "state",
}
encode_redirect_uri: bool = False
token_url: str
token_method: str = "POST"
token_params_map: Dict[str, str] = {
"client_id": "client_id",
"client_secret": "client_secret",
"code": "code",
"grant_type": "grant_type",
}
token_extra_params: Dict[str, str] = {}
token_error_key: Optional[str] = None
token_error_message_key: Optional[str] = None
token_response_id_key: Optional[str] = None
userinfo_url: str
userinfo_auth_scheme: str = "Bearer"
userinfo_params: Dict[str, str] = {}
userinfo_field_map: Dict[str, str] = {
"id": "id",
"email": "email",
"username": "login",
}
userinfo_needs_email_fetch: bool = False
userinfo_email_url: Optional[str] = None
client_id_env: str
client_secret_env: str
enabled_check: Optional[str] = None
# Response models for model management
class ModelResponse(BaseModel):
code: int = 200
message: str = ""
data: Any
class ModelRequest(BaseModel):
model_factory: Optional[str] = 'OpenAI-API-Compatible'
model_name: str
model_type: str
api_key: Optional[str] = ''
base_url: Optional[str] = ''
max_tokens: Optional[int] = 0
used_token: Optional[int] = 0
display_name: Optional[str] = ''
connect_status: Optional[str] = ''
expected_chunk_size: Optional[int] = None
maximum_chunk_size: Optional[int] = None
chunk_batch: Optional[int] = None
# STT specific fields
model_appid: Optional[str] = None
access_token: Optional[str] = None
timeout_seconds: Optional[int] = None
concurrency_limit: Optional[int] = None
class ProviderModelRequest(BaseModel):
provider: str
model_type: str
api_key: Optional[str] = ''
base_url: Optional[str] = ''
class BatchCreateModelsRequest(BaseModel):
api_key: str
models: List[Dict]
provider: str
type: str
# Configuration models
class ModelApiConfig(BaseModel):
apiKey: str
modelUrl: str
class SingleModelConfig(BaseModel):
modelName: str
displayName: str
apiConfig: Optional[ModelApiConfig] = None
dimension: Optional[int] = None
class STTModelConfig(BaseModel):
"""STT model specific configuration with factory, appid, and access token fields"""
modelName: str
displayName: str
apiConfig: Optional[ModelApiConfig] = None
modelFactory: Optional[str] = None
modelAppid: Optional[str] = None
accessToken: Optional[str] = None
class ModelConfig(BaseModel):
llm: SingleModelConfig
embedding: SingleModelConfig
multiEmbedding: SingleModelConfig
rerank: SingleModelConfig
vlm: SingleModelConfig
stt: STTModelConfig
class AppConfig(BaseModel):
appName: str
appDescription: str
iconType: str
iconKey: Optional[str] = "search"
customIconUrl: Optional[str] = None
avatarUri: Optional[str] = None
modelEngineEnabled: bool = False
datamateUrl: Optional[str] = None
class GlobalConfig(BaseModel):
app: AppConfig
models: ModelConfig
# Request models
class HistoryItem(BaseModel):
role: str
content: str
minio_files: Optional[List[Dict[str, Any]]] = None
class AgentRequest(BaseModel):
query: str
conversation_id: Optional[int] = None
history: Optional[List[HistoryItem]] = None
# Complete list of attachment information
minio_files: Optional[List[Dict[str, Any]]] = None
agent_id: Optional[int] = None
model_id: Optional[int] = None
version_no: Optional[int] = None
is_debug: Optional[bool] = False
class MessageUnit(BaseModel):
type: str
content: str
class MessageRequest(BaseModel):
conversation_id: int # Modified to integer type to match database auto-increment ID
message_idx: int # Modified to integer type
role: str
message: List[MessageUnit]
# Complete list of attachment information
minio_files: Optional[List[Dict[str, Any]]] = None
class ConversationRequest(BaseModel):
title: str = "新对话"
class ConversationResponse(BaseModel):
code: int = 0 # Modified default value to 0
message: str = "success"
data: Any
class RenameRequest(BaseModel):
conversation_id: int
name: str
# Pydantic models for API
class TaskRequest(BaseModel):
source: str
source_type: str
chunking_strategy: Optional[str] = None
index_name: Optional[str] = None
original_filename: Optional[str] = None
embedding_model_id: Optional[int] = None
tenant_id: Optional[str] = None
additional_params: Dict[str, Any] = Field(default_factory=dict)
class BatchTaskRequest(BaseModel):
sources: List[Dict[str, Any]
] = Field(..., description="List of source objects to process")
class IndexingResponse(BaseModel):
success: bool
message: str
total_indexed: int
total_submitted: int
class ChunkCreateRequest(BaseModel):
"""Request payload for manual chunk creation."""
content: str = Field(..., min_length=1, description="Chunk content")
title: Optional[str] = Field(None, description="Optional chunk title")
filename: Optional[str] = Field(None, description="Associated file name")
path_or_url: Optional[str] = Field(None, description="Source path or URL")
chunk_id: Optional[str] = Field(
None, description="Explicit chunk identifier")
metadata: Dict[str, Any] = Field(
default_factory=dict, description="Additional chunk metadata")
class ChunkUpdateRequest(BaseModel):
"""Request payload for chunk updates."""
content: Optional[str] = Field(None, description="Updated chunk content")
title: Optional[str] = Field(None, description="Updated chunk title")
filename: Optional[str] = Field(None, description="Updated file name")
path_or_url: Optional[str] = Field(
None, description="Updated source path or URL")
metadata: Dict[str, Any] = Field(
default_factory=dict, description="Additional metadata updates")
class HybridSearchRequest(BaseModel):
"""Request payload for hybrid knowledge-base searches."""
query: str = Field(..., min_length=1,
description="Search query text")
index_names: List[str] = Field(..., min_items=1,
description="List of index names to search")
top_k: int = Field(10, ge=1, le=100,
description="Number of results to return")
weight_accurate: float = Field(0.5, ge=0.0, le=1.0,
description="Weight applied to accurate search scores")
# Request models
class ProcessParams(BaseModel):
chunking_strategy: Optional[str] = "basic"
source_type: str
index_name: str
authorization: Optional[str] = None
class OpinionRequest(BaseModel):
message_id: int
opinion: Optional[str] = None
# used in prompt/generate request
class GeneratePromptRequest(BaseModel):
task_description: str
agent_id: int
model_id: int
prompt_template_id: Optional[int] = None
tool_ids: Optional[List[int]] = Field(
None, description="Optional: tool IDs from frontend (takes precedence over database query)")
sub_agent_ids: Optional[List[int]] = Field(
None, description="Optional: sub-agent IDs from frontend (takes precedence over database query)")
knowledge_base_display_names: Optional[List[str]] = Field(
None, description="Optional: knowledge base display names from frontend (takes precedence over database query)")
class PromptTemplateContentRequest(BaseModel):
model_config = ConfigDict(populate_by_name=True)
duty_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["duty_system_prompt"]
)
constraint_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["constraint_system_prompt"]
)
few_shots_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["few_shots_system_prompt"]
)
agent_variable_name_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_variable_name_system_prompt"]
)
agent_display_name_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_display_name_system_prompt"]
)
agent_description_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_description_system_prompt"]
)
user_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["user_prompt"]
)
agent_name_regenerate_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_name_regenerate_system_prompt"]
)
agent_name_regenerate_user_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_name_regenerate_user_prompt"]
)
agent_display_name_regenerate_system_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_display_name_regenerate_system_prompt"]
)
agent_display_name_regenerate_user_prompt: str = Field(
alias=PROMPT_GENERATE_TEMPLATE_FIELD_ALIAS_MAP["agent_display_name_regenerate_user_prompt"]
)
class PromptTemplateRequest(BaseModel):
template_name: str
description: Optional[str] = None
template_type: str = "agent_generate"
template_content_zh: PromptTemplateContentRequest
template_content_en: Optional[PromptTemplateContentRequest] = None
class OptimizePromptSectionRequest(BaseModel):
task_description: str
agent_id: int
model_id: int
section_type: str
section_title: str
current_content: str
feedback: str
tool_ids: Optional[List[int]] = Field(
None, description="Optional: tool IDs from frontend (takes precedence over database query)")
sub_agent_ids: Optional[List[int]] = Field(
None, description="Optional: sub-agent IDs from frontend (takes precedence over database query)")
knowledge_base_display_names: Optional[List[str]] = Field(
None, description="Optional: knowledge base display names from frontend (takes precedence over database query)")
class GenerateTitleRequest(BaseModel):
conversation_id: int
question: str
# used in agent/search agent/update for save agent info
class AgentInfoRequest(BaseModel):
agent_id: Optional[int] = None
name: Optional[str] = None
display_name: Optional[str] = None
description: Optional[str] = None
business_description: Optional[str] = None
author: Optional[str] = None
model_name: Optional[str] = None
model_id: Optional[int] = None
max_steps: Optional[int] = None
provide_run_summary: Optional[bool] = None
duty_prompt: Optional[str] = None
constraint_prompt: Optional[str] = None
few_shots_prompt: Optional[str] = None
enabled: Optional[bool] = None
business_logic_model_name: Optional[str] = None
business_logic_model_id: Optional[int] = None
prompt_template_id: Optional[int] = None
prompt_template_name: Optional[str] = None
enabled_tool_ids: Optional[List[int]] = None
enabled_skill_ids: Optional[List[int]] = None
related_agent_ids: Optional[List[int]] = None
related_external_agent_ids: Optional[List[int]] = None
group_ids: Optional[List[int]] = None
ingroup_permission: Optional[str] = None
enable_context_manager: Optional[bool] = None
version_no: int = 0
class AgentIDRequest(BaseModel):
agent_id: int
class ToolInstanceInfoRequest(BaseModel):
tool_id: int
agent_id: int
params: Dict[str, Any]
enabled: bool
version_no: int = 0
class SkillInstanceInfoRequest(BaseModel):
"""Request model for skill instance update.
Note: skill_description and skill_content are no longer accepted.
These fields are now retrieved from ag_skill_info_t table.
"""
skill_id: int
agent_id: int
enabled: bool = True
version_no: int = 0
class ToolInstanceSearchRequest(BaseModel):
tool_id: int
agent_id: int
class ToolSourceEnum(Enum):
LOCAL = "local"
MCP = "mcp"
LANGCHAIN = "langchain"
BUILTIN = "builtin"
class ToolInfo(BaseModel):
name: str
description: str
description_zh: Optional[str] = None
params: List
source: str
inputs: str
output_type: str
class_name: str
usage: Optional[str]
origin_name: Optional[str] = None
category: Optional[str] = None
# used in Knowledge Summary request
class ChangeSummaryRequest(BaseModel):
summary_result: str
class MessageIdRequest(BaseModel):
conversation_id: int
message_index: int
class ExportAndImportAgentInfo(BaseModel):
agent_id: int
name: str
display_name: Optional[str] = None
description: str
business_description: str
author: Optional[str] = None
max_steps: int
provide_run_summary: bool
duty_prompt: Optional[str] = None
constraint_prompt: Optional[str] = None
few_shots_prompt: Optional[str] = None
enabled: bool
tools: List[ToolConfig]
managed_agents: List[int]
model_id: Optional[int] = None
model_name: Optional[str] = None
business_logic_model_id: Optional[int] = None
business_logic_model_name: Optional[str] = None
prompt_template_id: Optional[int] = None
prompt_template_name: Optional[str] = None
class Config:
arbitrary_types_allowed = True
class MCPInfo(BaseModel):
mcp_server_name: str
mcp_url: str
class ExportAndImportDataFormat(BaseModel):
agent_id: int
agent_info: Dict[str, ExportAndImportAgentInfo]
mcp_info: List[MCPInfo]
class AgentImportRequest(BaseModel):
agent_info: ExportAndImportDataFormat
force_import: bool = False
class AgentNameBatchRegenerateItem(BaseModel):
name: str
display_name: Optional[str] = None
task_description: Optional[str] = ""
agent_id: Optional[int] = None
class AgentNameBatchRegenerateRequest(BaseModel):
items: List[AgentNameBatchRegenerateItem]
class AgentNameBatchCheckItem(BaseModel):
name: str
display_name: Optional[str] = None
agent_id: Optional[int] = None
class AgentNameBatchCheckRequest(BaseModel):
items: List[AgentNameBatchCheckItem]
class ConvertStateRequest(BaseModel):
"""Request schema for /tasks/convert_state endpoint"""
process_state: str = ""
forward_state: str = ""
# ---------------------------------------------------------------------------
# Memory Feature Data Models (Missing previously)
# ---------------------------------------------------------------------------
class MemoryAgentShareMode(str, Enum):
"""Memory sharing mode for agent-level memory.
always: Agent memories are always shared with others.
ask: Ask user every time whether to share.
never: Never share agent memories.
"""
ALWAYS = "always"
ASK = "ask"
NEVER = "never"
@classmethod
def default(cls) -> "MemoryAgentShareMode":
return cls.NEVER
# Voice Service Data Models
# ---------------------------------------------------------------------------
class VoiceConnectivityRequest(BaseModel):
"""Request model for voice service connectivity check"""
model_type: str = Field(...,
description="Type of model to check ('stt')")
class VoiceConnectivityResponse(BaseModel):
"""Response model for voice service connectivity check"""
connected: bool = Field(...,
description="Whether the service is connected")
model_type: str = Field(..., description="Type of model checked")
message: str = Field(..., description="Status message")
class ToolValidateRequest(BaseModel):
"""Request model for tool validation"""
name: str = Field(..., description="Tool name to validate")
source: str = Field(..., description="Tool source (local, mcp, langchain)")
usage: Optional[str] = Field(None, description="Tool usage information")
inputs: Optional[Dict[str, Any]] = Field(
None, description="Tool inputs")
params: Optional[Dict[str, Any]] = Field(
None, description="Tool configuration parameters")
class MCPServerConfig(BaseModel):
"""Configuration for a single MCP server"""
command: str = Field(..., description="Command to run (e.g., 'npx')")
args: List[str] = Field(default_factory=list,
description="Command arguments")
env: Optional[Dict[str, str]] = Field(
None, description="Environment variables for the MCP server")
port: Optional[int] = Field(
None, description="Host port to expose the MCP server on (e.g., 5020)")
image: Optional[str] = Field(
None,
description="Docker image for the MCP proxy container (optional, overrides MCP_DOCKER_IMAGE)",
)
class MCPConfigRequest(BaseModel):
"""Request model for adding MCP servers from configuration"""
mcpServers: Dict[str, MCPServerConfig] = Field(
..., description="Dictionary of MCP server configurations")
class UpdateKnowledgeListRequest(BaseModel):
"""Request model for updating user's selected knowledge base list grouped by source"""
nexent: Optional[List[str]] = Field(
None, description="List of knowledge base index names from nexent source")
datamate: Optional[List[str]] = Field(
None, description="List of knowledge base index names from datamate source")
class MCPUpdateRequest(BaseModel):
"""Request model for updating an existing MCP server"""
current_service_name: str = Field(...,
description="Current MCP service name")
current_mcp_url: str = Field(..., description="Current MCP server URL")
new_service_name: str = Field(..., description="New MCP service name")
new_mcp_url: str = Field(..., description="New MCP server URL")
new_authorization_token: Optional[str] = Field(
None, description="New authorization token for MCP server authentication (e.g., Bearer token)")
# Tenant Management Data Models
# ---------------------------------------------------------------------------
class TenantCreateRequest(BaseModel):
"""Request model for creating a tenant"""
tenant_name: str = Field(..., min_length=1,
description="Tenant display name")
class TenantUpdateRequest(BaseModel):
"""Request model for updating tenant information"""
tenant_name: str = Field(..., min_length=1,
description="New tenant display name")
# Pagination request model
class PaginationRequest(BaseModel):
"""Request model for pagination parameters"""
page: int = Field(1, ge=1, description="Page number")
page_size: int = Field(20, ge=1, le=100, description="Items per page")
# Group Management Data Models
# ---------------------------------------------------------------------------
class GroupCreateRequest(BaseModel):
"""Request model for creating a group"""
tenant_id: str = Field(..., min_length=1,
description="Tenant ID where the group belongs")
group_name: str = Field(..., min_length=1,
description="Group display name")
group_description: Optional[str] = Field(
None, description="Optional group description")
class GroupUpdateRequest(BaseModel):
"""Request model for updating group information"""
group_name: Optional[str] = Field(None, description="New group name")
group_description: Optional[str] = Field(
None, description="New group description")
class GroupListRequest(BaseModel):
"""Request model for listing groups"""
tenant_id: str = Field(..., description="Tenant ID to filter groups")
page: Optional[int] = Field(
None, ge=1, description="Page number for pagination. If not provided, returns all data")
page_size: Optional[int] = Field(
None, ge=1, le=100, description="Number of items per page. If not provided, returns all data")
sort_by: Optional[str] = Field(
"created_at", description="Field to sort by")
sort_order: Optional[str] = Field(
"desc", description="Sort order (asc or desc)")
class UserListRequest(BaseModel):
"""Request model for listing users"""
tenant_id: str = Field(..., description="Tenant ID to filter users")
page: Optional[int] = Field(
None, ge=1, description="Page number for pagination. If not provided, returns all data")
page_size: Optional[int] = Field(
None, ge=1, le=100, description="Number of items per page. If not provided, returns all data")
sort_by: Optional[str] = Field(
"created_at", description="Field to sort by")
sort_order: Optional[str] = Field(
"desc", description="Sort order (asc or desc)")
class GroupUserRequest(BaseModel):
"""Request model for adding/removing user from group"""
user_id: str = Field(..., min_length=1,
description="User ID to add/remove")
group_ids: Optional[List[int]] = Field(
None, description="List of group IDs (for batch operations)")
class GroupMembersUpdateRequest(BaseModel):
"""Request model for batch updating group members"""
user_ids: List[str] = Field(..., description="List of user IDs to set as group members")
class SetDefaultGroupRequest(BaseModel):
"""Request model for setting tenant's default group"""
default_group_id: int = Field(..., ge=1,
description="Group ID to set as default for the tenant")
# Invitation Management Data Models
# ---------------------------------------------------------------------------
class InvitationCreateRequest(BaseModel):
"""Request model for creating invitation code"""
tenant_id: str = Field(
..., min_length=1, description="Tenant ID where the invitation belongs")
code_type: str = Field(
..., description="Invitation code type (ADMIN_INVITE, DEV_INVITE, USER_INVITE)")
invitation_code: Optional[str] = Field(
None, description="Custom invitation code (auto-generated if not provided)")
group_ids: Optional[List[int]] = Field(
None, description="Associated group IDs")
capacity: int = Field(
default=1, ge=1, description="Maximum usage capacity")
expiry_date: Optional[str] = Field(
None, description="Expiry date in ISO format")
class InvitationUpdateRequest(BaseModel):
"""Request model for updating invitation code"""
capacity: Optional[int] = Field(None, ge=1, description="New capacity")
expiry_date: Optional[str] = Field(None, description="New expiry date")
group_ids: Optional[List[int]] = Field(None, description="New group IDs")
class InvitationResponse(BaseModel):
"""Response model for invitation information"""
invitation_id: int = Field(..., description="Invitation ID")
invitation_code: str = Field(..., description="Invitation code")
code_type: str = Field(..., description="Code type")
group_ids: Optional[List[int]] = Field(
None, description="Associated group IDs")
capacity: int = Field(..., description="Usage capacity")
expiry_date: Optional[str] = Field(None, description="Expiry date")
status: str = Field(..., description="Current status")
created_at: Optional[str] = Field(None, description="Creation timestamp")
updated_at: Optional[str] = Field(
None, description="Last update timestamp")
class InvitationListRequest(BaseModel):
"""Request model for listing invitation codes"""
tenant_id: Optional[str] = Field(
None, description="Tenant ID to filter by (optional)")
page: int = Field(1, ge=1, description="Page number for pagination")
page_size: int = Field(
20, ge=1, le=100, description="Number of items per page")
sort_by: Optional[str] = Field(
None, description="Sort field (create_time, update_time, etc.)")
sort_order: Optional[str] = Field(
None, description="Sort order (asc, desc)")
class InvitationUseResponse(BaseModel):
"""Response model for invitation usage"""
invitation_record_id: int = Field(..., description="Usage record ID")
invitation_code: str = Field(..., description="Used invitation code")
user_id: str = Field(..., description="User who used the code")
invitation_id: int = Field(..., description="Invitation ID")
code_type: str = Field(..., description="Code type")
group_ids: Optional[List[int]] = Field(
None, description="Associated group IDs")
# Manage Tenant Model Data Models
# ---------------------------------------------------------------------------
class ManageTenantModelListRequest(BaseModel):
"""Request model for listing models in a specific tenant (manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to query models for")
model_type: Optional[str] = Field(
None, description="Filter by model type (e.g., 'llm', 'embedding')")
page: int = Field(1, ge=1, description="Page number for pagination")
page_size: int = Field(20, ge=1, le=100, description="Items per page")
class ManageTenantModelListResponse(BaseModel):
"""Response model for tenant model list query"""
tenant_id: str = Field(..., description="Tenant identifier")
tenant_name: str = Field(..., description="Tenant display name")
models: List[Dict[str, Any]] = Field(
default_factory=list, description="List of models for this tenant")
total: int = Field(0, description="Total number of models")
page: int = Field(1, description="Current page number")
page_size: int = Field(20, description="Items per page")
total_pages: int = Field(0, description="Total number of pages")
class ManageTenantModelCreateRequest(BaseModel):
"""Request model for creating a model in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to create model for")
model_repo: Optional[str] = Field('', description="Model repository path")
model_name: str = Field(..., description="Model name")
model_type: str = Field(..., description="Model type (e.g., 'llm', 'embedding', 'vlm', 'stt')")
api_key: Optional[str] = Field('', description="API key for the model")
base_url: Optional[str] = Field('', description="Base URL for the model API")
max_tokens: Optional[int] = Field(0, description="Maximum tokens for the model")
display_name: Optional[str] = Field('', description="Display name for the model")
model_factory: Optional[str] = Field(None, description="Model factory/vendor for the model")
expected_chunk_size: Optional[int] = Field(None, description="Expected chunk size for embedding models")
maximum_chunk_size: Optional[int] = Field(None, description="Maximum chunk size for embedding models")
chunk_batch: Optional[int] = Field(None, description="Batch size for chunking")
# STT specific fields
model_appid: Optional[str] = Field(None, description="Application ID for STT models (e.g., Volcano Engine)")
access_token: Optional[str] = Field(None, description="Access token for STT models (e.g., Volcano Engine)")
timeout_seconds: Optional[int] = Field(None, description="Request timeout in seconds")
concurrency_limit: Optional[int] = Field(None, description="Maximum concurrent requests for this model")
class ManageTenantModelUpdateRequest(BaseModel):
"""Request model for updating a model in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to update model for")
current_display_name: str = Field(..., description="Current display name of the model to update")
model_repo: Optional[str] = Field(None, description="Model repository path")
model_name: Optional[str] = Field(None, description="Model name")
model_type: Optional[str] = Field(None, description="Model type")
api_key: Optional[str] = Field(None, description="API key for the model")
base_url: Optional[str] = Field(None, description="Base URL for the model API")
max_tokens: Optional[int] = Field(None, description="Maximum tokens for the model")
display_name: Optional[str] = Field(None, description="New display name for the model")
model_factory: Optional[str] = Field(None, description="Model factory/vendor for the model")
expected_chunk_size: Optional[int] = Field(None, description="Expected chunk size for embedding models")
maximum_chunk_size: Optional[int] = Field(None, description="Maximum chunk size for embedding models")
chunk_batch: Optional[int] = Field(None, description="Batch size for chunking")
# STT specific fields
model_appid: Optional[str] = Field(None, description="Application ID for STT models")
access_token: Optional[str] = Field(None, description="Access token for STT models")
timeout_seconds: Optional[int] = Field(None, description="Request timeout in seconds")
concurrency_limit: Optional[int] = Field(None, description="Maximum concurrent requests for this model")
class ManageTenantModelDeleteRequest(BaseModel):
"""Request model for deleting a model from a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to delete model from")
display_name: str = Field(..., description="Display name of the model to delete")
class ManageTenantModelHealthcheckRequest(BaseModel):
"""Request model for checking model connectivity in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to check model connectivity")
display_name: str = Field(..., description="Display name of the model to check")
class ManageBatchCreateModelsRequest(BaseModel):
"""Request model for batch creating/updating models in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to batch create models for")
provider: str = Field(..., description="Model provider (e.g., 'silicon', 'modelengine')")
type: str = Field(..., description="Model type (e.g., 'llm', 'embedding')")
api_key: str = Field('', description="API key for the models")
models: List[Dict[str, Any]] = Field(default_factory=list, description="List of models to create/update")
class ManageProviderModelListRequest(BaseModel):
"""Request model for listing provider models in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to query provider models for")
provider: str = Field(..., description="Model provider (e.g., 'silicon', 'modelengine')")
model_type: str = Field(..., description="Model type (e.g., 'llm', 'embedding')")
class ManageProviderModelCreateRequest(BaseModel):
"""Request model for creating provider models in a specific tenant (admin/manage operation)"""
tenant_id: str = Field(..., min_length=1, description="Target tenant ID to create provider models for")
provider: str = Field(..., description="Model provider (e.g., 'silicon', 'modelengine')")
model_type: str = Field(..., description="Model type (e.g., 'llm', 'embedding')")
api_key: Optional[str] = Field('', description="API key for the provider")
base_url: Optional[str] = Field('', description="Base URL for the provider API")
# Agent Version Management Data Models
# ---------------------------------------------------------------------------
class VersionPublishRequest(BaseModel):
"""Request model for publishing a new version"""
version_name: Optional[str] = Field(None, description="User-defined version name for display")
release_note: Optional[str] = Field(None, description="Release notes / publish remarks")
publish_as_a2a: bool = Field(False, description="Whether to publish this agent as an A2A Server agent")
class VersionListItemResponse(BaseModel):
"""Response model for version list item"""
id: int = Field(..., description="Version record ID")
version_no: int = Field(..., description="Version number")
version_name: Optional[str] = Field(None, description="User-defined version name")
release_note: Optional[str] = Field(None, description="Release notes")
source_version_no: Optional[int] = Field(None, description="Source version number if rollback")
source_type: Optional[str] = Field(None, description="Source type: NORMAL / ROLLBACK")
status: str = Field(..., description="Version status: RELEASED / DISABLED / ARCHIVED")
is_a2a: bool = Field(False, description="Whether this version is published as an A2A Server agent")
created_by: str = Field(..., description="User who published this version")
create_time: Optional[str] = Field(None, description="Publish timestamp")
class VersionListResponse(BaseModel):
"""Response model for version list"""
items: List[VersionListItemResponse] = Field(..., description="Version list items")
total: int = Field(..., description="Total count")
class VersionDetailResponse(BaseModel):
"""Response model for version detail including snapshot data"""
id: int = Field(..., description="Version record ID")
version_no: int = Field(..., description="Version number")
version_name: Optional[str] = Field(None, description="User-defined version name")
release_note: Optional[str] = Field(None, description="Release notes")
source_version_no: Optional[int] = Field(None, description="Source version number")
source_type: Optional[str] = Field(None, description="Source type")
status: str = Field(..., description="Version status")
is_a2a: bool = Field(False, description="Whether this version is published as an A2A Server agent")
created_by: str = Field(..., description="User who published this version")
create_time: Optional[str] = Field(None, description="Publish timestamp")
agent_info: Optional[dict] = Field(None, description="Agent info snapshot")
tool_instances: List[dict] = Field(default_factory=list, description="Tool instance snapshots")
relations: List[dict] = Field(default_factory=list, description="Relation snapshots")
class VersionRollbackRequest(BaseModel):
"""Request model for rollback to a specific version"""
version_name: Optional[str] = Field(None, description="New version name for the rollback version")
release_note: Optional[str] = Field(None, description="Release notes for the rollback version")
class VersionStatusRequest(BaseModel):
"""Request model for updating version status"""
status: str = Field(..., description="New status: DISABLED / ARCHIVED")
class VersionUpdateRequest(BaseModel):
"""Request model for updating version metadata (name and description)"""
version_name: Optional[str] = Field(None, description="User-defined version name for display")
release_note: Optional[str] = Field(None, description="Release notes / version description")
class VersionCompareRequest(BaseModel):
"""Request model for comparing two versions"""
version_no_a: int = Field(..., description="First version number for comparison")
version_no_b: int = Field(..., description="Second version number for comparison")
class CurrentVersionResponse(BaseModel):
"""Response model for current published version"""
version_no: int = Field(..., description="Current published version number")
version_name: Optional[str] = Field(None, description="Version name")
status: str = Field(..., description="Version status")
source_type: Optional[str] = Field(None, description="Source type")
source_version_no: Optional[int] = Field(None, description="Source version number")
release_note: Optional[str] = Field(None, description="Release notes")
created_by: str = Field(..., description="User who published this version")
create_time: Optional[str] = Field(None, description="Publish timestamp")
# Skill Management Data Models
# ---------------------------------------------------------------------------
class SkillCreateRequest(BaseModel):
"""Request model for creating a skill via JSON."""
name: str
description: str
content: str
tool_ids: Optional[List[int]] = []
tool_names: Optional[List[str]] = []
tags: Optional[List[str]] = []
source: Optional[str] = "custom"
params: Optional[Dict[str, Any]] = None
files: Optional[List[Dict[str, str]]] = Field(
default_factory=list,
description="Additional skill files beyond SKILL.md. "
"Each entry has 'path' (relative path) and 'content'. "
"SKILL.md may also be sent here; the 'content' field is the primary SKILL.md source."
)
class SkillFileData(BaseModel):
"""A single file within a skill."""
path: str = Field(description="Relative file path within the skill (e.g. 'SKILL.md', 'scripts/run.py')")
content: str = Field(description="Full file content")
class SkillUpdateRequest(BaseModel):
"""Request model for updating a skill."""
description: Optional[str] = None