diff --git a/api/controllers/common/schema.py b/api/controllers/common/schema.py
index 58140f3ac8..a1b37d3df4 100644
--- a/api/controllers/common/schema.py
+++ b/api/controllers/common/schema.py
@@ -39,6 +39,7 @@ QueryParamDoc = TypedDict(
def _register_json_schema(namespace: Namespace, name: str, schema: dict) -> None:
"""Register a JSON schema and promote any nested Pydantic `$defs`."""
+ schema = _swagger_2_compatible_schema(schema)
nested_definitions = schema.get("$defs")
schema_to_register = dict(schema)
if isinstance(nested_definitions, dict):
@@ -65,6 +66,35 @@ def _register_schema_model(namespace: Namespace, model: type[BaseModel], *, mode
)
+def _swagger_2_compatible_schema(value: Any) -> Any:
+ if isinstance(value, list):
+ return [_swagger_2_compatible_schema(item) for item in value]
+
+ if not isinstance(value, dict):
+ return value
+
+ converted = {key: _swagger_2_compatible_schema(child) for key, child in value.items()}
+ any_of = value.get("anyOf")
+ if not isinstance(any_of, list):
+ return converted
+
+ non_null_candidates = [
+ candidate for candidate in any_of if isinstance(candidate, Mapping) and candidate.get("type") != "null"
+ ]
+ has_null_candidate = any(isinstance(candidate, Mapping) and candidate.get("type") == "null" for candidate in any_of)
+ if not has_null_candidate or len(non_null_candidates) != 1:
+ return converted
+
+ non_null_schema = _swagger_2_compatible_schema(dict(non_null_candidates[0]))
+ if not isinstance(non_null_schema, dict):
+ return converted
+
+ converted.pop("anyOf", None)
+ converted.update(non_null_schema)
+ converted["x-nullable"] = True
+ return converted
+
+
def register_schema_model(namespace: Namespace, model: type[BaseModel]) -> None:
"""Register a BaseModel and its nested schema definitions for Swagger documentation."""
diff --git a/api/openapi/markdown/console-swagger.md b/api/openapi/markdown/console-swagger.md
index b2f5bb1215..08143b2773 100644
--- a/api/openapi/markdown/console-swagger.md
+++ b/api/openapi/markdown/console-swagger.md
@@ -9991,7 +9991,7 @@ Get banner list
| ---- | ---- | ----------- | -------- |
| api_endpoint | string | | Yes |
| api_key | string | | Yes |
-| created_at | | | No |
+| created_at | integer | | No |
| id | string | | Yes |
| name | string | | Yes |
@@ -9999,17 +9999,17 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| avatar | | | No |
-| created_at | | | No |
+| avatar | string | | No |
+| created_at | integer | | No |
| email | string | | Yes |
| id | string | | Yes |
-| interface_language | | | No |
-| interface_theme | | | No |
+| interface_language | string | | No |
+| interface_theme | string | | No |
| is_password_set | boolean | | Yes |
-| last_login_at | | | No |
-| last_login_ip | | | No |
+| last_login_at | integer | | No |
+| last_login_ip | string | | No |
| name | string | | Yes |
-| timezone | | | No |
+| timezone | string | | No |
#### AccountAvatarPayload
@@ -10042,7 +10042,7 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| interface_language | string | | Yes |
-| invitation_code | | | No |
+| invitation_code | string | | No |
| timezone | string | | Yes |
#### AccountIntegrateListResponse
@@ -10055,9 +10055,9 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| is_bound | boolean | | Yes |
-| link | | | No |
+| link | string | | No |
| provider | string | | Yes |
#### AccountInterfaceLanguagePayload
@@ -10083,7 +10083,7 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| new_password | string | | Yes |
-| password | | | No |
+| password | string | | No |
| repeat_new_password | string | | Yes |
#### AccountTimezonePayload
@@ -10096,12 +10096,12 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| avatar | | | No |
-| created_at | | | No |
+| avatar | string | | No |
+| created_at | integer | | No |
| email | string | | Yes |
| id | string | | Yes |
-| last_active_at | | | No |
-| last_login_at | | | No |
+| last_active_at | integer | | No |
+| last_login_at | integer | | No |
| name | string | | Yes |
| role | string | | Yes |
| status | string | | Yes |
@@ -10116,26 +10116,26 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| email | | | No |
+| email | string | | No |
| token | string | | Yes |
-| workspace_id | | | No |
+| workspace_id | string | | No |
#### ActivatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| email | | | No |
+| email | string | | No |
| interface_language | string | | Yes |
| name | string | | Yes |
| timezone | string | | Yes |
| token | string | | Yes |
-| workspace_id | | | No |
+| workspace_id | string | | No |
#### ActivationCheckResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| data | | Activation data if valid | No |
+| data | object | Activation data if valid | No |
| is_valid | boolean | Whether token is valid | Yes |
#### ActivationResponse
@@ -10148,19 +10148,19 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| created_at | | | No |
-| created_by_account | | | No |
-| elapsed_time | | | No |
-| exceptions_count | | | No |
-| finished_at | | | No |
+| conversation_id | string | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| elapsed_time | number | | No |
+| exceptions_count | integer | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
-| message_id | | | No |
-| retry_index | | | No |
-| status | | | No |
-| total_steps | | | No |
-| total_tokens | | | No |
-| version | | | No |
+| message_id | string | | No |
+| retry_index | integer | | No |
+| status | string | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
+| version | string | | No |
#### AdvancedChatWorkflowRunPaginationResponse
@@ -10174,10 +10174,10 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| files | | | No |
-| inputs | | | No |
-| parent_message_id | | | No |
+| conversation_id | string | | No |
+| files | [ object ] | | No |
+| inputs | object | | No |
+| parent_message_id | string | | No |
| query | string | | No |
#### AdvancedPromptTemplateQuery
@@ -10200,28 +10200,28 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| chain_id | | | No |
-| created_at | | | No |
+| chain_id | string | | No |
+| created_at | integer | | No |
| files | [ string ] | | Yes |
| id | string | | Yes |
-| message_chain_id | | | No |
+| message_chain_id | string | | No |
| message_id | string | | Yes |
-| observation | | | No |
+| observation | string | | No |
| position | integer | | Yes |
-| thought | | | No |
-| tool | | | No |
-| tool_input | | | No |
+| thought | string | | No |
+| tool | string | | No |
+| tool_input | string | | No |
| tool_labels | [JSONValue](#jsonvalue) | | Yes |
#### Annotation
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| created_at | | | No |
-| hit_count | | | No |
+| content | string | | No |
+| created_at | integer | | No |
+| hit_count | integer | | No |
| id | string | | Yes |
-| question | | | No |
+| question | string | | No |
#### AnnotationCountResponse
@@ -10245,13 +10245,13 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| annotation_content | | | No |
-| annotation_question | | | No |
-| created_at | | | No |
+| annotation_content | string | | No |
+| annotation_question | string | | No |
+| created_at | integer | | No |
| id | string | | Yes |
-| question | | | No |
-| score | | | No |
-| source | | | No |
+| question | string | | No |
+| score | number | | No |
+| source | string | | No |
#### AnnotationHitHistoryList
@@ -10313,9 +10313,9 @@ Get banner list
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| id | string | | Yes |
-| last_used_at | | | No |
+| last_used_at | integer | | No |
| token | string | | Yes |
| type | string | | Yes |
@@ -10340,8 +10340,8 @@ Enum class for api provider schema type.
| credentials | object | | Yes |
| custom_disclaimer | string | | No |
| icon | object | | Yes |
-| labels | | | No |
-| privacy_policy | | | No |
+| labels | [ string ] | | No |
+| privacy_policy | string | | No |
| provider | string | | Yes |
| schema | string | | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
@@ -10359,9 +10359,9 @@ Enum class for api provider schema type.
| credentials | object | | Yes |
| custom_disclaimer | string | | No |
| icon | object | | Yes |
-| labels | | | No |
+| labels | [ string ] | | No |
| original_provider | string | | Yes |
-| privacy_policy | | | No |
+| privacy_policy | string | | No |
| provider | string | | Yes |
| schema | string | | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
@@ -10378,7 +10378,7 @@ Enum class for api provider schema type.
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
| parameters | object | | Yes |
-| provider_name | | | No |
+| provider_name | string | | No |
| schema | string | | Yes |
| schema_type | [ApiProviderSchemaType](#apiproviderschematype) | | Yes |
| tool_name | string | | Yes |
@@ -10393,24 +10393,24 @@ Enum class for api provider schema type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| access_mode | | | No |
-| app_model_config | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| description | | | No |
+| access_mode | string | | No |
+| app_model_config | [ModelConfig](#modelconfig) | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| description | string | | No |
| enable_api | boolean | | Yes |
| enable_site | boolean | | Yes |
-| icon | | | No |
-| icon_background | | | No |
+| icon | string | | No |
+| icon_background | string | | No |
| id | string | | Yes |
| mode_compatible_with_agent | string | | Yes |
| name | string | | Yes |
| tags | [ [Tag](#tag) ] | | No |
-| tracing | | | No |
-| updated_at | | | No |
-| updated_by | | | No |
-| use_icon_as_answer_icon | | | No |
-| workflow | | | No |
+| tracing | [JSONValue](#jsonvalue) | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
+| workflow | [WorkflowPartial](#workflowpartial) | | No |
#### AppDetailKernel
@@ -10429,36 +10429,36 @@ Enum class for api provider schema type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| access_mode | | | No |
-| api_base_url | | | No |
-| app_model_config | | | No |
-| created_at | | | No |
-| created_by | | | No |
+| access_mode | string | | No |
+| api_base_url | string | | No |
+| app_model_config | [ModelConfig](#modelconfig) | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
| deleted_tools | [ [DeletedTool](#deletedtool) ] | | No |
-| description | | | No |
+| description | string | | No |
| enable_api | boolean | | Yes |
| enable_site | boolean | | Yes |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| id | string | | Yes |
-| max_active_requests | | | No |
+| max_active_requests | integer | | No |
| mode_compatible_with_agent | string | | Yes |
| name | string | | Yes |
-| site | | | No |
+| site | [Site](#site) | | No |
| tags | [ [Tag](#tag) ] | | No |
-| tracing | | | No |
-| updated_at | | | No |
-| updated_by | | | No |
-| use_icon_as_answer_icon | | | No |
-| workflow | | | No |
+| tracing | [JSONValue](#jsonvalue) | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
+| workflow | [WorkflowPartial](#workflowpartial) | | No |
#### AppExportQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| include_secret | boolean | Include secrets in export | No |
-| workflow_id | | Specific workflow ID to export | No |
+| workflow_id | string | Specific workflow ID to export | No |
#### AppExportResponse
@@ -10470,47 +10470,47 @@ Enum class for api provider schema type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| icon | | Icon data | No |
-| icon_background | | Icon background color | No |
-| icon_type | | Icon type | No |
+| icon | string | Icon data | No |
+| icon_background | string | Icon background color | No |
+| icon_type | [IconType](#icontype) | Icon type | No |
#### AppImportPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| app_id | | | No |
-| description | | | No |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| app_id | string | | No |
+| description | string | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| mode | string | Import mode | Yes |
-| name | | | No |
-| yaml_content | | | No |
-| yaml_url | | | No |
+| name | string | | No |
+| yaml_content | string | | No |
+| yaml_url | string | | No |
#### AppListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| is_created_by_me | | Filter by creator | No |
+| is_created_by_me | boolean | Filter by creator | No |
| limit | integer | Page size (1-100) | No |
| mode | string | App mode filter
*Enum:* `"advanced-chat"`, `"agent-chat"`, `"all"`, `"channel"`, `"chat"`, `"completion"`, `"workflow"` | No |
-| name | | Filter by app name | No |
+| name | string | Filter by app name | No |
| page | integer | Page number (1-99999) | No |
-| tag_ids | | Filter by tag IDs | No |
+| tag_ids | [ string ] | Filter by tag IDs | No |
#### AppMCPServerResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| description | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
| parameters | | | Yes |
| server_code | string | | Yes |
| status | [AppMCPServerStatus](#appmcpserverstatus) | | Yes |
-| updated_at | | | No |
+| updated_at | integer | | No |
#### AppMCPServerStatus
@@ -10540,42 +10540,42 @@ AppMCPServer Status Enum
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| access_mode | | | No |
-| app_model_config | | | No |
-| author_name | | | No |
-| create_user_name | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| desc_or_prompt | | | No |
-| has_draft_trigger | | | No |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| access_mode | string | | No |
+| app_model_config | [ModelConfigPartial](#modelconfigpartial) | | No |
+| author_name | string | | No |
+| create_user_name | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| desc_or_prompt | string | | No |
+| has_draft_trigger | boolean | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| id | string | | Yes |
-| max_active_requests | | | No |
+| max_active_requests | integer | | No |
| mode_compatible_with_agent | string | | Yes |
| name | string | | Yes |
| tags | [ [Tag](#tag) ] | | No |
-| updated_at | | | No |
-| updated_by | | | No |
-| use_icon_as_answer_icon | | | No |
-| workflow | | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
+| workflow | [WorkflowPartial](#workflowpartial) | | No |
#### AppSiteResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| app_id | string | | Yes |
-| code | | | No |
-| copyright | | | No |
-| custom_disclaimer | | | No |
-| customize_domain | | | No |
+| code | string | | No |
+| copyright | string | | No |
+| custom_disclaimer | string | | No |
+| customize_domain | string | | No |
| customize_token_strategy | string | | Yes |
| default_language | string | | Yes |
-| description | | | No |
-| icon | | | No |
-| icon_background | | | No |
-| privacy_policy | | | No |
+| description | string | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| privacy_policy | string | | No |
| prompt_public | boolean | | Yes |
| show_workflow_steps | boolean | | Yes |
| title | string | | Yes |
@@ -10591,29 +10591,29 @@ AppMCPServer Status Enum
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| chat_color_theme | | | No |
-| chat_color_theme_inverted | | | No |
-| copyright | | | No |
-| custom_disclaimer | | | No |
-| customize_domain | | | No |
-| customize_token_strategy | | | No |
-| default_language | | | No |
-| description | | | No |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
-| privacy_policy | | | No |
-| prompt_public | | | No |
-| show_workflow_steps | | | No |
-| title | | | No |
-| use_icon_as_answer_icon | | | No |
+| chat_color_theme | string | | No |
+| chat_color_theme_inverted | boolean | | No |
+| copyright | string | | No |
+| custom_disclaimer | string | | No |
+| customize_domain | string | | No |
+| customize_token_strategy | string | *Enum:* `"allow"`, `"must"`, `"not_allow"` | No |
+| default_language | string | | No |
+| description | string | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
+| privacy_policy | string | | No |
+| prompt_public | boolean | | No |
+| show_workflow_steps | boolean | | No |
+| title | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
#### AppTracePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | boolean | Enable or disable tracing | Yes |
-| tracing_provider | | Tracing provider | No |
+| tracing_provider | string | Tracing provider | No |
#### AudioTranscriptResponse
@@ -10642,7 +10642,7 @@ Retrieval settings for Amazon Bedrock knowledge base queries.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| score_threshold | number | Minimum relevance score threshold | No |
-| top_k | | Maximum number of results to retrieve | No |
+| top_k | integer | Maximum number of results to retrieve | No |
#### BuiltinProviderDefaultCredentialPayload
@@ -10655,7 +10655,7 @@ Retrieval settings for Amazon Bedrock knowledge base queries.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
-| name | | | No |
+| name | string | | No |
| type | [CredentialType](#credentialtype) | | Yes |
#### BuiltinToolCredentialDeletePayload
@@ -10669,8 +10669,8 @@ Retrieval settings for Amazon Bedrock knowledge base queries.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string | | Yes |
-| credentials | | | No |
-| name | | | No |
+| credentials | object | | No |
+| name | string | | No |
#### ButtonStyle
@@ -10692,9 +10692,9 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| language | | | No |
-| phase | | | No |
-| token | | | No |
+| language | string | | No |
+| phase | string | | No |
+| token | string | | No |
#### ChangeEmailValidityPayload
@@ -10709,22 +10709,22 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_status | string | Annotation status filter
*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
-| end | | End date (YYYY-MM-DD HH:MM) | No |
-| keyword | | Search keyword | No |
+| end | string | End date (YYYY-MM-DD HH:MM) | No |
+| keyword | string | Search keyword | No |
| limit | integer | Page size (1-100) | No |
| page | integer | Page number | No |
| sort_by | string | Sort field and direction
*Enum:* `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"` | No |
-| start | | Start date (YYYY-MM-DD HH:MM) | No |
+| start | string | Start date (YYYY-MM-DD HH:MM) | No |
#### ChatMessagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | Conversation ID | No |
-| files | | Uploaded files | No |
+| conversation_id | string | Conversation ID | No |
+| files | [ ] | Uploaded files | No |
| inputs | object | | Yes |
| model_config | object | | Yes |
-| parent_message_id | | Parent message ID | No |
+| parent_message_id | string | Parent message ID | No |
| query | string | User query | Yes |
| response_mode | string | Response mode
*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | Retriever source | No |
@@ -10734,17 +10734,17 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation ID | Yes |
-| first_id | | First message ID for pagination | No |
+| first_id | string | First message ID for pagination | No |
| limit | integer | Number of messages to return (1-100) | No |
#### ChatRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| files | | | No |
+| conversation_id | string | | No |
+| files | [ ] | | No |
| inputs | object | | Yes |
-| parent_message_id | | | No |
+| parent_message_id | string | | No |
| query | string | | Yes |
| retriever_from | string | | No |
@@ -10777,7 +10777,7 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
-| id | | | No |
+| id | string | | No |
#### ChildChunkUpdatePayload
@@ -10797,27 +10797,27 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| annotation_status | string | Annotation status filter
*Enum:* `"all"`, `"annotated"`, `"not_annotated"` | No |
-| end | | End date (YYYY-MM-DD HH:MM) | No |
-| keyword | | Search keyword | No |
+| end | string | End date (YYYY-MM-DD HH:MM) | No |
+| keyword | string | Search keyword | No |
| limit | integer | Page size (1-100) | No |
| page | integer | Page number | No |
-| start | | Start date (YYYY-MM-DD HH:MM) | No |
+| start | string | Start date (YYYY-MM-DD HH:MM) | No |
#### CompletionMessageExplorePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
| query | string | | No |
-| response_mode | | | No |
+| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | | No |
#### CompletionMessagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | Uploaded files | No |
+| files | [ ] | Uploaded files | No |
| inputs | object | | Yes |
| model_config | object | | Yes |
| query | string | Query text | No |
@@ -10828,10 +10828,10 @@ Button styles for user actions.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ ] | | No |
| inputs | object | | Yes |
| query | string | | No |
-| response_mode | | | No |
+| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | | No |
#### ComplianceDownloadQuery
@@ -10856,7 +10856,7 @@ Condition detail
| ---- | ---- | ----------- | -------- |
| ids | [ string ] | Filter by dataset IDs | No |
| include_all | boolean | Include all datasets | No |
-| keyword | | Search keyword | No |
+| keyword | string | Search keyword | No |
| limit | integer | Number of items per page | No |
| page | integer | Page number | No |
| tag_ids | [ string ] | Filter by tag IDs | No |
@@ -10865,77 +10865,77 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| admin_feedback_stats | | | No |
-| annotation | | | No |
-| created_at | | | No |
-| first_message | | | No |
-| from_account_id | | | No |
-| from_account_name | | | No |
-| from_end_user_id | | | No |
-| from_end_user_session_id | | | No |
+| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
+| annotation | [ConversationAnnotation](#conversationannotation) | | No |
+| created_at | integer | | No |
+| first_message | [SimpleMessageDetail](#simplemessagedetail) | | No |
+| from_account_id | string | | No |
+| from_account_name | string | | No |
+| from_end_user_id | string | | No |
+| from_end_user_session_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
-| model_config | | | No |
-| read_at | | | No |
+| model_config | [SimpleModelConfig](#simplemodelconfig) | | No |
+| read_at | integer | | No |
| status | string | | Yes |
-| updated_at | | | No |
-| user_feedback_stats | | | No |
+| updated_at | integer | | No |
+| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
#### ConversationAnnotation
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| account | | | No |
+| account | [SimpleAccount](#simpleaccount) | | No |
| content | string | | Yes |
-| created_at | | | No |
+| created_at | integer | | No |
| id | string | | Yes |
-| question | | | No |
+| question | string | | No |
#### ConversationAnnotationHitHistory
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| annotation_create_account | | | No |
-| created_at | | | No |
+| annotation_create_account | [SimpleAccount](#simpleaccount) | | No |
+| created_at | integer | | No |
| id | string | | Yes |
#### ConversationDetail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| admin_feedback_stats | | | No |
+| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
| annotated | boolean | | Yes |
-| created_at | | | No |
-| from_account_id | | | No |
-| from_end_user_id | | | No |
+| created_at | integer | | No |
+| from_account_id | string | | No |
+| from_end_user_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
-| introduction | | | No |
+| introduction | string | | No |
| message_count | integer | | Yes |
-| model_config | | | No |
+| model_config | [ModelConfig](#modelconfig) | | No |
| status | string | | Yes |
-| updated_at | | | No |
-| user_feedback_stats | | | No |
+| updated_at | integer | | No |
+| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
#### ConversationListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | | No |
+| last_id | string | | No |
| limit | integer | | No |
-| pinned | | | No |
+| pinned | boolean | | No |
#### ConversationMessageDetail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| first_message | | | No |
-| from_account_id | | | No |
-| from_end_user_id | | | No |
+| created_at | integer | | No |
+| first_message | [MessageDetail](#messagedetail) | | No |
+| from_account_id | string | | No |
+| from_end_user_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
-| model_config | | | No |
+| model_config | [ModelConfig](#modelconfig) | | No |
| status | string | | Yes |
#### ConversationPagination
@@ -10953,7 +10953,7 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_generate | boolean | | No |
-| name | | | No |
+| name | string | | No |
#### ConversationVariable
@@ -10969,12 +10969,12 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| description | | | No |
+| created_at | integer | | No |
+| description | string | | No |
| id | string | | Yes |
| name | string | | Yes |
-| updated_at | | | No |
-| value | | | No |
+| updated_at | integer | | No |
+| value | string | | No |
| value_type | string | | Yes |
#### ConversationVariableUpdatePayload
@@ -10993,24 +10993,24 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| admin_feedback_stats | | | No |
+| admin_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
| annotated | boolean | | Yes |
-| created_at | | | No |
-| from_account_id | | | No |
-| from_account_name | | | No |
-| from_end_user_id | | | No |
-| from_end_user_session_id | | | No |
+| created_at | integer | | No |
+| from_account_id | string | | No |
+| from_account_name | string | | No |
+| from_end_user_id | string | | No |
+| from_end_user_session_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
| message_count | integer | | Yes |
-| model_config | | | No |
+| model_config | [SimpleModelConfig](#simplemodelconfig) | | No |
| name | string | | Yes |
-| read_at | | | No |
+| read_at | integer | | No |
| status | string | | Yes |
-| status_count | | | No |
+| status_count | [StatusCount](#statuscount) | | No |
| summary_or_query | string | | Yes |
-| updated_at | | | No |
-| user_feedback_stats | | | No |
+| updated_at | integer | | No |
+| user_feedback_stats | [FeedbackStat](#feedbackstat) | | No |
#### ConversationWithSummaryPagination
@@ -11026,39 +11026,39 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
-| name | | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
+| name | string | | No |
#### CopyAppPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | Description for the copied app | No |
-| icon | | Icon | No |
-| icon_background | | Icon background color | No |
-| icon_type | | Icon type | No |
-| name | | Name for the copied app | No |
+| description | string | Description for the copied app | No |
+| icon | string | Icon | No |
+| icon_background | string | Icon background color | No |
+| icon_type | [IconType](#icontype) | Icon type | No |
+| name | string | Name for the copied app | No |
#### CreateAnnotationPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| annotation_reply | | Annotation reply data | No |
-| answer | | Answer text | No |
-| content | | Content text | No |
-| message_id | | Message ID | No |
-| question | | Question text | No |
+| annotation_reply | object | Annotation reply data | No |
+| answer | string | Answer text | No |
+| content | string | Content text | No |
+| message_id | string | Message ID | No |
+| question | string | Question text | No |
#### CreateAppPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | App description (max 400 chars) | No |
-| icon | | Icon | No |
-| icon_background | | Icon background color | No |
-| icon_type | | Icon type | No |
+| description | string | App description (max 400 chars) | No |
+| icon | string | Icon | No |
+| icon_background | string | Icon background color | No |
+| icon_type | [IconType](#icontype) | Icon type | No |
| mode | string | App mode
*Enum:* `"advanced-chat"`, `"agent-chat"`, `"chat"`, `"completion"`, `"workflow"` | Yes |
| name | string | App name | Yes |
@@ -11154,11 +11154,11 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | No |
-| external_knowledge_api_id | | | No |
-| external_knowledge_id | | | No |
-| indexing_technique | | | No |
+| external_knowledge_api_id | string | | No |
+| external_knowledge_id | string | | No |
+| indexing_technique | string | | No |
| name | string | | Yes |
-| permission | | | No |
+| permission | [DatasetPermissionEnum](#datasetpermissionenum) | | No |
| provider | string | | No |
#### DatasetDetail
@@ -11264,14 +11264,14 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by | | | No |
-| data_source_type | | | No |
-| description | | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| data_source_type | string | | No |
+| description | string | | No |
| id | string | | Yes |
-| indexing_technique | | | No |
+| indexing_technique | string | | No |
| name | string | | Yes |
-| permission | | | No |
+| permission | string | | No |
#### DatasetRetrievalModel
@@ -11290,20 +11290,20 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | | No |
-| embedding_model | | | No |
-| embedding_model_provider | | | No |
-| external_knowledge_api_id | | | No |
-| external_knowledge_id | | | No |
-| external_retrieval_model | | | No |
-| icon_info | | | No |
-| indexing_technique | | | No |
-| is_multimodal | | | No |
-| name | | | No |
-| partial_member_list | | | No |
-| permission | | | No |
-| retrieval_model | | | No |
-| summary_index_setting | | | No |
+| description | string | | No |
+| embedding_model | string | | No |
+| embedding_model_provider | string | | No |
+| external_knowledge_api_id | string | | No |
+| external_knowledge_id | string | | No |
+| external_retrieval_model | object | | No |
+| icon_info | object | | No |
+| indexing_technique | string | | No |
+| is_multimodal | boolean | | No |
+| name | string | | No |
+| partial_member_list | [ object ] | | No |
+| permission | [DatasetPermissionEnum](#datasetpermissionenum) | | No |
+| retrieval_model | object | | No |
+| summary_index_setting | object | | No |
#### DatasetVectorSetting
@@ -11332,22 +11332,22 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
-| name | | | No |
+| name | string | | No |
#### DatasourceCredentialUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credential_id | string | | Yes |
-| credentials | | | No |
-| name | | | No |
+| credentials | object | | No |
+| name | string | | No |
#### DatasourceCustomClientPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| client_params | | | No |
-| enable_oauth_custom_client | | | No |
+| client_params | object | | No |
+| enable_oauth_custom_client | boolean | | No |
#### DatasourceDefaultPayload
@@ -11359,7 +11359,7 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| credential_id | | | No |
+| credential_id | string | | No |
| datasource_type | string | | Yes |
| inputs | object | | Yes |
@@ -11389,7 +11389,7 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| q | | | No |
+| q | string | | No |
#### DeletedTool
@@ -11422,14 +11422,14 @@ Request payload for bulk downloading documents as a zip archive.
| id | string | | Yes |
| name | string | | Yes |
| type | string | | Yes |
-| value | | | No |
+| value | string | | No |
#### DocumentMetadataUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| doc_metadata | | | No |
-| doc_type | | | No |
+| doc_type | string | | No |
#### DocumentRenamePayload
@@ -11441,30 +11441,30 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| archived | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| created_from | | | No |
+| archived | boolean | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| created_from | string | | No |
| data_source_detail_dict | | | No |
| data_source_info_dict | | | No |
-| data_source_type | | | No |
-| dataset_process_rule_id | | | No |
-| disabled_at | | | No |
-| disabled_by | | | No |
-| display_status | | | No |
-| doc_form | | | No |
+| data_source_type | string | | No |
+| dataset_process_rule_id | string | | No |
+| disabled_at | integer | | No |
+| disabled_by | string | | No |
+| display_status | string | | No |
+| doc_form | string | | No |
| doc_metadata_details | [ [DocumentMetadataResponse](#documentmetadataresponse) ] | | No |
-| enabled | | | No |
-| error | | | No |
-| hit_count | | | No |
+| enabled | boolean | | No |
+| error | string | | No |
+| hit_count | integer | | No |
| id | string | | Yes |
-| indexing_status | | | No |
+| indexing_status | string | | No |
| name | string | | Yes |
-| need_summary | | | No |
-| position | | | No |
-| summary_index_status | | | No |
-| tokens | | | No |
-| word_count | | | No |
+| need_summary | boolean | | No |
+| position | integer | | No |
+| summary_index_status | string | | No |
+| tokens | integer | | No |
+| word_count | integer | | No |
#### DocumentRetryPayload
@@ -11476,39 +11476,39 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| archived | | | No |
-| completed_segments | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| created_from | | | No |
+| archived | boolean | | No |
+| completed_segments | integer | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| created_from | string | | No |
| data_source_detail_dict | | | No |
| data_source_info_dict | | | No |
-| data_source_type | | | No |
-| dataset_process_rule_id | | | No |
-| disabled_at | | | No |
-| disabled_by | | | No |
-| display_status | | | No |
-| doc_form | | | No |
+| data_source_type | string | | No |
+| dataset_process_rule_id | string | | No |
+| disabled_at | integer | | No |
+| disabled_by | string | | No |
+| display_status | string | | No |
+| doc_form | string | | No |
| doc_metadata_details | [ [DocumentMetadataResponse](#documentmetadataresponse) ] | | No |
-| enabled | | | No |
-| error | | | No |
-| hit_count | | | No |
+| enabled | boolean | | No |
+| error | string | | No |
+| hit_count | integer | | No |
| id | string | | Yes |
-| indexing_status | | | No |
+| indexing_status | string | | No |
| name | string | | Yes |
-| need_summary | | | No |
-| position | | | No |
+| need_summary | boolean | | No |
+| position | integer | | No |
| process_rule_dict | | | No |
-| summary_index_status | | | No |
-| tokens | | | No |
-| total_segments | | | No |
-| word_count | | | No |
+| summary_index_status | string | | No |
+| tokens | integer | | No |
+| total_segments | integer | | No |
+| word_count | integer | | No |
#### DraftWorkflowNodeRunPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
| query | string | | No |
@@ -11525,12 +11525,12 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_variables | | | No |
-| environment_variables | | | No |
-| features | | | No |
+| conversation_variables | [ object ] | | No |
+| environment_variables | [ object ] | | No |
+| features | object | | No |
| graph | object | | Yes |
-| hash | | | No |
-| rag_pipeline_variables | | | No |
+| hash | string | | No |
+| rag_pipeline_variables | [ object ] | | No |
#### DraftWorkflowTriggerRunAllPayload
@@ -11570,24 +11570,24 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| curr_page | | | No |
+| curr_page | integer | | No |
| data | [ string ] | | No |
-| has_next | | | No |
+| has_next | boolean | | No |
#### EducationStatusResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| allow_refresh | | | No |
-| expire_at | | | No |
-| is_student | | | No |
-| result | | | No |
+| allow_refresh | boolean | | No |
+| expire_at | integer | | No |
+| is_student | boolean | | No |
+| result | boolean | | No |
#### EducationVerifyResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| token | | | No |
+| token | string | | No |
#### EmailCodeLoginPayload
@@ -11595,8 +11595,8 @@ Request payload for bulk downloading documents as a zip archive.
| ---- | ---- | ----------- | -------- |
| code | string | | Yes |
| email | string | | Yes |
-| language | | | No |
-| timezone | | | No |
+| language | string | | No |
+| timezone | string | | No |
| token | string | | Yes |
#### EmailPayload
@@ -11604,16 +11604,16 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| language | | | No |
+| language | string | | No |
#### EmailRegisterResetPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| language | | | No |
+| language | string | | No |
| new_password | string | | Yes |
| password_confirm | string | | Yes |
-| timezone | | | No |
+| timezone | string | | No |
| token | string | | Yes |
#### EmailRegisterSendPayload
@@ -11621,7 +11621,7 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | Email address | Yes |
-| language | | Language code | No |
+| language | string | Language code | No |
#### EmailRegisterValidityPayload
@@ -11719,7 +11719,7 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword | | Search keyword | No |
+| keyword | string | Search keyword | No |
| limit | integer | Number of items per page | No |
| page | integer | Page number | No |
@@ -11727,18 +11727,18 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | | No |
+| description | string | | No |
| external_knowledge_api_id | string | | Yes |
| external_knowledge_id | string | | Yes |
-| external_retrieval_model | | | No |
+| external_retrieval_model | object | | No |
| name | string | | Yes |
#### ExternalHitTestingPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| external_retrieval_model | | | No |
-| metadata_filtering_conditions | | | No |
+| external_retrieval_model | object | | No |
+| metadata_filtering_conditions | object | | No |
| query | string | | Yes |
#### ExternalKnowledgeApiPayload
@@ -11775,9 +11775,9 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| from_account | | | No |
-| from_end_user_id | | | No |
+| content | string | | No |
+| from_account | [SimpleAccount](#simpleaccount) | | No |
+| from_end_user_id | string | | No |
| from_source | string | | Yes |
| rating | string | | Yes |
@@ -11785,12 +11785,12 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| end_date | | End date (YYYY-MM-DD) | No |
+| end_date | string | End date (YYYY-MM-DD) | No |
| format | string | Export format
*Enum:* `"csv"`, `"json"` | No |
-| from_source | | Filter by feedback source | No |
-| has_comment | | Only include feedback with comments | No |
-| rating | | Filter by rating | No |
-| start_date | | Start date (YYYY-MM-DD) | No |
+| from_source | string | Filter by feedback source
*Enum:* `"admin"`, `"user"` | No |
+| has_comment | boolean | Only include feedback with comments | No |
+| rating | string | Filter by rating
*Enum:* `"dislike"`, `"like"` | No |
+| start_date | string | Start date (YYYY-MM-DD) | No |
#### FeedbackStat
@@ -11809,20 +11809,20 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| extension | | | No |
-| file_key | | | No |
+| conversation_id | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| extension | string | | No |
+| file_key | string | | No |
| id | string | | Yes |
-| mime_type | | | No |
+| mime_type | string | | No |
| name | string | | Yes |
-| original_url | | | No |
-| preview_url | | | No |
+| original_url | string | | No |
+| preview_url | string | | No |
| size | integer | | Yes |
-| source_url | | | No |
-| tenant_id | | | No |
-| user_id | | | No |
+| source_url | string | | No |
+| tenant_id | string | | No |
+| user_id | string | | No |
#### ForgotPasswordCheckPayload
@@ -11844,8 +11844,8 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| code | | Error code if account not found | No |
-| data | | Reset token | No |
+| code | string | Error code if account not found | No |
+| data | string | Reset token | No |
| result | string | Operation result | Yes |
#### ForgotPasswordResetPayload
@@ -11867,7 +11867,7 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| language | | | No |
+| language | string | | No |
#### FormInput
@@ -11875,7 +11875,7 @@ Form input definition.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| default | | | No |
+| default | [FormInputDefault](#forminputdefault) | | No |
| output_variable_name | string | | Yes |
| type | [FormInputType](#forminputtype) | | Yes |
@@ -11916,40 +11916,40 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| id | | | No |
-| position | | | No |
-| score | | | No |
+| content | string | | No |
+| id | string | | No |
+| position | integer | | No |
+| score | number | | No |
#### HitTestingDocument
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| data_source_type | | | No |
+| data_source_type | string | | No |
| doc_metadata | | | No |
-| doc_type | | | No |
-| id | | | No |
-| name | | | No |
+| doc_type | string | | No |
+| id | string | | No |
+| name | string | | No |
#### HitTestingFile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| extension | | | No |
-| id | | | No |
-| mime_type | | | No |
-| name | | | No |
-| size | | | No |
-| source_url | | | No |
+| extension | string | | No |
+| id | string | | No |
+| mime_type | string | | No |
+| name | string | | No |
+| size | integer | | No |
+| source_url | string | | No |
#### HitTestingPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| attachment_ids | | | No |
-| external_retrieval_model | | | No |
+| attachment_ids | [ string ] | | No |
+| external_retrieval_model | object | | No |
| query | string | | Yes |
-| retrieval_model | | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
#### HitTestingRecord
@@ -11957,9 +11957,9 @@ Form input types.
| ---- | ---- | ----------- | -------- |
| child_chunks | [ [HitTestingChildChunk](#hittestingchildchunk) ] | | No |
| files | [ [HitTestingFile](#hittestingfile) ] | | No |
-| score | | | No |
-| segment | | | No |
-| summary | | | No |
+| score | number | | No |
+| segment | [HitTestingSegment](#hittestingsegment) | | No |
+| summary | string | | No |
| tsne_position | | | No |
#### HitTestingResponse
@@ -11973,36 +11973,36 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| answer | | | No |
-| completed_at | | | No |
-| content | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| disabled_at | | | No |
-| disabled_by | | | No |
-| document | | | No |
-| document_id | | | No |
-| enabled | | | No |
-| error | | | No |
-| hit_count | | | No |
-| id | | | No |
-| index_node_hash | | | No |
-| index_node_id | | | No |
-| indexing_at | | | No |
+| answer | string | | No |
+| completed_at | integer | | No |
+| content | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| disabled_at | integer | | No |
+| disabled_by | string | | No |
+| document | [HitTestingDocument](#hittestingdocument) | | No |
+| document_id | string | | No |
+| enabled | boolean | | No |
+| error | string | | No |
+| hit_count | integer | | No |
+| id | string | | No |
+| index_node_hash | string | | No |
+| index_node_id | string | | No |
+| indexing_at | integer | | No |
| keywords | [ string ] | | No |
-| position | | | No |
-| sign_content | | | No |
-| status | | | No |
-| stopped_at | | | No |
-| tokens | | | No |
-| word_count | | | No |
+| position | integer | | No |
+| sign_content | string | | No |
+| status | string | | No |
+| stopped_at | integer | | No |
+| tokens | integer | | No |
+| word_count | integer | | No |
#### HumanInputContent
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| form_definition | | | No |
-| form_submission_data | | | No |
+| form_definition | [HumanInputFormDefinition](#humaninputformdefinition) | | No |
+| form_submission_data | [HumanInputFormSubmissionData](#humaninputformsubmissiondata) | | No |
| submitted | boolean | | Yes |
| type | [ExecutionContentType](#executioncontenttype) | | No |
| workflow_run_id | string | | Yes |
@@ -12023,7 +12023,7 @@ Form input types.
| expiration_time | integer | | Yes |
| form_content | string | | Yes |
| form_id | string | | Yes |
-| form_token | | | No |
+| form_token | string | | No |
| inputs | [ [FormInput](#forminput) ] | | No |
| node_id | string | | Yes |
| node_title | string | | Yes |
@@ -12057,7 +12057,7 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| backstage_input_url | | | No |
+| backstage_input_url | string | | No |
| form_id | string | | Yes |
| type | string | | Yes |
@@ -12071,8 +12071,8 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| app_id | | | No |
-| app_mode | | | No |
+| app_id | string | | No |
+| app_mode | string | | No |
| current_dsl_version | string | | No |
| error | string | | No |
| id | string | | Yes |
@@ -12095,7 +12095,7 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| dataset_id | | | No |
+| dataset_id | string | | No |
| doc_form | string | | No |
| doc_language | string | | No |
| indexing_technique | string | | Yes |
@@ -12107,17 +12107,17 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| data_source_type | string | *Enum:* `"notion_import"`, `"upload_file"`, `"website_crawl"` | Yes |
-| file_info_list | | | No |
-| notion_info_list | | | No |
-| website_info_list | | | No |
+| file_info_list | [FileInfo](#fileinfo) | | No |
+| notion_info_list | [ [NotionInfo](#notioninfo) ] | | No |
+| website_info_list | [WebsiteInfo](#websiteinfo) | | No |
#### Inner
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| model | | | No |
+| model | string | | No |
| model_type | [ModelType](#modeltype) | | Yes |
-| provider | | | No |
+| provider | string | | No |
#### InstallPermission
@@ -12135,13 +12135,13 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| id | string | | Yes |
-| mode | | | No |
-| name | | | No |
-| use_icon_as_answer_icon | | | No |
+| mode | string | | No |
+| name | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
#### InstalledAppListResponse
@@ -12158,20 +12158,20 @@ Form input types.
| editable | boolean | | Yes |
| id | string | | Yes |
| is_pinned | boolean | | Yes |
-| last_used_at | | | No |
+| last_used_at | integer | | No |
| uninstallable | boolean | | Yes |
#### InstalledAppUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| is_pinned | | | No |
+| is_pinned | boolean | | No |
#### InstalledAppsListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| app_id | | App ID to filter by | No |
+| app_id | string | App ID to filter by | No |
#### InstructionGeneratePayload
@@ -12195,7 +12195,7 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| inputs | | | No |
+| inputs | object | | No |
#### JSONValue
@@ -12207,19 +12207,19 @@ Form input types.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| data_source | | | No |
+| data_source | [DataSource](#datasource) | | No |
| doc_form | string | | No |
| doc_language | string | | No |
| duplicate | boolean | | No |
-| embedding_model | | | No |
-| embedding_model_provider | | | No |
+| embedding_model | string | | No |
+| embedding_model_provider | string | | No |
| indexing_technique | string | *Enum:* `"economy"`, `"high_quality"` | Yes |
| is_multimodal | boolean | | No |
-| name | | | No |
-| original_document_id | | | No |
-| process_rule | | | No |
-| retrieval_model | | | No |
-| summary_index_setting | | | No |
+| name | string | | No |
+| original_document_id | string | | No |
+| process_rule | [ProcessRule](#processrule) | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
+| summary_index_setting | object | | No |
#### LLMMode
@@ -12249,15 +12249,15 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| configs | | | No |
-| enabled | | | No |
+| configs | [ object ] | | No |
+| enabled | boolean | | No |
#### LoginPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| invite_token | | Invitation token | No |
+| invite_token | string | Invitation token | No |
| password | string | | Yes |
| remember_me | boolean | Remember me flag | No |
@@ -12265,22 +12265,22 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| inputs | | | No |
+| inputs | object | | No |
#### MCPAuthPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| authorization_code | | | No |
+| authorization_code | string | | No |
| provider_id | string | | Yes |
#### MCPProviderCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| authentication | | | No |
-| configuration | | | No |
-| headers | | | No |
+| authentication | object | | No |
+| configuration | object | | No |
+| headers | object | | No |
| icon | string | | Yes |
| icon_background | string | | No |
| icon_type | string | | Yes |
@@ -12298,9 +12298,9 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| authentication | | | No |
-| configuration | | | No |
-| headers | | | No |
+| authentication | object | | No |
+| configuration | object | | No |
+| headers | object | | No |
| icon | string | | Yes |
| icon_background | string | | No |
| icon_type | string | | Yes |
@@ -12313,31 +12313,31 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | Server description | No |
+| description | string | Server description | No |
| parameters | object | Server parameters configuration | Yes |
#### MCPServerUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | Server description | No |
+| description | string | Server description | No |
| id | string | Server ID | Yes |
| parameters | object | Server parameters configuration | Yes |
-| status | | Server status | No |
+| status | string | Server status | No |
#### Marketplace
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| marketplace_plugin_unique_identifier | string | | Yes |
-| version | | | No |
+| version | string | | No |
#### MemberInvitePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| emails | [ string ] | | No |
-| language | | | No |
+| language | string | | No |
| role | [TenantAccountRole](#tenantaccountrole) | | Yes |
#### MemberRoleUpdatePayload
@@ -12351,15 +12351,15 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_thoughts | [ [AgentThought](#agentthought) ] | | Yes |
-| annotation | | | No |
-| annotation_hit_history | | | No |
+| annotation | [ConversationAnnotation](#conversationannotation) | | No |
+| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) | | No |
| answer_tokens | integer | | Yes |
| conversation_id | string | | Yes |
-| created_at | | | No |
-| error | | | No |
+| created_at | integer | | No |
+| error | string | | No |
| feedbacks | [ [Feedback](#feedback) ] | | Yes |
-| from_account_id | | | No |
-| from_end_user_id | | | No |
+| from_account_id | string | | No |
+| from_end_user_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
| inputs | object | | Yes |
@@ -12367,63 +12367,63 @@ Enum class for large language model mode.
| message_files | [ [MessageFile](#messagefile) ] | | Yes |
| message_metadata_dict | [JSONValue](#jsonvalue) | | Yes |
| message_tokens | integer | | Yes |
-| parent_message_id | | | No |
+| parent_message_id | string | | No |
| provider_response_latency | number | | Yes |
| query | string | | Yes |
| re_sign_file_url_answer | string | | Yes |
| status | string | | Yes |
-| workflow_run_id | | | No |
+| workflow_run_id | string | | No |
#### MessageDetailResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| agent_thoughts | [ [AgentThought](#agentthought) ] | | No |
-| annotation | | | No |
-| annotation_hit_history | | | No |
-| answer_tokens | | | No |
+| annotation | [ConversationAnnotation](#conversationannotation) | | No |
+| annotation_hit_history | [ConversationAnnotationHitHistory](#conversationannotationhithistory) | | No |
+| answer_tokens | integer | | No |
| conversation_id | string | | Yes |
-| created_at | | | No |
-| error | | | No |
+| created_at | integer | | No |
+| error | string | | No |
| extra_contents | [ [HumanInputContent](#humaninputcontent) ] | | No |
| feedbacks | [ [Feedback](#feedback) ] | | No |
-| from_account_id | | | No |
-| from_end_user_id | | | No |
+| from_account_id | string | | No |
+| from_end_user_id | string | | No |
| from_source | string | | Yes |
| id | string | | Yes |
| inputs | object | | Yes |
-| message | | | No |
+| message | [JSONValue](#jsonvalue) | | No |
| message_files | [ [MessageFile](#messagefile) ] | | No |
-| message_metadata_dict | | | No |
-| message_tokens | | | No |
-| parent_message_id | | | No |
-| provider_response_latency | | | No |
+| message_metadata_dict | [JSONValue](#jsonvalue) | | No |
+| message_tokens | integer | | No |
+| parent_message_id | string | | No |
+| provider_response_latency | number | | No |
| query | string | | Yes |
| re_sign_file_url_answer | string | | Yes |
| status | string | | Yes |
-| workflow_run_id | | | No |
+| workflow_run_id | string | | No |
#### MessageFeedbackPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
+| content | string | | No |
| message_id | string | Message ID | Yes |
-| rating | | | No |
+| rating | string | *Enum:* `"dislike"`, `"like"` | No |
#### MessageFile
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| belongs_to | | | No |
+| belongs_to | string | | No |
| filename | string | | Yes |
| id | string | | Yes |
-| mime_type | | | No |
-| size | | | No |
+| mime_type | string | | No |
+| size | integer | | No |
| transfer_method | string | | Yes |
| type | string | | Yes |
-| upload_file_id | | | No |
-| url | | | No |
+| upload_file_id | string | | No |
+| url | string | | No |
#### MessageInfiniteScrollPaginationResponse
@@ -12438,7 +12438,7 @@ Enum class for large language model mode.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation UUID | Yes |
-| first_id | | First message ID for pagination | No |
+| first_id | string | First message ID for pagination | No |
| limit | integer | Number of messages to return (1-100) | No |
#### MetadataArgs
@@ -12462,8 +12462,8 @@ Metadata Filtering Condition.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conditions | | | No |
-| logical_operator | | | No |
+| conditions | [ [Condition](#condition) ] | | No |
+| logical_operator | string | *Enum:* `"and"`, `"or"` | No |
#### MetadataOperationData
@@ -12492,29 +12492,29 @@ Metadata operation data
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by | | | No |
-| model_dict | | | No |
-| pre_prompt | | | No |
-| updated_at | | | No |
-| updated_by | | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| model_dict | [JSONValue](#jsonvalue) | | No |
+| pre_prompt | string | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
#### ModelConfigRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| agent_mode | | Agent mode configuration | No |
-| configs | | Model configuration parameters | No |
-| dataset_configs | | Dataset configurations | No |
-| model | | Model name | No |
-| more_like_this | | More like this configuration | No |
-| opening_statement | | Opening statement | No |
-| provider | | Model provider | No |
-| retrieval_model | | Retrieval model configuration | No |
-| speech_to_text | | Speech to text configuration | No |
-| suggested_questions | | Suggested questions | No |
-| text_to_speech | | Text to speech configuration | No |
-| tools | | Available tools | No |
+| agent_mode | object | Agent mode configuration | No |
+| configs | object | Model configuration parameters | No |
+| dataset_configs | object | Dataset configurations | No |
+| model | string | Model name | No |
+| more_like_this | object | More like this configuration | No |
+| opening_statement | string | Opening statement | No |
+| provider | string | Model provider | No |
+| retrieval_model | object | Retrieval model configuration | No |
+| speech_to_text | object | Speech to text configuration | No |
+| suggested_questions | [ string ] | Suggested questions | No |
+| text_to_speech | object | Text to speech configuration | No |
+| tools | [ object ] | Available tools | No |
#### ModelType
@@ -12540,7 +12540,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| inputs | | | No |
+| inputs | object | | No |
#### NodeRunRequiredPayload
@@ -12561,9 +12561,9 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| emoji | | | No |
+| emoji | string | | No |
| type | string | | Yes |
-| url | | | No |
+| url | string | | No |
#### NotionInfo
@@ -12603,7 +12603,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| page_icon | | | No |
+| page_icon | [NotionIcon](#notionicon) | | No |
| page_id | string | | Yes |
| page_name | string | | Yes |
| type | string | | Yes |
@@ -12637,7 +12637,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| language | | | No |
+| language | string | | No |
#### OwnerTransferPayload
@@ -12650,7 +12650,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| plugin_unique_identifier | string | | Yes |
-| version | | | No |
+| version | string | | No |
#### PaginatedConversationVariableResponse
@@ -12666,7 +12666,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| credential_id | | | No |
+| credential_id | string | | No |
| datasource_type | string | | Yes |
| inputs | object | | Yes |
@@ -12684,14 +12684,14 @@ Enum class for model type.
| credentials | object | | Yes |
| model | string | | Yes |
| model_type | [ModelType](#modeltype) | | Yes |
-| name | | | No |
+| name | string | | No |
#### ParserCredentialCreate
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| credentials | object | | Yes |
-| name | | | No |
+| name | string | | No |
#### ParserCredentialDelete
@@ -12703,7 +12703,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| credential_id | | | No |
+| credential_id | string | | No |
#### ParserCredentialSwitch
@@ -12717,7 +12717,7 @@ Enum class for model type.
| ---- | ---- | ----------- | -------- |
| credential_id | string | | Yes |
| credentials | object | | Yes |
-| name | | | No |
+| name | string | | No |
#### ParserCredentialValidate
@@ -12745,7 +12745,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| action | string | | Yes |
-| credential_id | | | No |
+| credential_id | string | | No |
| parameter | string | | Yes |
| plugin_id | string | | Yes |
| provider | string | | Yes |
@@ -12779,8 +12779,8 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| config_from | | | No |
-| credential_id | | | No |
+| config_from | string | | No |
+| credential_id | string | | No |
| model | string | | Yes |
| model_type | [ModelType](#modeltype) | | Yes |
@@ -12848,7 +12848,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| model_type | | | No |
+| model_type | [ModelType](#modeltype) | | No |
#### ParserParameter
@@ -12885,9 +12885,9 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| config_from | | | No |
-| credential_id | | | No |
-| load_balancing | | | No |
+| config_from | string | | No |
+| credential_id | string | | No |
+| load_balancing | [LoadBalancingPayload](#loadbalancingpayload) | | No |
| model | string | | Yes |
| model_type | [ModelType](#modeltype) | | Yes |
@@ -12940,7 +12940,7 @@ Enum class for model type.
| credentials | object | | Yes |
| model | string | | Yes |
| model_type | [ModelType](#modeltype) | | Yes |
-| name | | | No |
+| name | string | | No |
#### ParserValidate
@@ -12969,7 +12969,7 @@ Enum class for model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | | No |
-| icon_info | | | No |
+| icon_info | object | | No |
| name | string | | Yes |
#### PipelineVariable
@@ -13013,7 +13013,7 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| current_identifier | | | No |
+| current_identifier | string | | No |
| type | [Type](#type) | | Yes |
| value | | | Yes |
@@ -13042,14 +13042,14 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mode | string | *Enum:* `"automatic"`, `"custom"`, `"hierarchical"` | Yes |
-| rules | | | No |
+| rules | [Rule](#rule) | | No |
#### PublishWorkflowPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| marked_comment | | | No |
-| marked_name | | | No |
+| marked_comment | string | | No |
+| marked_name | string | | No |
#### PublishedWorkflowRunPayload
@@ -13059,7 +13059,7 @@ Default value types for form inputs.
| datasource_type | string | | Yes |
| inputs | object | | Yes |
| is_preview | boolean | | No |
-| original_document_id | | | No |
+| original_document_id | string | | No |
| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| start_node_id | string | | Yes |
@@ -13091,15 +13091,15 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | | No |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| description | string | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| mode | string | | Yes |
-| name | | | No |
-| pipeline_id | | | No |
-| yaml_content | | | No |
-| yaml_url | | | No |
+| name | string | | No |
+| pipeline_id | string | | No |
+| yaml_content | string | | No |
+| yaml_url | string | | No |
#### RagPipelineLeakedDependency
@@ -13119,12 +13119,12 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| icon | | | No |
-| icon_background | | | No |
-| icon_type | | | No |
+| icon | string | | No |
+| icon_background | string | | No |
+| icon_type | string | | No |
| id | string | | Yes |
-| mode | | | No |
-| name | | | No |
+| mode | string | | No |
+| name | string | | No |
#### RecommendedAppListResponse
@@ -13137,22 +13137,22 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| app | | | No |
+| app | [RecommendedAppInfoResponse](#recommendedappinforesponse) | | No |
| app_id | string | | Yes |
-| can_trial | | | No |
+| can_trial | boolean | | No |
| categories | [ string ] | | No |
-| copyright | | | No |
-| custom_disclaimer | | | No |
-| description | | | No |
-| is_listed | | | No |
-| position | | | No |
-| privacy_policy | | | No |
+| copyright | string | | No |
+| custom_disclaimer | string | | No |
+| description | string | | No |
+| is_listed | boolean | | No |
+| position | integer | | No |
+| privacy_policy | string | | No |
#### RecommendedAppsQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| language | | Language code for recommended app localization | No |
+| language | string | Language code for recommended app localization | No |
#### RelatedAppList
@@ -13165,8 +13165,8 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| reranking_model_name | | | No |
-| reranking_provider_name | | | No |
+| reranking_model_name | string | | No |
+| reranking_provider_name | string | | No |
#### ResultResponse
@@ -13184,24 +13184,24 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| metadata_filtering_conditions | | | No |
+| metadata_filtering_conditions | [MetadataFilteringCondition](#metadatafilteringcondition) | | No |
| reranking_enable | boolean | | Yes |
-| reranking_mode | | | No |
-| reranking_model | | | No |
-| score_threshold | | | No |
+| reranking_mode | string | | No |
+| reranking_model | [RerankingModel](#rerankingmodel) | | No |
+| score_threshold | number | | No |
| score_threshold_enabled | boolean | | Yes |
| search_method | [RetrievalMethod](#retrievalmethod) | | Yes |
| top_k | integer | | Yes |
-| weights | | | No |
+| weights | [WeightModel](#weightmodel) | | No |
#### Rule
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| parent_mode | | | No |
-| pre_processing_rules | | | No |
-| segmentation | | | No |
-| subchunk_segmentation | | | No |
+| parent_mode | string | *Enum:* `"full-doc"`, `"paragraph"` | No |
+| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] | | No |
+| segmentation | [Segmentation](#segmentation) | | No |
+| subchunk_segmentation | [Segmentation](#segmentation) | | No |
#### RuleCodeGeneratePayload
@@ -13237,25 +13237,25 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | | No |
+| last_id | string | | No |
| limit | integer | | No |
#### SegmentCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| answer | | | No |
-| attachment_ids | | | No |
+| answer | string | | No |
+| attachment_ids | [ string ] | | No |
| content | string | | Yes |
-| keywords | | | No |
+| keywords | [ string ] | | No |
#### SegmentListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| enabled | string | | No |
-| hit_count_gte | | | No |
-| keyword | | | No |
+| hit_count_gte | integer | | No |
+| keyword | string | | No |
| limit | integer | | No |
| page | integer | | No |
| status | [ string ] | | No |
@@ -13264,12 +13264,12 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| answer | | | No |
-| attachment_ids | | | No |
+| answer | string | | No |
+| attachment_ids | [ string ] | | No |
| content | string | | Yes |
-| keywords | | | No |
+| keywords | [ string ] | | No |
| regenerate_child_chunks | boolean | | No |
-| summary | | | No |
+| summary | string | | No |
#### Segmentation
@@ -13293,7 +13293,7 @@ Default value types for form inputs.
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| is_anonymous | boolean | | Yes |
-| session_id | | | No |
+| session_id | string | | No |
| type | string | | Yes |
#### SimpleMessageDetail
@@ -13309,42 +13309,42 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| model_dict | | | No |
-| pre_prompt | | | No |
+| model_dict | [JSONValue](#jsonvalue) | | No |
+| pre_prompt | string | | No |
#### Site
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| app_base_url | | | No |
-| chat_color_theme | | | No |
-| chat_color_theme_inverted | | | No |
-| code | | | No |
-| copyright | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| custom_disclaimer | | | No |
-| customize_domain | | | No |
-| customize_token_strategy | | | No |
-| default_language | | | No |
-| description | | | No |
-| icon | | | No |
-| icon_background | | | No |
+| app_base_url | string | | No |
+| chat_color_theme | string | | No |
+| chat_color_theme_inverted | boolean | | No |
+| code | string | | No |
+| copyright | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| custom_disclaimer | string | | No |
+| customize_domain | string | | No |
+| customize_token_strategy | string | | No |
+| default_language | string | | No |
+| description | string | | No |
+| icon | string | | No |
+| icon_background | string | | No |
| icon_type | | | No |
-| privacy_policy | | | No |
-| prompt_public | | | No |
-| show_workflow_steps | | | No |
-| title | | | No |
-| updated_at | | | No |
-| updated_by | | | No |
-| use_icon_as_answer_icon | | | No |
+| privacy_policy | string | | No |
+| prompt_public | boolean | | No |
+| show_workflow_steps | boolean | | No |
+| title | string | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
+| use_icon_as_answer_icon | boolean | | No |
#### StatisticTimeRangeQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| end | | End date (YYYY-MM-DD HH:MM) | No |
-| start | | Start date (YYYY-MM-DD HH:MM) | No |
+| end | string | End date (YYYY-MM-DD HH:MM) | No |
+| start | string | Start date (YYYY-MM-DD HH:MM) | No |
#### StatusCount
@@ -13388,7 +13388,7 @@ Default value types for form inputs.
| environment_variables | [ object ] | | No |
| features | object | | Yes |
| graph | object | | Yes |
-| hash | | | No |
+| hash | string | | No |
#### SyncDraftWorkflowResponse
@@ -13439,17 +13439,17 @@ Default value types for form inputs.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword | | Search keyword | No |
+| keyword | string | Search keyword | No |
| type | string | Tag type filter
*Enum:* `""`, `"app"`, `"knowledge"` | No |
#### TagResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| binding_count | | | No |
+| binding_count | string | | No |
| id | string | | Yes |
| name | string | | Yes |
-| type | | | No |
+| type | string | | No |
#### TagType
@@ -13475,45 +13475,45 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| custom_config | | | No |
+| created_at | integer | | No |
+| custom_config | object | | No |
| id | string | | Yes |
-| in_trial | | | No |
-| name | | | No |
-| next_credit_reset_date | | | No |
-| plan | | | No |
-| role | | | No |
-| status | | | No |
-| trial_credits | | | No |
-| trial_credits_used | | | No |
-| trial_end_reason | | | No |
+| in_trial | boolean | | No |
+| name | string | | No |
+| next_credit_reset_date | integer | | No |
+| plan | string | | No |
+| role | string | | No |
+| status | string | | No |
+| trial_credits | integer | | No |
+| trial_credits_used | integer | | No |
+| trial_end_reason | string | | No |
#### TextToAudioPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| message_id | | Message ID | No |
-| streaming | | Enable streaming response | No |
-| text | | Text to convert to audio | No |
-| voice | | Voice to use for TTS | No |
+| message_id | string | Message ID | No |
+| streaming | boolean | Enable streaming response | No |
+| text | string | Text to convert to audio | No |
+| voice | string | Voice to use for TTS | No |
#### TextToSpeechPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| message_id | | Message ID | No |
-| streaming | | Whether to stream audio | No |
+| message_id | string | Message ID | No |
+| streaming | boolean | Whether to stream audio | No |
| text | string | Text to convert | Yes |
-| voice | | Voice name | No |
+| voice | string | Voice name | No |
#### TextToSpeechRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| message_id | | | No |
-| streaming | | | No |
-| text | | | No |
-| voice | | | No |
+| message_id | string | | No |
+| streaming | boolean | | No |
+| text | string | | No |
+| voice | string | | No |
#### TextToSpeechVoiceQuery
@@ -13525,8 +13525,8 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| client_params | | | No |
-| enable_oauth_custom_client | | | No |
+| client_params | object | | No |
+| enable_oauth_custom_client | boolean | | No |
#### ToolParameterForm
@@ -13720,8 +13720,8 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| client_params | | | No |
-| enabled | | | No |
+| client_params | object | | No |
+| enabled | boolean | | No |
#### TriggerSubscriptionBuilderCreatePayload
@@ -13733,10 +13733,10 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| credentials | | | No |
-| name | | | No |
-| parameters | | | No |
-| properties | | | No |
+| credentials | object | | No |
+| name | string | | No |
+| parameters | object | | No |
+| properties | object | | No |
#### TriggerSubscriptionBuilderVerifyPayload
@@ -13754,22 +13754,22 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| annotation_reply | | | No |
-| answer | | | No |
-| content | | | No |
-| question | | | No |
+| annotation_reply | object | | No |
+| answer | string | | No |
+| content | string | | No |
+| question | string | | No |
#### UpdateAppPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | App description (max 400 chars) | No |
-| icon | | Icon | No |
-| icon_background | | Icon background color | No |
-| icon_type | | Icon type | No |
-| max_active_requests | | Maximum active requests | No |
+| description | string | App description (max 400 chars) | No |
+| icon | string | Icon | No |
+| icon_background | string | Icon background color | No |
+| icon_type | [IconType](#icontype) | Icon type | No |
+| max_active_requests | integer | Maximum active requests | No |
| name | string | App name | Yes |
-| use_icon_as_answer_icon | | Use icon as answer icon | No |
+| use_icon_as_answer_icon | boolean | Use icon as answer icon | No |
#### UpgradeMode
@@ -13781,11 +13781,11 @@ Tag type
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| attachment_image_file_size_limit | | | No |
+| attachment_image_file_size_limit | integer | | No |
| audio_file_size_limit | integer | | Yes |
| batch_count_limit | integer | | Yes |
| file_size_limit | integer | | Yes |
-| file_upload_limit | | | No |
+| file_upload_limit | integer | | No |
| image_file_batch_limit | integer | | Yes |
| image_file_size_limit | integer | | Yes |
| single_chunk_attachment_limit | integer | | Yes |
@@ -13806,7 +13806,7 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | dateTime | | No |
| id | string | | Yes |
| node_id | string | | Yes |
| webhook_debug_url | string | | Yes |
@@ -13846,9 +13846,9 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword_setting | | | No |
-| vector_setting | | | No |
-| weight_type | | | No |
+| keyword_setting | [WeightKeywordSetting](#weightkeywordsetting) | | No |
+| vector_setting | [WeightVectorSetting](#weightvectorsetting) | | No |
+| weight_type | string | *Enum:* `"customized"`, `"keyword_first"`, `"semantic_first"` | No |
#### WeightVectorSetting
@@ -13892,28 +13892,28 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| created_by_end_user | | | No |
-| created_by_role | | | No |
-| created_from | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
+| created_by_role | string | | No |
+| created_from | string | | No |
| details | | | No |
| id | string | | Yes |
-| workflow_run | | | No |
+| workflow_run | [WorkflowRunForLogResponse](#workflowrunforlogresponse) | | No |
#### WorkflowAppLogQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at__after | | Filter logs created after this timestamp | No |
-| created_at__before | | Filter logs created before this timestamp | No |
-| created_by_account | | Filter by account | No |
-| created_by_end_user_session_id | | Filter by end user session ID | No |
+| created_at__after | dateTime | Filter logs created after this timestamp | No |
+| created_at__before | dateTime | Filter logs created before this timestamp | No |
+| created_by_account | string | Filter by account | No |
+| created_by_end_user_session_id | string | Filter by end user session ID | No |
| detail | boolean | Whether to return detailed logs | No |
-| keyword | | Search keyword for filtering logs | No |
+| keyword | string | Search keyword for filtering logs | No |
| limit | integer | Number of items per page (1-100) | No |
| page | integer | Page number (1-99999) | No |
-| status | | Execution status filter (succeeded, failed, stopped, partial-succeeded) | No |
+| status | [WorkflowExecutionStatus](#workflowexecutionstatus) | Execution status filter (succeeded, failed, stopped, partial-succeeded) | No |
#### WorkflowArchivedLogPaginationResponse
@@ -13929,18 +13929,18 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| created_by_end_user | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
| id | string | | Yes |
| trigger_metadata | | | No |
-| workflow_run | | | No |
+| workflow_run | [WorkflowRunForArchivedLogResponse](#workflowrunforarchivedlogresponse) | | No |
#### WorkflowCommentAccount
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| avatar_url | | | Yes |
+| avatar_url | string | | Yes |
| email | string | | Yes |
| id | string | | Yes |
| name | string | | Yes |
@@ -13950,9 +13950,9 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
-| created_at | | | No |
+| created_at | integer | | No |
| created_by | string | | Yes |
-| created_by_account | | | No |
+| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
| id | string | | Yes |
| mention_count | integer | | Yes |
| participants | [ [WorkflowCommentAccount](#workflowcommentaccount) ] | | Yes |
@@ -13960,10 +13960,10 @@ User action configuration.
| position_y | number | | Yes |
| reply_count | integer | | Yes |
| resolved | boolean | | Yes |
-| resolved_at | | | No |
-| resolved_by | | | No |
-| resolved_by_account | | | No |
-| updated_at | | | No |
+| resolved_at | integer | | No |
+| resolved_by | string | | No |
+| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
+| updated_at | integer | | No |
#### WorkflowCommentBasicList
@@ -13975,7 +13975,7 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| id | string | | Yes |
#### WorkflowCommentCreatePayload
@@ -13992,27 +13992,27 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
-| created_at | | | No |
+| created_at | integer | | No |
| created_by | string | | Yes |
-| created_by_account | | | No |
+| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
| id | string | | Yes |
| mentions | [ [WorkflowCommentMention](#workflowcommentmention) ] | | Yes |
| position_x | number | | Yes |
| position_y | number | | Yes |
| replies | [ [WorkflowCommentReply](#workflowcommentreply) ] | | Yes |
| resolved | boolean | | Yes |
-| resolved_at | | | No |
-| resolved_by | | | No |
-| resolved_by_account | | | No |
-| updated_at | | | No |
+| resolved_at | integer | | No |
+| resolved_by | string | | No |
+| resolved_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
+| updated_at | integer | | No |
#### WorkflowCommentMention
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| mentioned_user_account | | | No |
+| mentioned_user_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
| mentioned_user_id | string | | Yes |
-| reply_id | | | No |
+| reply_id | string | | No |
#### WorkflowCommentMentionUsersPayload
@@ -14025,16 +14025,16 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | | Yes |
-| created_at | | | No |
+| created_at | integer | | No |
| created_by | string | | Yes |
-| created_by_account | | | No |
+| created_by_account | [WorkflowCommentAccount](#workflowcommentaccount) | | No |
| id | string | | Yes |
#### WorkflowCommentReplyCreate
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| id | string | | Yes |
#### WorkflowCommentReplyPayload
@@ -14049,7 +14049,7 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
-| updated_at | | | No |
+| updated_at | integer | | No |
#### WorkflowCommentResolve
@@ -14057,24 +14057,24 @@ User action configuration.
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| resolved | boolean | | Yes |
-| resolved_at | | | No |
-| resolved_by | | | No |
+| resolved_at | integer | | No |
+| resolved_by | string | | No |
#### WorkflowCommentUpdate
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
-| updated_at | | | No |
+| updated_at | integer | | No |
#### WorkflowCommentUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| content | string | Comment content | Yes |
-| mentioned_user_ids | | Mentioned user IDs. Omit to keep existing mentions. | No |
-| position_x | | Comment X position | No |
-| position_y | | Comment Y position | No |
+| mentioned_user_ids | [ string ] | Mentioned user IDs. Omit to keep existing mentions. | No |
+| position_x | number | Comment X position | No |
+| position_y | number | Comment Y position | No |
#### WorkflowDraftEnvVariable
@@ -14135,14 +14135,14 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| name | | | No |
+| name | string | | No |
| value | | | No |
#### WorkflowDraftVariableUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| name | | Variable name | No |
+| name | string | Variable name | No |
| value | | Variable value | No |
#### WorkflowDraftVariableWithoutValue
@@ -14178,7 +14178,7 @@ User action configuration.
| limit | integer | | No |
| named_only | boolean | | No |
| page | integer | | No |
-| user_id | | | No |
+| user_id | string | | No |
#### WorkflowOnlineUsersPayload
@@ -14199,26 +14199,26 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by | | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
| id | string | | Yes |
-| updated_at | | | No |
-| updated_by | | | No |
+| updated_at | integer | | No |
+| updated_by | string | | No |
#### WorkflowPauseDetailsResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| paused_at | | | No |
+| paused_at | string | | No |
| paused_nodes | [ [PausedNodeResponse](#pausednoderesponse) ] | | Yes |
#### WorkflowRunCountQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| status | | Workflow run status filter | No |
-| time_range | | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No |
-| triggered_from | | Filter by trigger source: debugging or app-run. Default: debugging | No |
+| status | string | Workflow run status filter
*Enum:* `"failed"`, `"partial-succeeded"`, `"running"`, `"stopped"`, `"succeeded"` | No |
+| time_range | string | Filter by time range (optional): e.g., 7d (7 days), 4h (4 hours), 30m (30 minutes), 30s (30 seconds). Filters by created_at field. | No |
+| triggered_from | string | Filter by trigger source: debugging or app-run. Default: debugging
*Enum:* `"app-run"`, `"debugging"` | No |
#### WorkflowRunCountResponse
@@ -14235,81 +14235,81 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| created_by_end_user | | | No |
-| created_by_role | | | No |
-| elapsed_time | | | No |
-| error | | | No |
-| exceptions_count | | | No |
-| finished_at | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
+| created_by_role | string | | No |
+| elapsed_time | number | | No |
+| error | string | | No |
+| exceptions_count | integer | | No |
+| finished_at | integer | | No |
| graph | | | Yes |
| id | string | | Yes |
| inputs | | | Yes |
| outputs | | | Yes |
-| status | | | No |
-| total_steps | | | No |
-| total_tokens | | | No |
-| version | | | No |
+| status | string | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
+| version | string | | No |
#### WorkflowRunExportResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| presigned_url | | Pre-signed URL for download | No |
-| presigned_url_expires_at | | Pre-signed URL expiration time | No |
+| presigned_url | string | Pre-signed URL for download | No |
+| presigned_url_expires_at | string | Pre-signed URL expiration time | No |
| status | string | Export status: success/failed | Yes |
#### WorkflowRunForArchivedLogResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| elapsed_time | | | No |
+| elapsed_time | number | | No |
| id | string | | Yes |
-| status | | | No |
-| total_tokens | | | No |
-| triggered_from | | | No |
+| status | string | | No |
+| total_tokens | integer | | No |
+| triggered_from | string | | No |
#### WorkflowRunForListResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| elapsed_time | | | No |
-| exceptions_count | | | No |
-| finished_at | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| elapsed_time | number | | No |
+| exceptions_count | integer | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
-| retry_index | | | No |
-| status | | | No |
-| total_steps | | | No |
-| total_tokens | | | No |
-| version | | | No |
+| retry_index | integer | | No |
+| status | string | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
+| version | string | | No |
#### WorkflowRunForLogResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| elapsed_time | | | No |
-| error | | | No |
-| exceptions_count | | | No |
-| finished_at | | | No |
+| created_at | integer | | No |
+| elapsed_time | number | | No |
+| error | string | | No |
+| exceptions_count | integer | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
-| status | | | No |
-| total_steps | | | No |
-| total_tokens | | | No |
-| triggered_from | | | No |
-| version | | | No |
+| status | string | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
+| triggered_from | string | | No |
+| version | string | | No |
#### WorkflowRunListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | Last run ID for pagination | No |
+| last_id | string | Last run ID for pagination | No |
| limit | integer | Number of items per page (1-100) | No |
-| status | | Workflow run status filter | No |
-| triggered_from | | Filter by trigger source: debugging or app-run. Default: debugging | No |
+| status | string | Workflow run status filter
*Enum:* `"failed"`, `"partial-succeeded"`, `"running"`, `"stopped"`, `"succeeded"` | No |
+| triggered_from | string | Filter by trigger source: debugging or app-run. Default: debugging
*Enum:* `"app-run"`, `"debugging"` | No |
#### WorkflowRunNodeExecutionListResponse
@@ -14321,28 +14321,28 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| created_by_end_user | | | No |
-| created_by_role | | | No |
-| elapsed_time | | | No |
-| error | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
+| created_by_role | string | | No |
+| elapsed_time | number | | No |
+| error | string | | No |
| execution_metadata | | | No |
| extras | | | No |
-| finished_at | | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
-| index | | | No |
+| index | integer | | No |
| inputs | | | No |
-| inputs_truncated | | | No |
-| node_id | | | No |
-| node_type | | | No |
+| inputs_truncated | boolean | | No |
+| node_id | string | | No |
+| node_type | string | | No |
| outputs | | | No |
-| outputs_truncated | | | No |
-| predecessor_node_id | | | No |
+| outputs_truncated | boolean | | No |
+| predecessor_node_id | string | | No |
| process_data | | | No |
-| process_data_truncated | | | No |
-| status | | | No |
-| title | | | No |
+| process_data_truncated | boolean | | No |
+| status | string | | No |
+| title | string | | No |
#### WorkflowRunPaginationResponse
@@ -14356,29 +14356,29 @@ User action configuration.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
#### WorkflowRunQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | | No |
+| last_id | string | | No |
| limit | integer | | No |
#### WorkflowRunRequest
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ ] | | No |
| inputs | object | | Yes |
#### WorkflowStatisticQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| end | | End date and time (YYYY-MM-DD HH:MM) | No |
-| start | | Start date and time (YYYY-MM-DD HH:MM) | No |
+| end | string | End date and time (YYYY-MM-DD HH:MM) | No |
+| start | string | Start date and time (YYYY-MM-DD HH:MM) | No |
#### WorkflowToolCreatePayload
@@ -14387,10 +14387,10 @@ User action configuration.
| description | string | | Yes |
| icon | object | | Yes |
| label | string | | Yes |
-| labels | | | No |
+| labels | [ string ] | | No |
| name | string | | Yes |
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | No |
-| privacy_policy | | | No |
+| privacy_policy | string | | No |
| workflow_app_id | string | | Yes |
#### WorkflowToolDeletePayload
@@ -14416,10 +14416,10 @@ Workflow tool configuration
| description | string | | Yes |
| icon | object | | Yes |
| label | string | | Yes |
-| labels | | | No |
+| labels | [ string ] | | No |
| name | string | | Yes |
| parameters | [ [WorkflowToolParameterConfiguration](#workflowtoolparameterconfiguration) ] | | No |
-| privacy_policy | | | No |
+| privacy_policy | string | | No |
| workflow_tool_id | string | | Yes |
#### WorkflowTriggerListResponse
@@ -14432,7 +14432,7 @@ Workflow tool configuration
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | dateTime | | No |
| icon | string | | Yes |
| id | string | | Yes |
| node_id | string | | Yes |
@@ -14440,21 +14440,21 @@ Workflow tool configuration
| status | string | | Yes |
| title | string | | Yes |
| trigger_type | string | | Yes |
-| updated_at | | | No |
+| updated_at | dateTime | | No |
#### WorkflowUpdatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| marked_comment | | | No |
-| marked_name | | | No |
+| marked_comment | string | | No |
+| marked_name | string | | No |
#### WorkspaceCustomConfigPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| remove_webapp_brand | | | No |
-| replace_webapp_logo | | | No |
+| remove_webapp_brand | boolean | | No |
+| replace_webapp_logo | string | | No |
#### WorkspaceInfoPayload
diff --git a/api/openapi/markdown/service-swagger.md b/api/openapi/markdown/service-swagger.md
index ec5ed280f5..72bea2a1aa 100644
--- a/api/openapi/markdown/service-swagger.md
+++ b/api/openapi/markdown/service-swagger.md
@@ -2136,11 +2136,11 @@ Returns a list of available models for the specified model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| created_at | | | No |
-| hit_count | | | No |
+| content | string | | No |
+| created_at | integer | | No |
+| hit_count | integer | | No |
| id | string | | Yes |
-| question | | | No |
+| question | string | | No |
#### AnnotationCreatePayload
@@ -2172,13 +2172,13 @@ Returns a list of available models for the specified model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_generate_name | boolean | Auto generate conversation name | No |
-| conversation_id | | Conversation UUID | No |
-| files | | | No |
+| conversation_id | string | Conversation UUID | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
| query | string | | Yes |
-| response_mode | | | No |
+| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | | No |
-| workflow_id | | Workflow ID for advanced chat | No |
+| workflow_id | string | Workflow ID for advanced chat | No |
#### ChildChunkCreatePayload
@@ -2190,7 +2190,7 @@ Returns a list of available models for the specified model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword | | | No |
+| keyword | string | | No |
| limit | integer | | No |
| page | integer | | No |
@@ -2204,10 +2204,10 @@ Returns a list of available models for the specified model type.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
| query | string | | No |
-| response_mode | | | No |
+| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | | No |
#### Condition
@@ -2224,7 +2224,7 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | Last conversation ID for pagination | No |
+| last_id | string | Last conversation ID for pagination | No |
| limit | integer | Number of conversations to return | No |
| sort_by | string | Sort order for conversations
*Enum:* `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"` | No |
@@ -2233,7 +2233,7 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_generate | boolean | | No |
-| name | | | No |
+| name | string | | No |
#### ConversationVariableInfiniteScrollPaginationResponse
@@ -2247,12 +2247,12 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| description | | | No |
+| created_at | integer | | No |
+| description | string | | No |
| id | string | | Yes |
| name | string | | Yes |
-| updated_at | | | No |
-| value | | | No |
+| updated_at | integer | | No |
+| value | string | | No |
| value_type | string | | Yes |
#### ConversationVariableUpdatePayload
@@ -2265,15 +2265,15 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | Last variable ID for pagination | No |
+| last_id | string | Last variable ID for pagination | No |
| limit | integer | Number of variables to return | No |
-| variable_name | | Filter variables by name | No |
+| variable_name | string | Filter variables by name | No |
#### DataSetTag
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| binding_count | | | No |
+| binding_count | string | | No |
| id | string | | Yes |
| name | string | | Yes |
| type | string | | Yes |
@@ -2283,23 +2283,23 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| description | string | Dataset description (max 400 chars) | No |
-| embedding_model | | | No |
-| embedding_model_provider | | | No |
-| external_knowledge_api_id | | | No |
-| external_knowledge_id | | | No |
-| indexing_technique | | | No |
+| embedding_model | string | | No |
+| embedding_model_provider | string | | No |
+| external_knowledge_api_id | string | | No |
+| external_knowledge_id | string | | No |
+| indexing_technique | string | *Enum:* `"economy"`, `"high_quality"` | No |
| name | string | | Yes |
-| permission | | | No |
+| permission | [DatasetPermissionEnum](#datasetpermissionenum) | | No |
| provider | string | | No |
-| retrieval_model | | | No |
-| summary_index_setting | | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
+| summary_index_setting | object | | No |
#### DatasetListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| include_all | boolean | Include all datasets | No |
-| keyword | | Search keyword | No |
+| keyword | string | Search keyword | No |
| limit | integer | Number of items per page | No |
| page | integer | Page number | No |
| tag_ids | [ string ] | Filter by tag IDs | No |
@@ -2314,23 +2314,23 @@ Condition detail
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| description | | Dataset description (max 400 chars) | No |
-| embedding_model | | | No |
-| embedding_model_provider | | | No |
-| external_knowledge_api_id | | | No |
-| external_knowledge_id | | | No |
-| external_retrieval_model | | | No |
-| indexing_technique | | | No |
-| name | | | No |
-| partial_member_list | | | No |
-| permission | | | No |
-| retrieval_model | | | No |
+| description | string | Dataset description (max 400 chars) | No |
+| embedding_model | string | | No |
+| embedding_model_provider | string | | No |
+| external_knowledge_api_id | string | | No |
+| external_knowledge_id | string | | No |
+| external_retrieval_model | object | | No |
+| indexing_technique | string | *Enum:* `"economy"`, `"high_quality"` | No |
+| name | string | | No |
+| partial_member_list | [ object ] | | No |
+| permission | [DatasetPermissionEnum](#datasetpermissionenum) | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
#### DatasourceNodeRunPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| credential_id | | | No |
+| credential_id | string | | No |
| datasource_type | string | | Yes |
| inputs | object | | Yes |
| is_published | boolean | | Yes |
@@ -2347,10 +2347,10 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword | | Search keyword | No |
+| keyword | string | Search keyword | No |
| limit | integer | Number of items per page | No |
| page | integer | Page number | No |
-| status | | Document status filter | No |
+| status | string | Document status filter | No |
#### DocumentMetadataOperation
@@ -2366,13 +2366,13 @@ Request payload for bulk downloading documents as a zip archive.
| ---- | ---- | ----------- | -------- |
| doc_form | string | | No |
| doc_language | string | | No |
-| embedding_model | | | No |
-| embedding_model_provider | | | No |
-| indexing_technique | | | No |
+| embedding_model | string | | No |
+| embedding_model_provider | string | | No |
+| indexing_technique | string | | No |
| name | string | | Yes |
-| original_document_id | | | No |
-| process_rule | | | No |
-| retrieval_model | | | No |
+| original_document_id | string | | No |
+| process_rule | [ProcessRule](#processrule) | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
| text | string | | Yes |
#### DocumentTextUpdate
@@ -2381,10 +2381,10 @@ Request payload for bulk downloading documents as a zip archive.
| ---- | ---- | ----------- | -------- |
| doc_form | string | | No |
| doc_language | string | | No |
-| name | | | No |
-| process_rule | | | No |
-| retrieval_model | | | No |
-| text | | | No |
+| name | string | | No |
+| process_rule | [ProcessRule](#processrule) | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
+| text | string | | No |
#### FeedbackListQuery
@@ -2403,29 +2403,29 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| extension | | | No |
-| file_key | | | No |
+| conversation_id | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| extension | string | | No |
+| file_key | string | | No |
| id | string | | Yes |
-| mime_type | | | No |
+| mime_type | string | | No |
| name | string | | Yes |
-| original_url | | | No |
-| preview_url | | | No |
+| original_url | string | | No |
+| preview_url | string | | No |
| size | integer | | Yes |
-| source_url | | | No |
-| tenant_id | | | No |
-| user_id | | | No |
+| source_url | string | | No |
+| tenant_id | string | | No |
+| user_id | string | | No |
#### HitTestingPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| attachment_ids | | | No |
-| external_retrieval_model | | | No |
+| attachment_ids | [ string ] | | No |
+| external_retrieval_model | object | | No |
| query | string | | Yes |
-| retrieval_model | | | No |
+| retrieval_model | [RetrievalModel](#retrievalmodel) | | No |
#### HumanInputFormSubmitPayload
@@ -2444,15 +2444,15 @@ Request payload for bulk downloading documents as a zip archive.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| rating | | | No |
+| content | string | | No |
+| rating | string | *Enum:* `"dislike"`, `"like"` | No |
#### MessageListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation UUID | Yes |
-| first_id | | First message ID for pagination | No |
+| first_id | string | First message ID for pagination | No |
| limit | integer | Number of messages to return (1-100) | No |
#### MetadataArgs
@@ -2476,8 +2476,8 @@ Metadata Filtering Condition.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conditions | | | No |
-| logical_operator | | | No |
+| conditions | [ [Condition](#condition) ] | | No |
+| logical_operator | string | *Enum:* `"and"`, `"or"` | No |
#### MetadataOperationData
@@ -2516,14 +2516,14 @@ Metadata operation data
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| mode | string | *Enum:* `"automatic"`, `"custom"`, `"hierarchical"` | Yes |
-| rules | | | No |
+| rules | [Rule](#rule) | | No |
#### RerankingModel
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| reranking_model_name | | | No |
-| reranking_provider_name | | | No |
+| reranking_model_name | string | | No |
+| reranking_provider_name | string | | No |
#### RetrievalMethod
@@ -2535,49 +2535,49 @@ Metadata operation data
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| metadata_filtering_conditions | | | No |
+| metadata_filtering_conditions | [MetadataFilteringCondition](#metadatafilteringcondition) | | No |
| reranking_enable | boolean | | Yes |
-| reranking_mode | | | No |
-| reranking_model | | | No |
-| score_threshold | | | No |
+| reranking_mode | string | | No |
+| reranking_model | [RerankingModel](#rerankingmodel) | | No |
+| score_threshold | number | | No |
| score_threshold_enabled | boolean | | Yes |
| search_method | [RetrievalMethod](#retrievalmethod) | | Yes |
| top_k | integer | | Yes |
-| weights | | | No |
+| weights | [WeightModel](#weightmodel) | | No |
#### Rule
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| parent_mode | | | No |
-| pre_processing_rules | | | No |
-| segmentation | | | No |
-| subchunk_segmentation | | | No |
+| parent_mode | string | *Enum:* `"full-doc"`, `"paragraph"` | No |
+| pre_processing_rules | [ [PreProcessingRule](#preprocessingrule) ] | | No |
+| segmentation | [Segmentation](#segmentation) | | No |
+| subchunk_segmentation | [Segmentation](#segmentation) | | No |
#### SegmentCreatePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| segments | | | No |
+| segments | [ object ] | | No |
#### SegmentListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword | | | No |
+| keyword | string | | No |
| status | [ string ] | | No |
#### SegmentUpdateArgs
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| answer | | | No |
-| attachment_ids | | | No |
-| content | | | No |
-| enabled | | | No |
-| keywords | | | No |
+| answer | string | | No |
+| attachment_ids | [ string ] | | No |
+| content | string | | No |
+| enabled | boolean | | No |
+| keywords | [ string ] | | No |
| regenerate_child_chunks | boolean | | No |
-| summary | | | No |
+| summary | string | | No |
#### SegmentUpdatePayload
@@ -2607,7 +2607,7 @@ Metadata operation data
| ---- | ---- | ----------- | -------- |
| id | string | | Yes |
| is_anonymous | boolean | | Yes |
-| session_id | | | No |
+| session_id | string | | No |
| type | string | | Yes |
#### TagBindingPayload
@@ -2635,7 +2635,7 @@ Accept the legacy single-tag Service API payload while exposing a normalized tag
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| tag_id | | | No |
+| tag_id | string | | No |
| tag_ids | [ string ] | | No |
| target_id | string | | Yes |
@@ -2650,10 +2650,10 @@ Accept the legacy single-tag Service API payload while exposing a normalized tag
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| message_id | | Message ID | No |
-| streaming | | Enable streaming response | No |
-| text | | Text to convert to audio | No |
-| voice | | Voice to use for TTS | No |
+| message_id | string | Message ID | No |
+| streaming | boolean | Enable streaming response | No |
+| text | string | Text to convert to audio | No |
+| voice | string | Voice to use for TTS | No |
#### WeightKeywordSetting
@@ -2665,9 +2665,9 @@ Accept the legacy single-tag Service API payload while exposing a normalized tag
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| keyword_setting | | | No |
-| vector_setting | | | No |
-| weight_type | | | No |
+| keyword_setting | [WeightKeywordSetting](#weightkeywordsetting) | | No |
+| vector_setting | [WeightVectorSetting](#weightvectorsetting) | | No |
+| weight_type | string | *Enum:* `"customized"`, `"keyword_first"`, `"semantic_first"` | No |
#### WeightVectorSetting
@@ -2691,64 +2691,64 @@ Accept the legacy single-tag Service API payload while exposing a normalized tag
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by_account | | | No |
-| created_by_end_user | | | No |
-| created_by_role | | | No |
-| created_from | | | No |
+| created_at | integer | | No |
+| created_by_account | [SimpleAccount](#simpleaccount) | | No |
+| created_by_end_user | [SimpleEndUser](#simpleenduser) | | No |
+| created_by_role | string | | No |
+| created_from | string | | No |
| details | | | No |
| id | string | | Yes |
-| workflow_run | | | No |
+| workflow_run | [WorkflowRunForLogResponse](#workflowrunforlogresponse) | | No |
#### WorkflowLogQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at__after | | | No |
-| created_at__before | | | No |
-| created_by_account | | | No |
-| created_by_end_user_session_id | | | No |
-| keyword | | | No |
+| created_at__after | string | | No |
+| created_at__before | string | | No |
+| created_by_account | string | | No |
+| created_by_end_user_session_id | string | | No |
+| keyword | string | | No |
| limit | integer | | No |
| page | integer | | No |
-| status | | | No |
+| status | string | *Enum:* `"failed"`, `"stopped"`, `"succeeded"` | No |
#### WorkflowRunForLogResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| elapsed_time | | | No |
-| error | | | No |
-| exceptions_count | | | No |
-| finished_at | | | No |
+| error | string | | No |
+| exceptions_count | integer | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
-| status | | | No |
-| total_steps | | | No |
-| total_tokens | | | No |
-| triggered_from | | | No |
-| version | | | No |
+| status | string | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
+| triggered_from | string | | No |
+| version | string | | No |
#### WorkflowRunPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
-| response_mode | | | No |
+| response_mode | string | *Enum:* `"blocking"`, `"streaming"` | No |
#### WorkflowRunResponse
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
+| created_at | integer | | No |
| elapsed_time | | | No |
-| error | | | No |
-| finished_at | | | No |
+| error | string | | No |
+| finished_at | integer | | No |
| id | string | | Yes |
| inputs | | | No |
| outputs | object | | No |
| status | string | | Yes |
-| total_steps | | | No |
-| total_tokens | | | No |
+| total_steps | integer | | No |
+| total_tokens | integer | | No |
| workflow_id | string | | Yes |
diff --git a/api/openapi/markdown/web-swagger.md b/api/openapi/markdown/web-swagger.md
index c9b3b31357..f8745d3135 100644
--- a/api/openapi/markdown/web-swagger.md
+++ b/api/openapi/markdown/web-swagger.md
@@ -1042,38 +1042,38 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| appCode | | Application code | No |
-| appId | | Application ID | No |
+| appCode | string | Application code | No |
+| appId | string | Application ID | No |
#### ChatMessagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | Conversation ID | No |
-| files | | Files to be processed | No |
+| conversation_id | string | Conversation ID | No |
+| files | [ object ] | Files to be processed | No |
| inputs | object | Input variables for the chat | Yes |
-| parent_message_id | | Parent message ID | No |
+| parent_message_id | string | Parent message ID | No |
| query | string | User query/message | Yes |
-| response_mode | | Response mode: blocking or streaming | No |
+| response_mode | string | Response mode: blocking or streaming
*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | Source of retriever | No |
#### CompletionMessagePayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | Files to be processed | No |
+| files | [ object ] | Files to be processed | No |
| inputs | object | Input variables for the completion | Yes |
| query | string | Query text for completion | No |
-| response_mode | | Response mode: blocking or streaming | No |
+| response_mode | string | Response mode: blocking or streaming
*Enum:* `"blocking"`, `"streaming"` | No |
| retriever_from | string | Source of retriever | No |
#### ConversationListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | | No |
+| last_id | string | | No |
| limit | integer | | No |
-| pinned | | | No |
+| pinned | boolean | | No |
| sort_by | string | *Enum:* `"-created_at"`, `"-updated_at"`, `"created_at"`, `"updated_at"` | No |
#### ConversationRenamePayload
@@ -1081,14 +1081,14 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| auto_generate | boolean | | No |
-| name | | | No |
+| name | string | | No |
#### EmailCodeLoginSendPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| language | | | No |
+| language | string | | No |
#### EmailCodeLoginVerifyPayload
@@ -1102,33 +1102,33 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| conversation_id | | | No |
-| created_at | | | No |
-| created_by | | | No |
-| extension | | | No |
-| file_key | | | No |
+| conversation_id | string | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| extension | string | | No |
+| file_key | string | | No |
| id | string | | Yes |
-| mime_type | | | No |
+| mime_type | string | | No |
| name | string | | Yes |
-| original_url | | | No |
-| preview_url | | | No |
+| original_url | string | | No |
+| preview_url | string | | No |
| size | integer | | Yes |
-| source_url | | | No |
-| tenant_id | | | No |
-| user_id | | | No |
+| source_url | string | | No |
+| tenant_id | string | | No |
+| user_id | string | | No |
#### FileWithSignedUrl
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| created_at | | | No |
-| created_by | | | No |
-| extension | | | No |
+| created_at | integer | | No |
+| created_by | string | | No |
+| extension | string | | No |
| id | string | | Yes |
-| mime_type | | | No |
+| mime_type | string | | No |
| name | string | | Yes |
| size | integer | | Yes |
-| url | | | No |
+| url | string | | No |
#### ForgotPasswordCheckPayload
@@ -1151,7 +1151,7 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| email | string | | Yes |
-| language | | | No |
+| language | string | | No |
#### LoginPayload
@@ -1164,15 +1164,15 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| content | | | No |
-| rating | | | No |
+| content | string | | No |
+| rating | string | *Enum:* `"dislike"`, `"like"` | No |
#### MessageListQuery
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
| conversation_id | string | Conversation UUID | Yes |
-| first_id | | First message ID for pagination | No |
+| first_id | string | First message ID for pagination | No |
| limit | integer | Number of messages to return (1-100) | No |
#### MessageMoreLikeThisQuery
@@ -1204,21 +1204,21 @@ Returns Server-Sent Events stream.
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| last_id | | | No |
+| last_id | string | | No |
| limit | integer | | No |
#### TextToAudioPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| message_id | | Message ID | No |
-| streaming | | Enable streaming response | No |
-| text | | Text to convert to audio | No |
-| voice | | Voice to use for TTS | No |
+| message_id | string | Message ID | No |
+| streaming | boolean | Enable streaming response | No |
+| text | string | Text to convert to audio | No |
+| voice | string | Voice to use for TTS | No |
#### WorkflowRunPayload
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
-| files | | | No |
+| files | [ object ] | | No |
| inputs | object | | Yes |
diff --git a/api/tests/unit_tests/controllers/common/test_schema.py b/api/tests/unit_tests/controllers/common/test_schema.py
index 7cabafba0e..14b0833dcf 100644
--- a/api/tests/unit_tests/controllers/common/test_schema.py
+++ b/api/tests/unit_tests/controllers/common/test_schema.py
@@ -47,6 +47,13 @@ class QueryModel(BaseModel):
ambiguous: int | str | None = Field(default=None, description="Ambiguous query parameter")
+class NullableSchemaModel(BaseModel):
+ name: str | None = None
+ tags: list[str] | None = None
+ owner: UserModel | None = None
+ ambiguous: int | str | None = None
+
+
class ResponseAliasModel(BaseModel):
public_name: str = Field(validation_alias="internal_name")
@@ -164,6 +171,27 @@ def test_register_response_schema_model_uses_serialized_field_names():
assert "internal_name" not in schema["properties"]
+def test_register_schema_model_flattens_simple_nullable_any_of_for_swagger_2():
+ from controllers.common.schema import register_schema_model
+
+ namespace = MagicMock(spec=Namespace)
+
+ register_schema_model(namespace, NullableSchemaModel)
+
+ called_schemas = {call.args[0]: call.args[1] for call in namespace.schema_model.call_args_list}
+ properties = called_schemas["NullableSchemaModel"]["properties"]
+
+ assert properties["name"]["type"] == "string"
+ assert properties["name"]["x-nullable"] is True
+ assert "anyOf" not in properties["name"]
+ assert properties["tags"]["type"] == "array"
+ assert properties["tags"]["items"] == {"type": "string"}
+ assert properties["tags"]["x-nullable"] is True
+ assert properties["owner"]["$ref"] == "#/definitions/UserModel"
+ assert properties["owner"]["x-nullable"] is True
+ assert "anyOf" in properties["ambiguous"]
+
+
def test_get_or_create_model_returns_existing_model(mock_console_ns):
from controllers.common.schema import get_or_create_model