chore: docstring not match the function parameter (#17162)

This commit is contained in:
非法操作
2025-03-31 13:19:15 +08:00
committed by GitHub
parent 32527b26d5
commit 44f911a0a8
47 changed files with 60 additions and 95 deletions

View File

@@ -16,7 +16,6 @@ class ModelConfigConverter:
"""
Convert app model config dict to entity.
:param app_config: app config
:param skip_check: skip check
:raises ProviderTokenNotInitError: provider token not init error
:return: app orchestration config entity
"""

View File

@@ -88,7 +88,7 @@ class AdvancedChatAppGenerator(MessageBasedAppGenerator):
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
"""
if not args.get("query"):
raise ValueError("query is required")
@@ -181,10 +181,10 @@ class AdvancedChatAppGenerator(MessageBasedAppGenerator):
:param app_model: App
:param workflow: Workflow
:param node_id: the node id
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is streamed
"""
if not node_id:
raise ValueError("node_id is required")
@@ -238,10 +238,10 @@ class AdvancedChatAppGenerator(MessageBasedAppGenerator):
:param app_model: App
:param workflow: Workflow
:param node_id: the node id
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
"""
if not node_id:
raise ValueError("node_id is required")

View File

@@ -80,7 +80,7 @@ class AgentChatAppGenerator(MessageBasedAppGenerator):
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
"""
if not streaming:
raise ValueError("Agent Chat App does not support blocking mode")

View File

@@ -157,6 +157,7 @@ class AppRunner:
:param files: files
:param query: query
:param memory: memory
:param image_detail_config: the image quality config
:return:
"""
# get prompt without memory and context

View File

@@ -76,7 +76,7 @@ class ChatAppGenerator(MessageBasedAppGenerator):
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
"""
if not args.get("query"):
raise ValueError("query is required")

View File

@@ -74,7 +74,7 @@ class CompletionAppGenerator(MessageBasedAppGenerator):
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
"""
query = args["query"]
if not isinstance(query, str):

View File

@@ -158,7 +158,7 @@ class WorkflowAppGenerator(BaseAppGenerator):
:param user: account or end user
:param application_generate_entity: application generate entity
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is stream
:param workflow_thread_pool_id: workflow thread pool id
"""
# init queue manager
@@ -208,10 +208,10 @@ class WorkflowAppGenerator(BaseAppGenerator):
:param app_model: App
:param workflow: Workflow
:param node_id: the node id
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is streamed
"""
if not node_id:
raise ValueError("node_id is required")
@@ -264,10 +264,10 @@ class WorkflowAppGenerator(BaseAppGenerator):
:param app_model: App
:param workflow: Workflow
:param node_id: the node id
:param user: account or end user
:param args: request args
:param invoke_from: invoke from source
:param stream: is stream
:param streaming: is streamed
"""
if not node_id:
raise ValueError("node_id is required")

View File

@@ -44,9 +44,6 @@ class WorkflowAppRunner(WorkflowBasedAppRunner):
def run(self) -> None:
"""
Run application
:param application_generate_entity: application generate entity
:param queue_manager: application queue manager
:return:
"""
app_config = self.application_generate_entity.app_config
app_config = cast(WorkflowAppConfig, app_config)

View File

@@ -48,7 +48,7 @@ class MessageCycleManage:
def _generate_conversation_name(self, *, conversation_id: str, query: str) -> Optional[Thread]:
"""
Generate conversation name.
:param conversation: conversation
:param conversation_id: conversation id
:param query: query
:return: thread
"""

View File

@@ -153,7 +153,7 @@ class WorkflowCycleManage:
) -> WorkflowRun:
"""
Workflow run success
:param workflow_run: workflow run
:param workflow_run_id: workflow run id
:param start_at: start time
:param total_tokens: total tokens
:param total_steps: total steps
@@ -236,7 +236,7 @@ class WorkflowCycleManage:
) -> WorkflowRun:
"""
Workflow run failed
:param workflow_run: workflow run
:param workflow_run_id: workflow run id
:param start_at: start time
:param total_tokens: total tokens
:param total_steps: total steps