opensource/dify
2
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-06-22 19:21:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: improve Service API OpenAPI contracts (#37592)

Browse Source 
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
This commit is contained in:
Stephen Zhou 2026-06-17 22:25:30 +08:00 committed by GitHub
parent 9021b3f5be
commit baf775134e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
51 changed files with 2778 additions and 1369 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
api/controllers/common/controller_schemas.py
View File

@ -1,7 +1,8 @@
from typing import Any, Literal
from copy import deepcopy
from typing import Any, Literal, override
from uuid import UUID
from pydantic import BaseModel, Field, model_validator
from pydantic import BaseModel, Field, GetJsonSchemaHandler, model_validator
from libs.helper import UUIDStrOrEmpty
@ -12,6 +13,45 @@ class ConversationRenamePayload(BaseModel):
name: str | None = None
auto_generate: bool = False
@classmethod
@override
def __get_pydantic_json_schema__(cls, core_schema: Any, handler: GetJsonSchemaHandler) -> dict[str, Any]:
schema = handler.resolve_ref_schema(handler(core_schema))
properties = schema.get("properties")
if not isinstance(properties, dict):
return schema
auto_generate_schema = deepcopy(properties.get("auto_generate", {"type": "boolean"}))
name_schema = deepcopy(properties.get("name", {"type": "string"}))
non_blank_name_schema: dict[str, Any] = {"pattern": r".*\S.*", "type": "string"}
if isinstance(name_schema, dict) and isinstance(name_schema.get("title"), str):
non_blank_name_schema["title"] = name_schema["title"]
auto_generate_true_schema = {**auto_generate_schema, "enum": [True]}
auto_generate_true_schema.pop("default", None)
return {
**schema,
"anyOf": [
{
"properties": {
"auto_generate": auto_generate_true_schema,
"name": name_schema,
},
"required": ["auto_generate"],
"type": "object",
},
{
"properties": {
"auto_generate": {**auto_generate_schema, "enum": [False]},
"name": non_blank_name_schema,
},
"required": ["name"],
"type": "object",
},
],
}
@model_validator(mode="after")
def validate_name_requirement(self):
if not self.auto_generate:

9
api/controllers/service_api/app/annotation.py
View File

@ -45,6 +45,13 @@ class AnnotationJobStatusResponse(ResponseModel):
error_msg: str | None = None
ANNOTATION_REPLY_ACTION_PARAM = {
"description": "Action to perform: 'enable' or 'disable'",
"enum": ["enable", "disable"],
"type": "string",
}
register_schema_models(
service_api_ns,
AnnotationCreatePayload,
@ -61,7 +68,7 @@ class AnnotationReplyActionApi(Resource):
@service_api_ns.expect(service_api_ns.models[AnnotationReplyActionPayload.__name__])
@service_api_ns.doc("annotation_reply_action")
@service_api_ns.doc(description="Enable or disable annotation reply feature")
@service_api_ns.doc(params={"action": "Action to perform: 'enable' or 'disable'"})
@service_api_ns.doc(params={"action": ANNOTATION_REPLY_ACTION_PARAM})
@service_api_ns.doc(
responses={
200: "Action completed successfully",

11
api/controllers/service_api/app/audio.py
View File

@ -20,6 +20,7 @@ from controllers.service_api.app.error import (
ProviderQuotaExceededError,
UnsupportedAudioTypeError,
)
from controllers.service_api.schema import binary_response, expect_with_user, multipart_file_params
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from core.errors.error import ModelCurrentlyNotSupportError, ProviderTokenNotInitError, QuotaExceededError
from graphon.model_runtime.errors.invoke import InvokeError
@ -41,6 +42,7 @@ register_response_schema_models(service_api_ns, AudioBinaryResponse, AudioTransc
class AudioApi(Resource):
@service_api_ns.doc("audio_to_text")
@service_api_ns.doc(description="Convert audio to text using speech-to-text")
@service_api_ns.doc(consumes=["multipart/form-data"], params=multipart_file_params(include_user=True))
@service_api_ns.doc(
responses={
200: "Audio successfully transcribed",
@ -99,7 +101,8 @@ register_schema_model(service_api_ns, TextToAudioPayload)
@service_api_ns.route("/text-to-audio")
class TextApi(Resource):
@service_api_ns.expect(service_api_ns.models[TextToAudioPayload.__name__])
@expect_with_user(service_api_ns, TextToAudioPayload)
@binary_response(service_api_ns, "audio/mpeg")
@service_api_ns.doc("text_to_audio")
@service_api_ns.doc(description="Convert text to audio using text-to-speech")
@service_api_ns.doc(
@ -110,11 +113,7 @@ class TextApi(Resource):
500: "Internal server error",
}
)
@service_api_ns.response(
200,
"Text successfully converted to audio",
service_api_ns.models[AudioBinaryResponse.__name__],
)
@service_api_ns.response(200, "Text successfully converted to audio")
@validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.JSON))
def post(self, app_model: App, end_user: EndUser):
"""Convert text to audio using text-to-speech.

9
api/controllers/service_api/app/completion.py
View File

@ -20,6 +20,7 @@ from controllers.service_api.app.error import (
ProviderNotInitializeError,
ProviderQuotaExceededError,
)
from controllers.service_api.schema import expect_user_json, expect_with_user, json_or_event_stream_response
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from controllers.web.error import InvokeRateLimitError as InvokeRateLimitHttpError
from core.app.entities.app_invoke_entities import InvokeFrom
@ -92,7 +93,8 @@ register_response_schema_models(service_api_ns, GeneratedAppResponse, SimpleResu
@service_api_ns.route("/completion-messages")
class CompletionApi(Resource):
@service_api_ns.expect(service_api_ns.models[CompletionRequestPayload.__name__])
@expect_with_user(service_api_ns, CompletionRequestPayload)
@json_or_event_stream_response(service_api_ns)
@service_api_ns.doc("create_completion")
@service_api_ns.doc(description="Create a completion for the given prompt")
@service_api_ns.doc(
@ -168,6 +170,7 @@ class CompletionApi(Resource):
@service_api_ns.route("/completion-messages/<string:task_id>/stop")
class CompletionStopApi(Resource):
@expect_user_json(service_api_ns)
@service_api_ns.doc("stop_completion")
@service_api_ns.doc(description="Stop a running completion task")
@service_api_ns.doc(params={"task_id": "The ID of the task to stop"})
@ -197,7 +200,8 @@ class CompletionStopApi(Resource):
@service_api_ns.route("/chat-messages")
class ChatApi(Resource):
@service_api_ns.expect(service_api_ns.models[ChatRequestPayload.__name__])
@expect_with_user(service_api_ns, ChatRequestPayload)
@json_or_event_stream_response(service_api_ns)
@service_api_ns.doc("create_chat_message")
@service_api_ns.doc(description="Send a message in a chat conversation")
@service_api_ns.doc(
@ -276,6 +280,7 @@ class ChatApi(Resource):
@service_api_ns.route("/chat-messages/<string:task_id>/stop")
class ChatStopApi(Resource):
@expect_user_json(service_api_ns)
@service_api_ns.doc("stop_chat_message")
@service_api_ns.doc(description="Stop a running chat message generation")
@service_api_ns.doc(params={"task_id": "The ID of the task to stop"})

6
api/controllers/service_api/app/conversation.py
View File

@ -13,6 +13,7 @@ from controllers.common.controller_schemas import ConversationRenamePayload
from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models
from controllers.service_api import service_api_ns
from controllers.service_api.app.error import NotChatAppError
from controllers.service_api.schema import expect_user_json, expect_with_user
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from core.app.entities.app_invoke_entities import InvokeFrom
from extensions.ext_database import db
@ -197,6 +198,7 @@ class ConversationApi(Resource):
@service_api_ns.route("/conversations/<uuid:c_id>")
class ConversationDetailApi(Resource):
@expect_user_json(service_api_ns)
@service_api_ns.doc("delete_conversation")
@service_api_ns.doc(description="Delete a specific conversation")
@service_api_ns.doc(params={"c_id": "Conversation ID"})
@ -225,7 +227,7 @@ class ConversationDetailApi(Resource):
@service_api_ns.route("/conversations/<uuid:c_id>/name")
class ConversationRenameApi(Resource):
@service_api_ns.expect(service_api_ns.models[ConversationRenamePayload.__name__])
@expect_with_user(service_api_ns, ConversationRenamePayload)
@service_api_ns.doc("rename_conversation")
@service_api_ns.doc(description="Rename a conversation or auto-generate a name")
@service_api_ns.doc(params={"c_id": "Conversation ID"})
@ -312,7 +314,7 @@ class ConversationVariablesApi(Resource):
@service_api_ns.route("/conversations/<uuid:c_id>/variables/<uuid:variable_id>")
class ConversationVariableDetailApi(Resource):
@service_api_ns.expect(service_api_ns.models[ConversationVariableUpdatePayload.__name__])
@expect_with_user(service_api_ns, ConversationVariableUpdatePayload)
@service_api_ns.doc("update_conversation_variable")
@service_api_ns.doc(description="Update a conversation variable's value")
@service_api_ns.doc(params={"c_id": "Conversation ID", "variable_id": "Variable ID"})

2
api/controllers/service_api/app/file.py
View File

@ -12,6 +12,7 @@ from controllers.common.errors import (
)
from controllers.common.schema import register_schema_models
from controllers.service_api import service_api_ns
from controllers.service_api.schema import multipart_file_params
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from extensions.ext_database import db
from fields.file_fields import FileResponse
@ -25,6 +26,7 @@ register_schema_models(service_api_ns, FileResponse)
class FileApi(Resource):
@service_api_ns.doc("upload_file")
@service_api_ns.doc(description="Upload a file for use in conversations")
@service_api_ns.doc(consumes=["multipart/form-data"], params=multipart_file_params(include_user=True))
@service_api_ns.doc(
responses={
201: "File uploaded successfully",

28
api/controllers/service_api/app/file_preview.py
View File

@ -15,6 +15,7 @@ from controllers.service_api.app.error import (
FileAccessDeniedError,
FileNotFoundError,
)
from controllers.service_api.schema import binary_response
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from extensions.ext_database import db
from extensions.ext_storage import storage
@ -30,6 +31,26 @@ class FilePreviewQuery(BaseModel):
register_schema_model(service_api_ns, FilePreviewQuery)
register_response_schema_model(service_api_ns, BinaryFileResponse)
FILE_PREVIEW_RESPONSE_MEDIA_TYPES = [
"application/octet-stream",
"application/pdf",
"audio/aac",
"audio/flac",
"audio/mp4",
"audio/mpeg",
"audio/ogg",
"audio/wav",
"audio/x-m4a",
"image/gif",
"image/jpeg",
"image/png",
"image/webp",
"text/plain",
"video/mp4",
"video/quicktime",
"video/webm",
]
@service_api_ns.route("/files/<uuid:file_id>/preview")
class FilePreviewApi(Resource):
@ -41,6 +62,7 @@ class FilePreviewApi(Resource):
"""
@service_api_ns.doc(params=query_params_from_model(FilePreviewQuery))
@binary_response(service_api_ns, FILE_PREVIEW_RESPONSE_MEDIA_TYPES)
@service_api_ns.doc("preview_file")
@service_api_ns.doc(description="Preview or download a file uploaded via Service API")
@service_api_ns.doc(params={"file_id": "UUID of the file to preview"})
@ -52,11 +74,7 @@ class FilePreviewApi(Resource):
404: "File not found",
}
)
@service_api_ns.response(
200,
"File retrieved successfully",
service_api_ns.models[BinaryFileResponse.__name__],
)
@service_api_ns.response(200, "File retrieved successfully")
@validate_app_token(fetch_user_arg=FetchUserArg(fetch_from=WhereisUserArg.QUERY))
def get(self, app_model: App, end_user: EndUser, file_id: UUID):
"""

3
api/controllers/service_api/app/human_input_form.py
View File

@ -18,6 +18,7 @@ from werkzeug.exceptions import BadRequest, NotFound
from controllers.common.human_input import HumanInputFormSubmitPayload, stringify_form_default_values
from controllers.common.schema import register_response_schema_models, register_schema_models
from controllers.service_api import service_api_ns
from controllers.service_api.schema import expect_with_user
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from core.workflow.human_input_policy import HumanInputSurface, is_recipient_type_allowed_for_surface
from extensions.ext_database import db
@ -101,7 +102,7 @@ class WorkflowHumanInputFormApi(Resource):
inputs = service.resolve_form_inputs(form)
return _jsonify_form_definition(form, inputs=inputs)
@service_api_ns.expect(service_api_ns.models[HumanInputFormSubmitPayload.__name__])
@expect_with_user(service_api_ns, HumanInputFormSubmitPayload)
@service_api_ns.doc("submit_human_input_form")
@service_api_ns.doc(description="Submit a paused human input form by token")
@service_api_ns.doc(params={"form_token": "Human input form token"})

3
api/controllers/service_api/app/message.py
View File

@ -12,6 +12,7 @@ from controllers.common.fields import SimpleResultStringListResponse
from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models
from controllers.service_api import service_api_ns
from controllers.service_api.app.error import NotChatAppError
from controllers.service_api.schema import expect_with_user
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from core.app.entities.app_invoke_entities import InvokeFrom
from fields.base import ResponseModel
@ -112,7 +113,7 @@ class MessageListApi(Resource):
@service_api_ns.route("/messages/<uuid:message_id>/feedbacks")
class MessageFeedbackApi(Resource):
@service_api_ns.expect(service_api_ns.models[MessageFeedbackPayload.__name__])
@expect_with_user(service_api_ns, MessageFeedbackPayload)
@service_api_ns.response(200, "Feedback submitted successfully", service_api_ns.models[ResultResponse.__name__])
@service_api_ns.doc("create_message_feedback")
@service_api_ns.doc(description="Submit feedback for a message")

12
api/controllers/service_api/app/workflow.py
View File

@ -21,6 +21,11 @@ from controllers.service_api.app.error import (
ProviderNotInitializeError,
ProviderQuotaExceededError,
)
from controllers.service_api.schema import (
expect_user_json,
expect_with_user,
json_or_event_stream_response,
)
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from controllers.web.error import InvokeRateLimitError as InvokeRateLimitHttpError
from core.app.apps.base_app_queue_manager import AppQueueManager
@ -249,7 +254,8 @@ class WorkflowRunDetailApi(Resource):
@service_api_ns.route("/workflows/run")
class WorkflowRunApi(Resource):
@service_api_ns.expect(service_api_ns.models[WorkflowRunPayload.__name__])
@expect_with_user(service_api_ns, WorkflowRunPayload)
@json_or_event_stream_response(service_api_ns)
@service_api_ns.doc("run_workflow")
@service_api_ns.doc(description="Execute a workflow")
@service_api_ns.doc(
@ -313,7 +319,8 @@ class WorkflowRunApi(Resource):
@service_api_ns.route("/workflows/<string:workflow_id>/run")
class WorkflowRunByIdApi(Resource):
@service_api_ns.expect(service_api_ns.models[WorkflowRunPayload.__name__])
@expect_with_user(service_api_ns, WorkflowRunPayload)
@json_or_event_stream_response(service_api_ns)
@service_api_ns.doc("run_workflow_by_id")
@service_api_ns.doc(description="Execute a specific workflow by ID")
@service_api_ns.doc(params={"workflow_id": "Workflow ID to execute"})
@ -387,6 +394,7 @@ class WorkflowRunByIdApi(Resource):
@service_api_ns.route("/workflows/tasks/<string:task_id>/stop")
class WorkflowTaskStopApi(Resource):
@expect_user_json(service_api_ns)
@service_api_ns.doc("stop_workflow_task")
@service_api_ns.doc(description="Stop a running workflow task")
@service_api_ns.doc(params={"task_id": "Task ID to stop"})

2
api/controllers/service_api/app/workflow_events.py
View File

@ -15,6 +15,7 @@ from controllers.common.fields import EventStreamResponse
from controllers.common.schema import query_params_from_model, register_response_schema_model, register_schema_models
from controllers.service_api import service_api_ns
from controllers.service_api.app.error import NotWorkflowAppError
from controllers.service_api.schema import event_stream_response
from controllers.service_api.wraps import FetchUserArg, WhereisUserArg, validate_app_token
from core.app.apps.advanced_chat.app_generator import AdvancedChatAppGenerator
from core.app.apps.base_app_generator import BaseAppGenerator
@ -44,6 +45,7 @@ register_response_schema_model(service_api_ns, EventStreamResponse)
class WorkflowEventsApi(Resource):
"""Service API for getting workflow execution events after resume."""
@event_stream_response(service_api_ns)
@service_api_ns.doc("get_workflow_events")
@service_api_ns.doc(description="Get workflow execution events stream after resume")
@service_api_ns.doc(params={"task_id": "Workflow run ID"})

52
api/controllers/service_api/dataset/dataset.py
View File

@ -1,8 +1,8 @@
from typing import Any, Literal
from typing import Any, Literal, override
from uuid import UUID
from flask import request
from pydantic import BaseModel, ConfigDict, Field, RootModel, field_validator, model_validator
from pydantic import BaseModel, ConfigDict, Field, GetJsonSchemaHandler, RootModel, field_validator, model_validator
from werkzeug.exceptions import Forbidden, NotFound
import services
@ -79,6 +79,13 @@ class DocumentStatusPayload(BaseModel):
document_ids: list[str] = Field(default_factory=list, description="Document IDs to update")
DOCUMENT_STATUS_ACTION_PARAM = {
"description": "Action to perform: 'enable', 'disable', 'archive', or 'un_archive'",
"enum": ["enable", "disable", "archive", "un_archive"],
"type": "string",
}
class TagNamePayload(BaseModel):
name: str = Field(..., min_length=1, max_length=50)
@ -114,6 +121,45 @@ class TagUnbindingPayload(BaseModel):
tag_id: str | None = None
target_id: str
@classmethod
@override
def __get_pydantic_json_schema__(cls, _core_schema: object, _handler: GetJsonSchemaHandler) -> dict[str, object]:
tag_id_property = {
"description": "Legacy single tag ID accepted by the Service API.",
"type": "string",
}
tag_ids_property = {
"description": "Tag IDs to unbind. Use this for new integrations.",
"items": {"type": "string"},
"minItems": 1,
"type": "array",
}
target_id_property = {"title": "Target Id", "type": "string"}
return {
"anyOf": [
{
"properties": {
"tag_id": tag_id_property,
"tag_ids": tag_ids_property,
"target_id": target_id_property,
},
"required": ["tag_id", "target_id"],
"type": "object",
},
{
"properties": {
"tag_id": {**tag_id_property, "nullable": True},
"tag_ids": tag_ids_property,
"target_id": target_id_property,
},
"required": ["tag_ids", "target_id"],
"type": "object",
},
],
"description": "Accepts either the legacy tag_id payload or the normalized tag_ids payload.",
"title": cls.__name__,
}
@model_validator(mode="before")
@classmethod
def normalize_legacy_tag_id(cls, data: object) -> object:
@ -529,7 +575,7 @@ class DocumentStatusApi(DatasetApiResource):
@service_api_ns.doc(
params={
"dataset_id": "Dataset ID",
"action": "Action to perform: 'enable', 'disable', 'archive', or 'un_archive'",
"action": DOCUMENT_STATUS_ACTION_PARAM,
}
)
@service_api_ns.doc(

72
api/controllers/service_api/dataset/document.py
View File

@ -8,11 +8,12 @@ deprecated in generated API docs so clients migrate toward the canonical paths.
import json
from collections.abc import Mapping
from contextlib import ExitStack
from typing import Any, Literal, Self
from copy import deepcopy
from typing import Any, Literal, Self, override
from uuid import UUID
from flask import request, send_file
from pydantic import BaseModel, Field, field_validator, model_validator
from pydantic import BaseModel, Field, GetJsonSchemaHandler, field_validator, model_validator
from sqlalchemy import desc, func, select
from werkzeug.exceptions import Forbidden, NotFound
@ -39,6 +40,7 @@ from controllers.service_api.dataset.error import (
DocumentIndexingError,
InvalidMetadataError,
)
from controllers.service_api.schema import binary_response
from controllers.service_api.wraps import (
DatasetApiResource,
cloud_edition_billing_rate_limit_check,
@ -104,6 +106,36 @@ class DocumentTextUpdate(BaseModel):
raise ValueError("Invalid doc_form.")
return value
@classmethod
@override
def __get_pydantic_json_schema__(cls, core_schema: Any, handler: GetJsonSchemaHandler) -> dict[str, Any]:
schema = handler.resolve_ref_schema(handler(core_schema))
properties = schema.get("properties")
if not isinstance(properties, dict):
return schema
text_branch_properties = deepcopy(properties)
text_branch_properties["text"] = _non_null_property_schema(properties.get("text"))
text_branch_properties["name"] = _non_null_property_schema(properties.get("name"))
no_text_branch_properties = deepcopy(properties)
no_text_branch_properties["text"] = {"type": "null"}
return {
**schema,
"anyOf": [
{
"properties": text_branch_properties,
"required": ["name", "text"],
"type": "object",
},
{
"properties": no_text_branch_properties,
"type": "object",
},
],
}
@model_validator(mode="after")
def check_text_and_name(self) -> Self:
if self.text is not None and self.name is None:
@ -111,6 +143,24 @@ class DocumentTextUpdate(BaseModel):
return self
def _non_null_property_schema(property_schema: object) -> dict[str, Any]:
if not isinstance(property_schema, dict):
return {}
any_of = property_schema.get("anyOf")
if isinstance(any_of, list):
non_null_candidates = [
candidate for candidate in any_of if isinstance(candidate, dict) and candidate.get("type") != "null"
]
if len(non_null_candidates) == 1:
return {
**{key: value for key, value in property_schema.items() if key != "anyOf"},
**deepcopy(non_null_candidates[0]),
}
return deepcopy(property_schema)
class DocumentListQuery(BaseModel):
page: int = Field(default=1, description="Page number")
limit: int = Field(default=20, description="Number of items per page")
@ -463,8 +513,17 @@ class DeprecatedDocumentUpdateByTextApi(DatasetApiResource):
@service_api_ns.route(
"/datasets/<uuid:dataset_id>/document/create_by_file",
"/datasets/<uuid:dataset_id>/document/create-by-file",
doc={
"post": {
"deprecated": True,
"description": (
"Deprecated legacy alias for creating a new document by uploading a file. "
"Use /datasets/{dataset_id}/document/create-by-file instead."
),
}
},
)
@service_api_ns.route("/datasets/<uuid:dataset_id>/document/create-by-file")
class DocumentAddByFileApi(DatasetApiResource):
"""Resource for documents."""
@ -746,6 +805,7 @@ class DocumentListApi(DatasetApiResource):
class DocumentBatchDownloadZipApi(DatasetApiResource):
"""Download multiple uploaded-file documents as a single ZIP archive."""
@binary_response(service_api_ns, "application/zip")
@service_api_ns.expect(service_api_ns.models[DocumentBatchDownloadZipPayload.__name__])
@service_api_ns.doc("download_documents_as_zip")
@service_api_ns.doc(description="Download selected uploaded documents as a single ZIP archive")
@ -758,11 +818,7 @@ class DocumentBatchDownloadZipApi(DatasetApiResource):
404: "Document or dataset not found",
}
)
@service_api_ns.response(
200,
"ZIP archive generated successfully",
service_api_ns.models[BinaryFileResponse.__name__],
)
@service_api_ns.response(200, "ZIP archive generated successfully")
@cloud_edition_billing_rate_limit_check("knowledge", "dataset")
def post(self, tenant_id, dataset_id: UUID):
payload = DocumentBatchDownloadZipPayload.model_validate(service_api_ns.payload or {})

8
api/controllers/service_api/dataset/metadata.py
View File

@ -24,6 +24,12 @@ from services.entities.knowledge_entities.knowledge_entities import (
)
from services.metadata_service import MetadataService
BUILT_IN_METADATA_ACTION_PARAM = {
"description": "Action to perform: 'enable' or 'disable'",
"enum": ["enable", "disable"],
"type": "string",
}
register_schema_model(service_api_ns, MetadataUpdatePayload)
register_schema_models(
service_api_ns,
@ -175,7 +181,7 @@ class DatasetMetadataBuiltInFieldServiceApi(DatasetApiResource):
class DatasetMetadataBuiltInFieldActionServiceApi(DatasetApiResource):
@service_api_ns.doc("toggle_built_in_field")
@service_api_ns.doc(description="Enable or disable built-in metadata field")
@service_api_ns.doc(params={"dataset_id": "Dataset ID", "action": "Action to perform: 'enable' or 'disable'"})
@service_api_ns.doc(params={"dataset_id": "Dataset ID", "action": BUILT_IN_METADATA_ACTION_PARAM})
@service_api_ns.doc(
responses={
200: "Action completed successfully",

8
api/controllers/service_api/dataset/rag_pipeline/rag_pipeline_workflow.py
View File

@ -19,6 +19,11 @@ from controllers.common.schema import (
from controllers.service_api import service_api_ns
from controllers.service_api.dataset.error import PipelineRunError
from controllers.service_api.dataset.rag_pipeline.serializers import serialize_upload_file
from controllers.service_api.schema import (
event_stream_response,
json_or_event_stream_response,
multipart_file_params,
)
from controllers.service_api.wraps import DatasetApiResource
from core.app.apps.pipeline.pipeline_generator import PipelineGenerator
from core.app.entities.app_invoke_entities import InvokeFrom
@ -137,6 +142,7 @@ class DatasourcePluginsApi(DatasetApiResource):
class DatasourceNodeRunApi(DatasetApiResource):
"""Resource for datasource node run."""
@event_stream_response(service_api_ns)
@service_api_ns.doc(shortcut="pipeline_datasource_node_run")
@service_api_ns.doc(description="Run a datasource node for a rag pipeline")
@service_api_ns.doc(
@ -195,6 +201,7 @@ class DatasourceNodeRunApi(DatasetApiResource):
class PipelineRunApi(DatasetApiResource):
"""Resource for datasource node run."""
@json_or_event_stream_response(service_api_ns)
@service_api_ns.doc(shortcut="pipeline_datasource_node_run")
@service_api_ns.doc(description="Run a datasource node for a rag pipeline")
@service_api_ns.doc(
@ -250,6 +257,7 @@ class KnowledgebasePipelineFileUploadApi(DatasetApiResource):
@service_api_ns.doc(shortcut="knowledgebase_pipeline_file_upload")
@service_api_ns.doc(description="Upload a file to a knowledgebase pipeline")
@service_api_ns.doc(consumes=["multipart/form-data"], params=multipart_file_params(include_user=False))
@service_api_ns.doc(
responses={
201: "File uploaded successfully",

113
api/controllers/service_api/schema.py Normal file
View File

@ -0,0 +1,113 @@
"""Service API OpenAPI documentation helpers.
These helpers keep documentation-only request shapes next to controller
definitions without changing the Pydantic models used for runtime validation.
"""
from __future__ import annotations
from collections.abc import Sequence
from copy import deepcopy
from typing import cast
from flask_restx import Namespace
from pydantic import BaseModel
USER_PROPERTY_SCHEMA: dict[str, object] = {"description": "End user identifier", "type": "string"}
USER_QUERY_PARAM: dict[str, object] = {"description": "End user identifier", "in": "query", "type": "string"}
USER_FORM_PARAM: dict[str, object] = {"description": "End user identifier", "in": "formData", "type": "string"}
FILE_FORM_PARAM: dict[str, object] = {"in": "formData", "required": True, "type": "file"}
USER_FETCH_FROM_ATTR = "_dify_service_api_user_fetch_from"
USER_REQUIRED_ATTR = "_dify_service_api_user_required"
JSON_USER_FETCH_FROM = "JSON"
def expect_with_user(namespace: Namespace, model: type[BaseModel]):
"""Document a JSON request body as ``model`` plus Service API ``user``."""
source_model = namespace.models[model.__name__]
model_name = f"{model.__name__}WithUser"
def decorator(view_func):
required = _json_user_required(view_func)
schema = cast(dict[str, object], deepcopy(source_model.__schema__))
_add_user_property(schema, required=required)
if model_name not in namespace.models:
namespace.schema_model(model_name, schema)
return namespace.expect(namespace.models[model_name], validate=False)(view_func)
return decorator
def expect_user_json(namespace: Namespace):
"""Document a JSON request body that only carries the Service API ``user``."""
def decorator(view_func):
required = _json_user_required(view_func)
schema: dict[str, object] = {"properties": {}, "title": "ServiceApiUserPayload", "type": "object"}
_add_user_property(schema, required=required)
model_name = "RequiredServiceApiUserPayload" if required else "OptionalServiceApiUserPayload"
if model_name not in namespace.models:
namespace.schema_model(model_name, schema)
return namespace.expect(namespace.models[model_name], validate=False)(view_func)
return decorator
def multipart_file_params(*, include_user: bool) -> dict[str, dict[str, object]]:
params: dict[str, dict[str, object]] = {"file": FILE_FORM_PARAM}
if include_user:
params["user"] = USER_FORM_PARAM
return deepcopy(params)
def json_or_event_stream_response(namespace: Namespace):
return namespace.doc(produces=["application/json", "text/event-stream"])
def event_stream_response(namespace: Namespace):
return namespace.doc(produces=["text/event-stream"])
def binary_response(namespace: Namespace, media_type: str | Sequence[str]):
media_types = [media_type] if isinstance(media_type, str) else list(media_type)
return namespace.doc(produces=media_types)
def _json_user_required(view_func) -> bool:
fetch_from = getattr(view_func, USER_FETCH_FROM_ATTR, None)
if fetch_from != JSON_USER_FETCH_FROM:
raise ValueError("JSON user documentation must match validate_app_token(fetch_user_arg=WhereisUserArg.JSON)")
return bool(getattr(view_func, USER_REQUIRED_ATTR, False))
def _add_user_property(schema: dict[str, object], *, required: bool) -> None:
variants: list[dict[str, object]] = []
for keyword in ("anyOf", "oneOf"):
candidates = schema.get(keyword)
if isinstance(candidates, list):
variants.extend(candidate for candidate in candidates if isinstance(candidate, dict))
if variants:
for variant in variants:
_add_user_property_to_object_schema(variant, required=required)
_add_user_property_to_object_schema(schema, required=required)
def _add_user_property_to_object_schema(schema: dict[str, object], *, required: bool) -> None:
properties = schema.setdefault("properties", {})
if isinstance(properties, dict):
cast(dict[str, object], properties)["user"] = USER_PROPERTY_SCHEMA
if required:
required_fields = schema.setdefault("required", [])
if isinstance(required_fields, list) and "user" not in required_fields:
required_fields.append("user")
else:
required_fields = schema.get("required")
if isinstance(required_fields, list) and "user" in required_fields:
required_fields.remove("user")
if required_fields == []:
schema.pop("required", None)

47
api/controllers/service_api/wraps.py
View File

@ -4,16 +4,23 @@ import time
from collections.abc import Callable
from enum import StrEnum, auto
from functools import wraps
from typing import cast, overload
from typing import Protocol, cast, overload
from flask import current_app, request
from flask_login import user_logged_in
from flask_restx import Resource
from flask_restx.utils import merge
from pydantic import BaseModel
from sqlalchemy import select
from werkzeug.exceptions import Forbidden, NotFound, Unauthorized
from configs import dify_config
from controllers.service_api.schema import (
USER_FETCH_FROM_ATTR,
USER_FORM_PARAM,
USER_QUERY_PARAM,
USER_REQUIRED_ATTR,
)
from enums.cloud_plan import CloudPlan
from extensions.ext_database import db
from extensions.ext_redis import redis_client
@ -28,6 +35,12 @@ from services.feature_service import FeatureService
logger = logging.getLogger(__name__)
class _RestxDocumentedView(Protocol):
"""Callable view object carrying Flask-RESTX documentation metadata."""
__apidoc__: dict[str, object]
class WhereisUserArg(StrEnum):
"""
Enum for whereis_user_arg.
@ -43,6 +56,35 @@ class FetchUserArg(BaseModel):
required: bool = False
APP_TOKEN_FORBIDDEN_RESPONSE = {
403: "Forbidden - token scope, app, dataset, or workspace access denied",
}
DATASET_TOKEN_AUTH_RESPONSES = {
401: "Unauthorized - invalid API token",
403: "Forbidden - dataset API access or workspace access denied",
}
def _document_app_token_contract(view_func: Callable[..., object], fetch_user_arg: FetchUserArg | None) -> None:
doc: dict[str, object] = {"responses": APP_TOKEN_FORBIDDEN_RESPONSE}
if fetch_user_arg is not None:
setattr(view_func, USER_FETCH_FROM_ATTR, fetch_user_arg.fetch_from.name)
setattr(view_func, USER_REQUIRED_ATTR, fetch_user_arg.required)
match fetch_user_arg.fetch_from:
case WhereisUserArg.QUERY:
doc["params"] = {"user": {**USER_QUERY_PARAM, "required": fetch_user_arg.required}}
case WhereisUserArg.FORM:
doc["params"] = {"user": {**USER_FORM_PARAM, "required": fetch_user_arg.required}}
case WhereisUserArg.JSON:
pass
cast(_RestxDocumentedView, view_func).__apidoc__ = cast(
dict[str, object],
merge(getattr(view_func, "__apidoc__", {}), doc),
)
@overload
def validate_app_token[**P, R](view: Callable[P, R]) -> Callable[P, R]: ...
@ -126,6 +168,7 @@ def validate_app_token[**P, R](
return view_func(*args, **kwargs)
_document_app_token_contract(decorated_view, fetch_user_arg)
return decorated_view
if view is None:
@ -343,6 +386,8 @@ def validate_and_get_api_token(scope: str | None = None):
class DatasetApiResource(Resource):
__apidoc__ = {"responses": DATASET_TOKEN_AUTH_RESPONSES}
method_decorators = [validate_dataset_token]
def get_dataset(self, dataset_id: str, tenant_id: str) -> Dataset:

7
api/dev/generate_swagger_markdown_docs.py
View File

@ -167,6 +167,12 @@ def _patch_union_schema_markdown(markdown: str, spec_path: Path) -> str:
return markdown
def _strip_trailing_line_whitespace(markdown: str) -> str:
"""Remove converter-emitted trailing whitespace without changing line structure."""
return "\n".join(line.rstrip(" \t") for line in markdown.split("\n"))
def _convert_spec_to_markdown(spec_path: Path, markdown_path: Path) -> None:
markdown_path.parent.mkdir(parents=True, exist_ok=True)
with tempfile.TemporaryDirectory(prefix=f"{markdown_path.stem}-") as temp_dir:
@ -201,6 +207,7 @@ def _convert_spec_to_markdown(spec_path: Path, markdown_path: Path) -> None:
temp_markdown_path.read_text(encoding="utf-8"),
spec_path,
)
converted_markdown = _strip_trailing_line_whitespace(converted_markdown)
if not converted_markdown.strip():
raise RuntimeError(f"swagger-markdown wrote an empty document for {markdown_path}")

7
api/dev/generate_swagger_specs.py
View File

@ -104,11 +104,14 @@ def _field_signature(field: object) -> object:
"description",
"example",
"max",
"max_items",
"min",
"min_items",
"nullable",
"readonly",
"required",
"title",
"unique",
):
if hasattr(field_instance, attr_name):
signature[attr_name] = _jsonable_schema_value(getattr(field_instance, attr_name))
@ -154,9 +157,9 @@ def create_spec_app() -> Flask:
apply_runtime_defaults()
from libs.flask_restx_compat import patch_swagger_for_inline_nested_dicts
from libs.flask_restx_compat import install_swagger_compatibility
patch_swagger_for_inline_nested_dicts()
install_swagger_compatibility()
app = Flask(__name__)

20
api/libs/external_api.py
View File

@ -9,7 +9,7 @@ from werkzeug.http import HTTP_STATUS_CODES
from configs import dify_config
from core.errors.error import AppInvokeQuotaExceededError
from libs.flask_restx_compat import patch_swagger_for_inline_nested_dicts
from libs.flask_restx_compat import install_swagger_compatibility
from libs.token import build_force_logout_cookie_headers
@ -127,16 +127,22 @@ def register_external_error_handlers(api: Api, body_formatter: ErrorBodyFormatte
class ExternalApi(Api):
_authorizations = {
"Bearer": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Type: Bearer {your-api-key}",
"bearerFormat": "API_KEY",
"description": "Use the Service API key as a Bearer token in the Authorization header.",
"scheme": "bearer",
"type": "http",
}
}
def __init__(self, app: Blueprint | Flask, *args, error_body_formatter: ErrorBodyFormatter | None = None, **kwargs):
def __init__(
self,
app: Blueprint | Flask,
*args,
error_body_formatter: ErrorBodyFormatter | None = None,
**kwargs,
):
self._error_body_formatter = error_body_formatter
patch_swagger_for_inline_nested_dicts()
install_swagger_compatibility()
kwargs.setdefault("authorizations", self._authorizations)
kwargs.setdefault("security", "Bearer")
kwargs["add_specs"] = dify_config.SWAGGER_UI_ENABLED

32
api/libs/flask_restx_compat.py
View File

@ -8,10 +8,11 @@ spec export fail or succeed in the same way.
import hashlib
import json
from typing import TypeGuard
from typing import TypeGuard, cast
from flask import current_app
from flask_restx import fields
from flask_restx import swagger as restx_swagger
from flask_restx.model import Model, OrderedModel, instance
from flask_restx.swagger import Swagger
@ -98,20 +99,25 @@ def _inline_model_name(nested_fields: dict[object, object]) -> str:
return f"_AnonymousInlineModel_{digest}"
def patch_swagger_for_inline_nested_dicts() -> None:
"""Allow OpenAPI generation to handle legacy inline Flask-RESTX field dicts.
def install_swagger_compatibility() -> None:
"""Install Dify's Flask-RESTX OpenAPI compatibility hooks.
Some existing controllers use raw field mappings in `fields.Nested({...})`
or directly in `@namespace.response(...)`. Runtime marshalling accepts that,
but Flask-RESTX registration expects a named model. Convert those
anonymous mappings into temporary named models during docs generation.
Flask-RESTX also drops parameter descriptions from generated schemas and
does not expose the Werkzeug `uuid` route converter as `format: uuid`.
"""
if getattr(Swagger, "_dify_inline_nested_dict_patch", False):
if getattr(Swagger, "_dify_swagger_compatibility_installed", False):
return
original_register_model = Swagger.register_model
original_register_field = Swagger.register_field
original_extract_path_params = restx_swagger.extract_path_params
original_schema_from_parameter = Swagger.schema_from_parameter
original_as_dict = Swagger.as_dict
def get_or_create_inline_model(self: Swagger, nested_fields: dict[object, object]) -> object:
@ -134,6 +140,20 @@ def patch_swagger_for_inline_nested_dicts() -> None:
original_register_field(self, field)
def schema_from_parameter_with_description(self: Swagger, param: dict[str, object]) -> dict[str, object]:
schema = cast(dict[str, object], original_schema_from_parameter(self, param))
description = param.get("description")
if isinstance(description, str):
schema["description"] = description
return schema
def extract_path_params_with_uuid_format(path: str):
params = original_extract_path_params(path)
for converter, _arguments, variable in restx_swagger.parse_rule(path):
if converter == "uuid" and variable in params:
params[variable]["format"] = "uuid"
return params
def as_dict_with_inline_dict_support(self: Swagger):
# Temporary set RESTX_INCLUDE_ALL_MODELS = false to prevent "length changed while iterating" error
include_all_models = current_app.config.get("RESTX_INCLUDE_ALL_MODELS", False)
@ -145,5 +165,7 @@ def patch_swagger_for_inline_nested_dicts() -> None:
Swagger.register_model = register_model_with_inline_dict_support
Swagger.register_field = register_field_with_inline_dict_support
restx_swagger.extract_path_params = extract_path_params_with_uuid_format
Swagger.schema_from_parameter = schema_from_parameter_with_description
Swagger.as_dict = as_dict_with_inline_dict_support
Swagger._dify_inline_nested_dict_patch = True
Swagger._dify_swagger_compatibility_installed = True

1005
api/openapi/markdown/console-openapi.md
View File

File diff suppressed because it is too large Load Diff

7
api/openapi/markdown/openapi-openapi.md
View File

@ -4,10 +4,9 @@ User-scoped programmatic API (bearer auth)
## Version: 1.0
### Available authorizations
#### Bearer (API Key Authentication)
Type: Bearer {your-api-key}
**Name:** Authorization
**In:** header
#### Bearer (HTTP, bearer)
Use the Service API key as a Bearer token in the Authorization header.
Bearer format: API_KEY
---
## openapi

463
api/openapi/markdown/service-openapi.md
View File

File diff suppressed because it is too large Load Diff

23
api/openapi/markdown/web-openapi.md
View File

@ -4,10 +4,9 @@ Public APIs for web applications including file uploads, chat interactions, and
## Version: 1.0
### Available authorizations
#### Bearer (API Key Authentication)
Type: Bearer {your-api-key}
**Name:** Authorization
**In:** header
#### Bearer (HTTP, bearer)
Use the Service API key as a Bearer token in the Authorization header.
Bearer format: API_KEY
---
## web
@ -140,7 +139,7 @@ Delete a specific conversation.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path | Conversation UUID | Yes | string |
| c_id | path | Conversation UUID | Yes | string (uuid) |
#### Responses
@ -160,7 +159,7 @@ Rename a specific conversation with a custom name or auto-generate one.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path | Conversation UUID | Yes | string |
| c_id | path | Conversation UUID | Yes | string (uuid) |
| auto_generate | query | Auto-generate conversation name | No | boolean |
| name | query | New conversation name | No | string |
@ -188,7 +187,7 @@ Pin a specific conversation to keep it at the top of the list.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path | Conversation UUID | Yes | string |
| c_id | path | Conversation UUID | Yes | string (uuid) |
#### Responses
@ -208,7 +207,7 @@ Unpin a specific conversation to remove it from the top of the list.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| c_id | path | Conversation UUID | Yes | string |
| c_id | path | Conversation UUID | Yes | string (uuid) |
#### Responses
@ -494,7 +493,7 @@ Submit feedback (like/dislike) for a specific message.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| message_id | path | Message UUID | Yes | string |
| message_id | path | Message UUID | Yes | string (uuid) |
| content | query | Feedback content | No | string |
| rating | query | Feedback rating | No | string, <br>**Available values:** "dislike", "like" |
@ -523,7 +522,7 @@ Generate a new completion similar to an existing message (completion apps only).
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| response_mode | query | Response mode | Yes | string, <br>**Available values:** "blocking", "streaming" |
| message_id | path | | Yes | string |
| message_id | path | | Yes | string (uuid) |
#### Responses
@ -543,7 +542,7 @@ Get suggested follow-up questions after a message (chat apps only).
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| message_id | path | Message UUID | Yes | string |
| message_id | path | Message UUID | Yes | string (uuid) |
#### Responses
@ -731,7 +730,7 @@ Remove a message from saved messages.
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
| message_id | path | Message UUID to delete | Yes | string |
| message_id | path | Message UUID to delete | Yes | string (uuid) |
#### Responses

8
api/tests/unit_tests/commands/test_generate_swagger_markdown_docs.py
View File

@ -266,6 +266,7 @@ def test_patch_union_schema_markdown_ignores_unrenderable_shapes(tmp_path):
assert module._schema_ref_name(None) is None
assert module._schema_markdown_type(None) == ""
assert module._schema_markdown_type({"anyOf": [{"type": "null"}]}) == ""
assert module._strip_trailing_line_whitespace("line \ncell\t \n") == "line\ncell\n"
assert module._replace_schema_table_type("unchanged", "Definition", "field", "") == "unchanged"
assert (
module._replace_schema_table_type(
@ -319,7 +320,10 @@ def test_convert_spec_to_markdown_patches_generated_union_tables(tmp_path, monke
assert kwargs["check"] is False
markdown_path = Path(args[args.index("-o") + 1])
markdown_path.write_text(
"""#### FormInputConfig
"Intro line"
+ " \n"
+ """
#### FormInputConfig
| Name | Type | Description | Required |
| ---- | ---- | ----------- | -------- |
@ -340,5 +344,7 @@ def test_convert_spec_to_markdown_patches_generated_union_tables(tmp_path, monke
module._convert_spec_to_markdown(spec_path, output_path)
converted = output_path.read_text(encoding="utf-8")
assert "Intro line \n" not in converted
assert "Intro line\n" in converted
assert "| FormInputConfig | [ParagraphInputConfig](#paragraphinputconfig) | | |" in converted
assert "| default | [StringSource](#stringsource) | | No |" in converted

17
api/tests/unit_tests/commands/test_generate_swagger_specs.py
View File

@ -106,6 +106,23 @@ def test_generate_specs_writes_get_operations_without_request_bodies(tmp_path):
assert all("requestBody" not in operation for operation in _get_operations(payload))
def test_standalone_inline_model_name_includes_list_constraints():
module = _load_generate_swagger_specs_module()
from flask_restx import fields
cases = (
({"min_items": 1}, {"min_items": 2}),
({"max_items": 1}, {"max_items": 2}),
({"unique": True}, {"unique": False}),
)
for first_kwargs, second_kwargs in cases:
first_inline_model = {"items": fields.List(fields.String, **first_kwargs)}
second_inline_model = {"items": fields.List(fields.String, **second_kwargs)}
assert module._inline_model_name(first_inline_model) != module._inline_model_name(second_inline_model)
def test_generate_specs_is_idempotent(tmp_path):
module = _load_generate_swagger_specs_module()

325
api/tests/unit_tests/controllers/test_swagger.py
View File

@ -57,6 +57,36 @@ def _multipart_form_schema(operation: dict[str, object]) -> dict[str, object]:
return schema
def _json_body_schema(payload: dict[str, object], operation: dict[str, object]) -> dict[str, object]:
request_body = operation.get("requestBody")
assert isinstance(request_body, dict)
content = request_body.get("content")
assert isinstance(content, dict)
json_media = content.get("application/json")
assert isinstance(json_media, dict)
schema = json_media.get("schema")
assert isinstance(schema, dict)
ref = schema.get("$ref")
if isinstance(ref, str):
schema_name = ref.removeprefix("#/components/schemas/")
resolved = payload["components"]["schemas"][schema_name]
assert isinstance(resolved, dict)
return resolved
return schema
def _response_content_types(operation: dict[str, object], status_code: str = "200") -> set[str]:
responses = operation.get("responses")
assert isinstance(responses, dict)
response = responses.get(status_code)
assert isinstance(response, dict)
content = response.get("content")
assert isinstance(content, dict)
return set(content)
@pytest.mark.parametrize(
("first_kwargs", "second_kwargs"),
[
@ -79,6 +109,25 @@ def test_inline_model_name_includes_list_constraints(
assert _inline_model_name(first_inline_model) != _inline_model_name(second_inline_model)
def test_uuid_path_format_is_derived_from_route_converter():
from flask_restx import swagger as restx_swagger
from libs.flask_restx_compat import install_swagger_compatibility
app = Flask(__name__)
with app.app_context():
install_swagger_compatibility()
params = restx_swagger.extract_path_params("/resources/<uuid:custom_resource_uuid>")
assert params["custom_resource_uuid"] == {
"format": "uuid",
"in": "path",
"name": "custom_resource_uuid",
"required": True,
"type": "string",
}
def test_openapi_json_endpoints_render(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.console import bp as console_bp
@ -132,7 +181,10 @@ def test_service_document_file_routes_document_multipart_form_data(monkeypatch:
create_properties = create_schema["properties"]
assert isinstance(create_properties, dict)
assert create_properties["file"] == {"type": "string", "format": "binary"}
assert create_properties["data"] == {"type": "string"}
assert create_properties["data"] == {
"description": "Optional JSON string with document creation settings.",
"type": "string",
}
assert create_schema["required"] == ["file"]
assert create_operation["requestBody"]["required"] is True
@ -146,7 +198,10 @@ def test_service_document_file_routes_document_multipart_form_data(monkeypatch:
update_properties = update_schema["properties"]
assert isinstance(update_properties, dict)
assert update_properties["file"] == {"type": "string", "format": "binary"}
assert update_properties["data"] == {"type": "string"}
assert update_properties["data"] == {
"description": "Optional JSON string with document update settings.",
"type": "string",
}
assert "required" not in update_schema
assert update_operation["requestBody"]["required"] is False
@ -170,6 +225,272 @@ def test_service_document_list_documents_query_params_render(monkeypatch: pytest
assert params[name]["in"] == "query"
def test_service_openapi_documents_decorator_user_contracts(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
required_json_user_operations = (
("/completion-messages", "post"),
("/completion-messages/{task_id}/stop", "post"),
("/chat-messages", "post"),
("/chat-messages/{task_id}/stop", "post"),
("/messages/{message_id}/feedbacks", "post"),
("/form/human_input/{form_token}", "post"),
("/workflows/run", "post"),
("/workflows/{workflow_id}/run", "post"),
("/workflows/tasks/{task_id}/stop", "post"),
)
for path, method in required_json_user_operations:
schema = _json_body_schema(payload, paths[path][method])
assert schema["properties"]["user"] == {"description": "End user identifier", "type": "string"}
assert "user" in schema["required"]
optional_json_user_operations = (
("/text-to-audio", "post"),
("/conversations/{c_id}", "delete"),
("/conversations/{c_id}/name", "post"),
("/conversations/{c_id}/variables/{variable_id}", "put"),
)
for path, method in optional_json_user_operations:
schema = _json_body_schema(payload, paths[path][method])
assert schema["properties"]["user"] == {"description": "End user identifier", "type": "string"}
assert "user" not in schema.get("required", [])
messages_params = _parameters_by_name(paths["/messages"]["get"])
assert messages_params["user"]["in"] == "query"
assert messages_params["user"]["required"] is False
events_params = _parameters_by_name(paths["/workflow/{task_id}/events"]["get"])
assert events_params["user"]["in"] == "query"
assert events_params["user"]["required"] is True
def test_service_openapi_documents_app_multipart_contracts(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
for path in ("/files/upload", "/audio-to-text"):
schema = _multipart_form_schema(paths[path]["post"])
assert schema["properties"]["file"] == {"format": "binary", "type": "string"}
assert schema["properties"]["user"] == {"description": "End user identifier", "type": "string"}
assert schema["required"] == ["file"]
pipeline_schema = _multipart_form_schema(paths["/datasets/pipeline/file-upload"]["post"])
assert pipeline_schema["properties"]["file"] == {"format": "binary", "type": "string"}
assert pipeline_schema["required"] == ["file"]
def test_service_openapi_documents_non_json_response_media_types(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
assert _response_content_types(paths["/chat-messages"]["post"]) == {
"application/json",
"text/event-stream",
}
assert _response_content_types(paths["/workflow/{task_id}/events"]["get"]) == {"text/event-stream"}
assert _response_content_types(paths["/text-to-audio"]["post"]) == {"audio/mpeg"}
assert _response_content_types(paths["/files/{file_id}/preview"]["get"]) == {
"application/octet-stream",
"application/pdf",
"audio/aac",
"audio/flac",
"audio/mp4",
"audio/mpeg",
"audio/ogg",
"audio/wav",
"audio/x-m4a",
"image/gif",
"image/jpeg",
"image/png",
"image/webp",
"text/plain",
"video/mp4",
"video/quicktime",
"video/webm",
}
assert _response_content_types(paths["/datasets/{dataset_id}/documents/download-zip"]["post"]) == {
"application/zip"
}
def test_service_openapi_documents_uuid_params_and_deprecated_routes(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
dataset_params = _parameters_by_name(paths["/datasets/{dataset_id}"]["get"])
assert dataset_params["dataset_id"]["schema"] == {
"description": "Dataset ID",
"format": "uuid",
"type": "string",
}
conversation_params = _parameters_by_name(paths["/conversations/{c_id}"]["delete"])
assert conversation_params["c_id"]["schema"] == {
"description": "Conversation ID",
"format": "uuid",
"type": "string",
}
assert paths["/datasets/{dataset_id}/document/create_by_file"]["post"]["deprecated"] is True
assert paths["/datasets/{dataset_id}/documents/{document_id}/update_by_text"]["post"]["deprecated"] is True
def test_service_openapi_documents_path_action_enums(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
annotation_params = _parameters_by_name(paths["/apps/annotation-reply/{action}"]["post"])
assert annotation_params["action"]["schema"]["enum"] == ["enable", "disable"]
document_status_params = _parameters_by_name(paths["/datasets/{dataset_id}/documents/status/{action}"]["patch"])
assert document_status_params["action"]["schema"]["enum"] == ["enable", "disable", "archive", "un_archive"]
metadata_params = _parameters_by_name(paths["/datasets/{dataset_id}/metadata/built-in/{action}"]["post"])
assert metadata_params["action"]["schema"]["enum"] == ["enable", "disable"]
def test_service_openapi_documents_conditional_payload_schemas(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
rename_schema = _json_body_schema(payload, paths["/conversations/{c_id}/name"]["post"])
auto_generate_branch, manual_name_branch = rename_schema["anyOf"]
assert auto_generate_branch["properties"]["auto_generate"]["enum"] == [True]
assert auto_generate_branch["required"] == ["auto_generate"]
assert manual_name_branch["properties"]["auto_generate"]["enum"] == [False]
assert manual_name_branch["properties"]["name"]["pattern"] == r".*\S.*"
assert manual_name_branch["required"] == ["name"]
for branch in rename_schema["anyOf"]:
assert branch["properties"]["user"] == {"description": "End user identifier", "type": "string"}
document_update_schema = payload["components"]["schemas"]["DocumentTextUpdate"]
with_text_branch, without_text_branch = document_update_schema["anyOf"]
assert with_text_branch["properties"]["text"]["type"] == "string"
assert with_text_branch["properties"]["name"]["type"] == "string"
assert with_text_branch["required"] == ["name", "text"]
assert without_text_branch["properties"]["text"]["type"] == "null"
def test_service_openapi_does_not_encode_docs_coverage_boundaries(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
paths = payload["paths"]
for path_item in paths.values():
assert isinstance(path_item, dict)
for method in ("delete", "get", "patch", "post", "put"):
operation = path_item.get(method)
if not isinstance(operation, dict):
continue
assert "x-dify-api-reference-visibility" not in operation
assert "x-dify-api-lifecycle" not in operation
assert paths["/datasets/{dataset_id}/document/create_by_text"]["post"]["deprecated"] is True
assert paths["/datasets/{dataset_id}/document/create_by_file"]["post"]["deprecated"] is True
assert paths["/datasets/{dataset_id}/documents/{document_id}/update-by-file"]["post"]["deprecated"] is True
def test_service_openapi_documents_auth_and_compatibility_payloads(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.service_api import bp as service_api_bp
monkeypatch.setattr(dify_config, "SWAGGER_UI_ENABLED", True)
app = Flask(__name__)
app.config["TESTING"] = True
app.config["RESTX_INCLUDE_ALL_MODELS"] = True
app.register_blueprint(service_api_bp)
payload = app.test_client().get("/v1/openapi.json").get_json()
assert payload["components"]["securitySchemes"]["Bearer"] == {
"bearerFormat": "API_KEY",
"description": "Use the Service API key as a Bearer token in the Authorization header.",
"scheme": "bearer",
"type": "http",
}
tag_unbinding_schema = payload["components"]["schemas"]["TagUnbindingPayload"]
assert tag_unbinding_schema["description"] == (
"Accepts either the legacy tag_id payload or the normalized tag_ids payload."
)
tag_id_schema, tag_ids_schema = tag_unbinding_schema["anyOf"]
assert tag_id_schema["properties"]["tag_id"]["description"] == ("Legacy single tag ID accepted by the Service API.")
assert tag_id_schema["required"] == ["tag_id", "target_id"]
assert tag_ids_schema["properties"]["tag_ids"]["minItems"] == 1
assert tag_ids_schema["required"] == ["tag_ids", "target_id"]
def test_console_account_avatar_query_param_renders_as_query(monkeypatch: pytest.MonkeyPatch):
from configs import dify_config
from controllers.console import bp as console_bp

68
packages/contracts/generated/api/console/agent/zod.gen.ts
View File

@ -2087,7 +2087,7 @@ export const zGetAgentInviteOptionsQuery = z.object({
export const zGetAgentInviteOptionsResponse = zAgentInviteOptionsResponse
export const zDeleteAgentByAgentIdPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2096,7 +2096,7 @@ export const zDeleteAgentByAgentIdPath = z.object({
export const zDeleteAgentByAgentIdResponse = z.void()
export const zGetAgentByAgentIdPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2107,7 +2107,7 @@ export const zGetAgentByAgentIdResponse = zAppDetailWithSite
export const zPutAgentByAgentIdBody = zAgentAppUpdatePayload
export const zPutAgentByAgentIdPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2116,7 +2116,7 @@ export const zPutAgentByAgentIdPath = z.object({
export const zPutAgentByAgentIdResponse = zAppDetailWithSite
export const zGetAgentByAgentIdChatMessagesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdChatMessagesQuery = z.object({
@ -2131,8 +2131,8 @@ export const zGetAgentByAgentIdChatMessagesQuery = z.object({
export const zGetAgentByAgentIdChatMessagesResponse = zMessageInfiniteScrollPaginationResponse
export const zGetAgentByAgentIdChatMessagesByMessageIdSuggestedQuestionsPath = z.object({
agent_id: z.string(),
message_id: z.string(),
agent_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -2142,7 +2142,7 @@ export const zGetAgentByAgentIdChatMessagesByMessageIdSuggestedQuestionsResponse
= zSuggestedQuestionsResponse
export const zPostAgentByAgentIdChatMessagesByTaskIdStopPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
task_id: z.string(),
})
@ -2152,7 +2152,7 @@ export const zPostAgentByAgentIdChatMessagesByTaskIdStopPath = z.object({
export const zPostAgentByAgentIdChatMessagesByTaskIdStopResponse = zSimpleResultResponse
export const zGetAgentByAgentIdComposerPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2163,7 +2163,7 @@ export const zGetAgentByAgentIdComposerResponse = zAgentAppComposerResponse
export const zPutAgentByAgentIdComposerBody = zComposerSavePayload
export const zPutAgentByAgentIdComposerPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2172,7 +2172,7 @@ export const zPutAgentByAgentIdComposerPath = z.object({
export const zPutAgentByAgentIdComposerResponse = zAgentAppComposerResponse
export const zGetAgentByAgentIdComposerCandidatesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2183,7 +2183,7 @@ export const zGetAgentByAgentIdComposerCandidatesResponse = zAgentComposerCandid
export const zPostAgentByAgentIdComposerValidateBody = zComposerSavePayload
export const zPostAgentByAgentIdComposerValidatePath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2194,7 +2194,7 @@ export const zPostAgentByAgentIdComposerValidateResponse = zAgentComposerValidat
export const zPostAgentByAgentIdCopyBody = zCopyAppPayload
export const zPostAgentByAgentIdCopyPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2203,7 +2203,7 @@ export const zPostAgentByAgentIdCopyPath = z.object({
export const zPostAgentByAgentIdCopyResponse = zAppDetailWithSite
export const zGetAgentByAgentIdDriveFilesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdDriveFilesQuery = z.object({
@ -2216,7 +2216,7 @@ export const zGetAgentByAgentIdDriveFilesQuery = z.object({
export const zGetAgentByAgentIdDriveFilesResponse = zAgentDriveListResponse
export const zGetAgentByAgentIdDriveFilesDownloadPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdDriveFilesDownloadQuery = z.object({
@ -2229,7 +2229,7 @@ export const zGetAgentByAgentIdDriveFilesDownloadQuery = z.object({
export const zGetAgentByAgentIdDriveFilesDownloadResponse = zAgentDriveDownloadResponse
export const zGetAgentByAgentIdDriveFilesPreviewPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdDriveFilesPreviewQuery = z.object({
@ -2244,7 +2244,7 @@ export const zGetAgentByAgentIdDriveFilesPreviewResponse = zAgentDrivePreviewRes
export const zPostAgentByAgentIdFeaturesBody = zAgentAppFeaturesPayload
export const zPostAgentByAgentIdFeaturesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2255,7 +2255,7 @@ export const zPostAgentByAgentIdFeaturesResponse = zSimpleResultResponse
export const zPostAgentByAgentIdFeedbacksBody = zMessageFeedbackPayload
export const zPostAgentByAgentIdFeedbacksPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2264,7 +2264,7 @@ export const zPostAgentByAgentIdFeedbacksPath = z.object({
export const zPostAgentByAgentIdFeedbacksResponse = zSimpleResultResponse
export const zDeleteAgentByAgentIdFilesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zDeleteAgentByAgentIdFilesQuery = z.object({
@ -2279,7 +2279,7 @@ export const zDeleteAgentByAgentIdFilesResponse = zAgentDriveDeleteResponse
export const zPostAgentByAgentIdFilesBody = zAgentDriveFilePayload
export const zPostAgentByAgentIdFilesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2288,7 +2288,7 @@ export const zPostAgentByAgentIdFilesPath = z.object({
export const zPostAgentByAgentIdFilesResponse = zAgentDriveFileCommitResponse
export const zGetAgentByAgentIdLogsPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdLogsQuery = z.object({
@ -2307,8 +2307,8 @@ export const zGetAgentByAgentIdLogsQuery = z.object({
export const zGetAgentByAgentIdLogsResponse = zAgentLogListResponse
export const zGetAgentByAgentIdMessagesByMessageIdPath = z.object({
agent_id: z.string(),
message_id: z.string(),
agent_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -2317,7 +2317,7 @@ export const zGetAgentByAgentIdMessagesByMessageIdPath = z.object({
export const zGetAgentByAgentIdMessagesByMessageIdResponse = zMessageDetailResponse
export const zGetAgentByAgentIdReferencingWorkflowsPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2326,7 +2326,7 @@ export const zGetAgentByAgentIdReferencingWorkflowsPath = z.object({
export const zGetAgentByAgentIdReferencingWorkflowsResponse = zAgentReferencingWorkflowsResponse
export const zGetAgentByAgentIdSandboxFilesPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdSandboxFilesQuery = z.object({
@ -2340,7 +2340,7 @@ export const zGetAgentByAgentIdSandboxFilesQuery = z.object({
export const zGetAgentByAgentIdSandboxFilesResponse = zSandboxListResponse
export const zGetAgentByAgentIdSandboxFilesReadPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdSandboxFilesReadQuery = z.object({
@ -2356,7 +2356,7 @@ export const zGetAgentByAgentIdSandboxFilesReadResponse = zSandboxReadResponse
export const zPostAgentByAgentIdSandboxFilesUploadBody = zAgentSandboxUploadPayload
export const zPostAgentByAgentIdSandboxFilesUploadPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2365,7 +2365,7 @@ export const zPostAgentByAgentIdSandboxFilesUploadPath = z.object({
export const zPostAgentByAgentIdSandboxFilesUploadResponse = zSandboxUploadResponse
export const zPostAgentByAgentIdSkillsStandardizePath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2374,7 +2374,7 @@ export const zPostAgentByAgentIdSkillsStandardizePath = z.object({
export const zPostAgentByAgentIdSkillsStandardizeResponse = zAgentSkillStandardizeResponse
export const zPostAgentByAgentIdSkillsUploadPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2383,7 +2383,7 @@ export const zPostAgentByAgentIdSkillsUploadPath = z.object({
export const zPostAgentByAgentIdSkillsUploadResponse = zAgentSkillUploadResponse
export const zDeleteAgentByAgentIdSkillsBySlugPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
slug: z.string(),
})
@ -2393,7 +2393,7 @@ export const zDeleteAgentByAgentIdSkillsBySlugPath = z.object({
export const zDeleteAgentByAgentIdSkillsBySlugResponse = zAgentDriveDeleteResponse
export const zPostAgentByAgentIdSkillsBySlugInferToolsPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
slug: z.string(),
})
@ -2403,7 +2403,7 @@ export const zPostAgentByAgentIdSkillsBySlugInferToolsPath = z.object({
export const zPostAgentByAgentIdSkillsBySlugInferToolsResponse = zSkillToolInferenceResult
export const zGetAgentByAgentIdStatisticsSummaryPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
export const zGetAgentByAgentIdStatisticsSummaryQuery = z.object({
@ -2418,7 +2418,7 @@ export const zGetAgentByAgentIdStatisticsSummaryQuery = z.object({
export const zGetAgentByAgentIdStatisticsSummaryResponse = zAgentStatisticSummaryEnvelopeResponse
export const zGetAgentByAgentIdVersionsPath = z.object({
agent_id: z.string(),
agent_id: z.uuid(),
})
/**
@ -2427,8 +2427,8 @@ export const zGetAgentByAgentIdVersionsPath = z.object({
export const zGetAgentByAgentIdVersionsResponse = zAgentConfigSnapshotListResponse
export const zGetAgentByAgentIdVersionsByVersionIdPath = z.object({
agent_id: z.string(),
version_id: z.string(),
agent_id: z.uuid(),
version_id: z.uuid(),
})
/**

6
packages/contracts/generated/api/console/api-based-extension/zod.gen.ts
View File

@ -37,7 +37,7 @@ export const zPostApiBasedExtensionBody = zApiBasedExtensionPayload
export const zPostApiBasedExtensionResponse = zApiBasedExtensionResponse
export const zDeleteApiBasedExtensionByIdPath = z.object({
id: z.string(),
id: z.uuid(),
})
/**
@ -46,7 +46,7 @@ export const zDeleteApiBasedExtensionByIdPath = z.object({
export const zDeleteApiBasedExtensionByIdResponse = z.void()
export const zGetApiBasedExtensionByIdPath = z.object({
id: z.string(),
id: z.uuid(),
})
/**
@ -57,7 +57,7 @@ export const zGetApiBasedExtensionByIdResponse = zApiBasedExtensionResponse
export const zPostApiBasedExtensionByIdBody = zApiBasedExtensionPayload
export const zPostApiBasedExtensionByIdPath = z.object({
id: z.string(),
id: z.uuid(),
})
/**

2
packages/contracts/generated/api/console/api-key-auth/zod.gen.ts
View File

@ -50,7 +50,7 @@ export const zPostApiKeyAuthDataSourceBindingBody = zApiKeyAuthBindingPayload
export const zPostApiKeyAuthDataSourceBindingResponse = zSimpleResultResponse
export const zDeleteApiKeyAuthDataSourceByBindingIdPath = z.object({
binding_id: z.string(),
binding_id: z.uuid(),
})
/**

388
packages/contracts/generated/api/console/apps/zod.gen.ts
View File

File diff suppressed because it is too large Load Diff

4
packages/contracts/generated/api/console/data-source/zod.gen.ts
View File

@ -72,7 +72,7 @@ export const zPatchDataSourceIntegratesResponse = zSimpleResultResponse
export const zGetDataSourceIntegratesByBindingIdByActionPath = z.object({
action: z.string(),
binding_id: z.string(),
binding_id: z.uuid(),
})
/**
@ -82,7 +82,7 @@ export const zGetDataSourceIntegratesByBindingIdByActionResponse = zDataSourceIn
export const zPatchDataSourceIntegratesByBindingIdByActionPath = z.object({
action: z.string(),
binding_id: z.string(),
binding_id: z.uuid(),
})
/**

210
packages/contracts/generated/api/console/datasets/zod.gen.ts
View File

@ -1502,7 +1502,7 @@ export const zGetDatasetsApiKeysResponse = zApiKeyList
export const zPostDatasetsApiKeysResponse = zApiKeyItem
export const zDeleteDatasetsApiKeysByApiKeyIdPath = z.object({
api_key_id: z.string(),
api_key_id: z.uuid(),
})
/**
@ -1511,7 +1511,7 @@ export const zDeleteDatasetsApiKeysByApiKeyIdPath = z.object({
export const zDeleteDatasetsApiKeysByApiKeyIdResponse = z.void()
export const zGetDatasetsBatchImportStatusByJobIdPath = z.object({
job_id: z.string(),
job_id: z.uuid(),
})
/**
@ -1522,7 +1522,7 @@ export const zGetDatasetsBatchImportStatusByJobIdResponse = zSegmentBatchImportS
export const zPostDatasetsBatchImportStatusByJobIdBody = zBatchImportPayload
export const zPostDatasetsBatchImportStatusByJobIdPath = z.object({
job_id: z.string(),
job_id: z.uuid(),
})
/**
@ -1556,7 +1556,7 @@ export const zPostDatasetsExternalKnowledgeApiBody = zExternalKnowledgeApiPayloa
export const zPostDatasetsExternalKnowledgeApiResponse = zExternalKnowledgeApiResponse
export const zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath = z.object({
external_knowledge_api_id: z.string(),
external_knowledge_api_id: z.uuid(),
})
/**
@ -1565,7 +1565,7 @@ export const zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath = z
export const zDeleteDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse = z.void()
export const zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath = z.object({
external_knowledge_api_id: z.string(),
external_knowledge_api_id: z.uuid(),
})
/**
@ -1578,7 +1578,7 @@ export const zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdBody
= zExternalKnowledgeApiPayload
export const zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdPath = z.object({
external_knowledge_api_id: z.string(),
external_knowledge_api_id: z.uuid(),
})
/**
@ -1588,7 +1588,7 @@ export const zPatchDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdResponse
= zExternalKnowledgeApiResponse
export const zGetDatasetsExternalKnowledgeApiByExternalKnowledgeApiIdUseCheckPath = z.object({
external_knowledge_api_id: z.string(),
external_knowledge_api_id: z.uuid(),
})
/**
@ -1647,7 +1647,7 @@ export const zGetDatasetsRetrievalSettingByVectorTypePath = z.object({
export const zGetDatasetsRetrievalSettingByVectorTypeResponse = zRetrievalSettingResponse
export const zDeleteDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1656,7 +1656,7 @@ export const zDeleteDatasetsByDatasetIdPath = z.object({
export const zDeleteDatasetsByDatasetIdResponse = z.void()
export const zGetDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1667,7 +1667,7 @@ export const zGetDatasetsByDatasetIdResponse = zDatasetDetailWithPartialMembersR
export const zPatchDatasetsByDatasetIdBody = zDatasetUpdatePayload
export const zPatchDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1676,7 +1676,7 @@ export const zPatchDatasetsByDatasetIdPath = z.object({
export const zPatchDatasetsByDatasetIdResponse = zDatasetDetailWithPartialMembersResponse
export const zPostDatasetsByDatasetIdApiKeysByStatusPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
status: z.string(),
})
@ -1686,7 +1686,7 @@ export const zPostDatasetsByDatasetIdApiKeysByStatusPath = z.object({
export const zPostDatasetsByDatasetIdApiKeysByStatusResponse = zSimpleResultResponse
export const zGetDatasetsByDatasetIdAutoDisableLogsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1696,7 +1696,7 @@ export const zGetDatasetsByDatasetIdAutoDisableLogsResponse = zAutoDisableLogsRe
export const zGetDatasetsByDatasetIdBatchByBatchIndexingEstimatePath = z.object({
batch: z.string(),
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1706,7 +1706,7 @@ export const zGetDatasetsByDatasetIdBatchByBatchIndexingEstimateResponse = zOpaq
export const zGetDatasetsByDatasetIdBatchByBatchIndexingStatusPath = z.object({
batch: z.string(),
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1715,7 +1715,7 @@ export const zGetDatasetsByDatasetIdBatchByBatchIndexingStatusPath = z.object({
export const zGetDatasetsByDatasetIdBatchByBatchIndexingStatusResponse = zDocumentStatusListResponse
export const zDeleteDatasetsByDatasetIdDocumentsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1724,7 +1724,7 @@ export const zDeleteDatasetsByDatasetIdDocumentsPath = z.object({
export const zDeleteDatasetsByDatasetIdDocumentsResponse = z.void()
export const zGetDatasetsByDatasetIdDocumentsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsQuery = z.object({
@ -1744,7 +1744,7 @@ export const zGetDatasetsByDatasetIdDocumentsResponse = zDocumentWithSegmentsLis
export const zPostDatasetsByDatasetIdDocumentsBody = zKnowledgeConfig
export const zPostDatasetsByDatasetIdDocumentsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1755,7 +1755,7 @@ export const zPostDatasetsByDatasetIdDocumentsResponse = zDatasetAndDocumentResp
export const zPostDatasetsByDatasetIdDocumentsDownloadZipBody = zDocumentBatchDownloadZipPayload
export const zPostDatasetsByDatasetIdDocumentsDownloadZipPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1766,7 +1766,7 @@ export const zPostDatasetsByDatasetIdDocumentsDownloadZipResponse = zBinaryFileR
export const zPostDatasetsByDatasetIdDocumentsGenerateSummaryBody = zGenerateSummaryPayload
export const zPostDatasetsByDatasetIdDocumentsGenerateSummaryPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1777,7 +1777,7 @@ export const zPostDatasetsByDatasetIdDocumentsGenerateSummaryResponse = zSimpleR
export const zPostDatasetsByDatasetIdDocumentsMetadataBody = zMetadataOperationData
export const zPostDatasetsByDatasetIdDocumentsMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1787,7 +1787,7 @@ export const zPostDatasetsByDatasetIdDocumentsMetadataResponse = z.void()
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchPath = z.object({
action: z.string(),
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -1796,8 +1796,8 @@ export const zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchPath = z.objec
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionBatchResponse = zSimpleResultResponse
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1806,8 +1806,8 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.void()
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery = z.object({
@ -1820,8 +1820,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery = z.object({
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse = zOpaqueObjectResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1830,8 +1830,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath = z.object
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse = zUrlResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimatePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1841,8 +1841,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingEstimateRespons
= zOpaqueObjectResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdIndexingStatusPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1855,8 +1855,8 @@ export const zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataBody
= zDocumentMetadataUpdatePayload
export const zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1866,8 +1866,8 @@ export const zPutDatasetsByDatasetIdDocumentsByDocumentIdMetadataResponse
= zSimpleResultMessageResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1876,8 +1876,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncPath = z.obje
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdNotionSyncResponse = zSimpleResultResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1887,8 +1887,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPipelineExecutionLogRes
= zOpaqueObjectResponse
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPausePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1897,8 +1897,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPausePath =
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingPauseResponse = z.void()
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1908,8 +1908,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingResumeRespo
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1921,8 +1921,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdProcessingByActionRes
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameBody = zDocumentRenamePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdRenamePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1933,8 +1933,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdRenameResponse = zDocu
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentBody = zSegmentCreatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -1944,8 +1944,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentResponse = zSeg
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionQuery = z.object({
@ -1959,8 +1959,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentByActionRespon
= zSimpleResultResponse
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.object({
@ -1973,8 +1973,8 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.ob
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse = z.void()
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.object({
@ -1993,8 +1993,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse
= zConsoleSegmentListResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2007,8 +2007,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportBod
= zBatchImportPayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2018,9 +2018,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBatchImportRes
= zSegmentBatchImportStatusResponse
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2032,9 +2032,9 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBo
= zSegmentUpdatePayload
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2045,9 +2045,9 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdRe
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery
@ -2068,9 +2068,9 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdCh
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2084,9 +2084,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2097,10 +2097,10 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_id: z.uuid(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2114,10 +2114,10 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdCh
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_id: z.uuid(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2127,8 +2127,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdCh
= zChildChunkDetailResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2138,8 +2138,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSummaryStatusResponse
= zOpaqueObjectResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2148,7 +2148,7 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncPath = z.obj
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdWebsiteSyncResponse = zSimpleResultResponse
export const zGetDatasetsByDatasetIdErrorDocsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2159,7 +2159,7 @@ export const zGetDatasetsByDatasetIdErrorDocsResponse = zErrorDocsResponse
export const zPostDatasetsByDatasetIdExternalHitTestingBody = zExternalHitTestingPayload
export const zPostDatasetsByDatasetIdExternalHitTestingPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2170,7 +2170,7 @@ export const zPostDatasetsByDatasetIdExternalHitTestingResponse = zExternalRetri
export const zPostDatasetsByDatasetIdHitTestingBody = zHitTestingPayload
export const zPostDatasetsByDatasetIdHitTestingPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2179,7 +2179,7 @@ export const zPostDatasetsByDatasetIdHitTestingPath = z.object({
export const zPostDatasetsByDatasetIdHitTestingResponse = zHitTestingResponse
export const zGetDatasetsByDatasetIdIndexingStatusPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2188,7 +2188,7 @@ export const zGetDatasetsByDatasetIdIndexingStatusPath = z.object({
export const zGetDatasetsByDatasetIdIndexingStatusResponse = zDocumentStatusListResponse
export const zGetDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2199,7 +2199,7 @@ export const zGetDatasetsByDatasetIdMetadataResponse = zDatasetMetadataListRespo
export const zPostDatasetsByDatasetIdMetadataBody = zMetadataArgs
export const zPostDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2209,7 +2209,7 @@ export const zPostDatasetsByDatasetIdMetadataResponse = zDatasetMetadataResponse
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2218,8 +2218,8 @@ export const zPostDatasetsByDatasetIdMetadataBuiltInByActionPath = z.object({
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse = z.void()
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
dataset_id: z.uuid(),
metadata_id: z.uuid(),
})
/**
@ -2230,8 +2230,8 @@ export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse = z.void()
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdBody = zMetadataUpdatePayload
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
dataset_id: z.uuid(),
metadata_id: z.uuid(),
})
/**
@ -2240,7 +2240,7 @@ export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse = zDatasetMetadataResponse
export const zGetDatasetsByDatasetIdNotionSyncPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2249,7 +2249,7 @@ export const zGetDatasetsByDatasetIdNotionSyncPath = z.object({
export const zGetDatasetsByDatasetIdNotionSyncResponse = zSimpleResultResponse
export const zGetDatasetsByDatasetIdPermissionPartUsersPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2258,7 +2258,7 @@ export const zGetDatasetsByDatasetIdPermissionPartUsersPath = z.object({
export const zGetDatasetsByDatasetIdPermissionPartUsersResponse = zPartialMemberListResponse
export const zGetDatasetsByDatasetIdQueriesPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2267,7 +2267,7 @@ export const zGetDatasetsByDatasetIdQueriesPath = z.object({
export const zGetDatasetsByDatasetIdQueriesResponse = zDatasetQueryListResponse
export const zGetDatasetsByDatasetIdRelatedAppsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2278,7 +2278,7 @@ export const zGetDatasetsByDatasetIdRelatedAppsResponse = zRelatedAppListRespons
export const zPostDatasetsByDatasetIdRetryBody = zDocumentRetryPayload
export const zPostDatasetsByDatasetIdRetryPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2287,7 +2287,7 @@ export const zPostDatasetsByDatasetIdRetryPath = z.object({
export const zPostDatasetsByDatasetIdRetryResponse = z.void()
export const zGetDatasetsByDatasetIdUseCheckPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2296,7 +2296,7 @@ export const zGetDatasetsByDatasetIdUseCheckPath = z.object({
export const zGetDatasetsByDatasetIdUseCheckResponse = zUsageCheckResponse
export const zGetDatasetsByResourceIdApiKeysPath = z.object({
resource_id: z.string(),
resource_id: z.uuid(),
})
/**
@ -2305,7 +2305,7 @@ export const zGetDatasetsByResourceIdApiKeysPath = z.object({
export const zGetDatasetsByResourceIdApiKeysResponse = zApiKeyList
export const zPostDatasetsByResourceIdApiKeysPath = z.object({
resource_id: z.string(),
resource_id: z.uuid(),
})
/**
@ -2314,8 +2314,8 @@ export const zPostDatasetsByResourceIdApiKeysPath = z.object({
export const zPostDatasetsByResourceIdApiKeysResponse = zApiKeyItem
export const zDeleteDatasetsByResourceIdApiKeysByApiKeyIdPath = z.object({
api_key_id: z.string(),
resource_id: z.string(),
api_key_id: z.uuid(),
resource_id: z.uuid(),
})
/**

2
packages/contracts/generated/api/console/explore/zod.gen.ts
View File

@ -86,7 +86,7 @@ export const zGetExploreAppsLearnDifyQuery = z.object({
export const zGetExploreAppsLearnDifyResponse = zLearnDifyAppListResponse
export const zGetExploreAppsByAppIdPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**

2
packages/contracts/generated/api/console/files/zod.gen.ts
View File

@ -69,7 +69,7 @@ export const zGetFilesUploadResponse = zUploadConfig
export const zPostFilesUploadResponse = zFileResponse
export const zGetFilesByFileIdPreviewPath = z.object({
file_id: z.string(),
file_id: z.uuid(),
})
/**

11
packages/contracts/generated/api/console/installed-apps/types.gen.ts
View File

@ -68,7 +68,16 @@ export type ConversationInfiniteScrollPagination = {
limit: number
}
export type ConversationRenamePayload = {
export type ConversationRenamePayload = (
| {
auto_generate: true
name?: string | null
}
| {
auto_generate?: false
name: string
}
) & {
auto_generate?: boolean
name?: string | null
}

87
packages/contracts/generated/api/console/installed-apps/zod.gen.ts
View File

@ -70,13 +70,22 @@ export const zCompletionMessageExplorePayload = z.object({
retriever_from: z.string().optional().default('explore_app'),
})
/**
* ConversationRenamePayload
*/
export const zConversationRenamePayload = z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
})
export const zConversationRenamePayload = z.intersection(
z.union([
z.object({
auto_generate: z.literal(true),
name: z.string().nullish(),
}),
z.object({
auto_generate: z.literal(false).optional().default(false),
name: z.string().regex(/.*\S.*/),
}),
]),
z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
}),
)
/**
* ResultResponse
@ -530,7 +539,7 @@ export const zPostInstalledAppsBody = zInstalledAppCreatePayload
export const zPostInstalledAppsResponse = zSimpleMessageResponse
export const zDeleteInstalledAppsByInstalledAppIdPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -541,7 +550,7 @@ export const zDeleteInstalledAppsByInstalledAppIdResponse = z.void()
export const zPatchInstalledAppsByInstalledAppIdBody = zInstalledAppUpdatePayload
export const zPatchInstalledAppsByInstalledAppIdPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -550,7 +559,7 @@ export const zPatchInstalledAppsByInstalledAppIdPath = z.object({
export const zPatchInstalledAppsByInstalledAppIdResponse = zSimpleResultMessageResponse
export const zPostInstalledAppsByInstalledAppIdAudioToTextPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -561,7 +570,7 @@ export const zPostInstalledAppsByInstalledAppIdAudioToTextResponse = zAudioTrans
export const zPostInstalledAppsByInstalledAppIdChatMessagesBody = zChatMessagePayload
export const zPostInstalledAppsByInstalledAppIdChatMessagesPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -570,7 +579,7 @@ export const zPostInstalledAppsByInstalledAppIdChatMessagesPath = z.object({
export const zPostInstalledAppsByInstalledAppIdChatMessagesResponse = zGeneratedAppResponse
export const zPostInstalledAppsByInstalledAppIdChatMessagesByTaskIdStopPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
task_id: z.string(),
})
@ -584,7 +593,7 @@ export const zPostInstalledAppsByInstalledAppIdCompletionMessagesBody
= zCompletionMessageExplorePayload
export const zPostInstalledAppsByInstalledAppIdCompletionMessagesPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -593,7 +602,7 @@ export const zPostInstalledAppsByInstalledAppIdCompletionMessagesPath = z.object
export const zPostInstalledAppsByInstalledAppIdCompletionMessagesResponse = zGeneratedAppResponse
export const zPostInstalledAppsByInstalledAppIdCompletionMessagesByTaskIdStopPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
task_id: z.string(),
})
@ -604,7 +613,7 @@ export const zPostInstalledAppsByInstalledAppIdCompletionMessagesByTaskIdStopRes
= zSimpleResultResponse
export const zGetInstalledAppsByInstalledAppIdConversationsPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
export const zGetInstalledAppsByInstalledAppIdConversationsQuery = z.object({
@ -620,8 +629,8 @@ export const zGetInstalledAppsByInstalledAppIdConversationsResponse
= zConversationInfiniteScrollPagination
export const zDeleteInstalledAppsByInstalledAppIdConversationsByCIdPath = z.object({
c_id: z.string(),
installed_app_id: z.string(),
c_id: z.uuid(),
installed_app_id: z.uuid(),
})
/**
@ -633,8 +642,8 @@ export const zPostInstalledAppsByInstalledAppIdConversationsByCIdNameBody
= zConversationRenamePayload
export const zPostInstalledAppsByInstalledAppIdConversationsByCIdNamePath = z.object({
c_id: z.string(),
installed_app_id: z.string(),
c_id: z.uuid(),
installed_app_id: z.uuid(),
})
/**
@ -643,8 +652,8 @@ export const zPostInstalledAppsByInstalledAppIdConversationsByCIdNamePath = z.ob
export const zPostInstalledAppsByInstalledAppIdConversationsByCIdNameResponse = zSimpleConversation
export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdPinPath = z.object({
c_id: z.string(),
installed_app_id: z.string(),
c_id: z.uuid(),
installed_app_id: z.uuid(),
})
/**
@ -653,8 +662,8 @@ export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdPinPath = z.ob
export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdPinResponse = zResultResponse
export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdUnpinPath = z.object({
c_id: z.string(),
installed_app_id: z.string(),
c_id: z.uuid(),
installed_app_id: z.uuid(),
})
/**
@ -663,7 +672,7 @@ export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdUnpinPath = z.
export const zPatchInstalledAppsByInstalledAppIdConversationsByCIdUnpinResponse = zResultResponse
export const zGetInstalledAppsByInstalledAppIdMessagesPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
export const zGetInstalledAppsByInstalledAppIdMessagesQuery = z.object({
@ -681,8 +690,8 @@ export const zPostInstalledAppsByInstalledAppIdMessagesByMessageIdFeedbacksBody
= zMessageFeedbackPayload
export const zPostInstalledAppsByInstalledAppIdMessagesByMessageIdFeedbacksPath = z.object({
installed_app_id: z.string(),
message_id: z.string(),
installed_app_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -692,8 +701,8 @@ export const zPostInstalledAppsByInstalledAppIdMessagesByMessageIdFeedbacksRespo
= zResultResponse
export const zGetInstalledAppsByInstalledAppIdMessagesByMessageIdMoreLikeThisPath = z.object({
installed_app_id: z.string(),
message_id: z.string(),
installed_app_id: z.uuid(),
message_id: z.uuid(),
})
export const zGetInstalledAppsByInstalledAppIdMessagesByMessageIdMoreLikeThisQuery = z.object({
@ -707,8 +716,8 @@ export const zGetInstalledAppsByInstalledAppIdMessagesByMessageIdMoreLikeThisRes
= zGeneratedAppResponse
export const zGetInstalledAppsByInstalledAppIdMessagesByMessageIdSuggestedQuestionsPath = z.object({
installed_app_id: z.string(),
message_id: z.string(),
installed_app_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -718,7 +727,7 @@ export const zGetInstalledAppsByInstalledAppIdMessagesByMessageIdSuggestedQuesti
= zSuggestedQuestionsResponse
export const zGetInstalledAppsByInstalledAppIdMetaPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -727,7 +736,7 @@ export const zGetInstalledAppsByInstalledAppIdMetaPath = z.object({
export const zGetInstalledAppsByInstalledAppIdMetaResponse = zExploreAppMetaResponse
export const zGetInstalledAppsByInstalledAppIdParametersPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -736,7 +745,7 @@ export const zGetInstalledAppsByInstalledAppIdParametersPath = z.object({
export const zGetInstalledAppsByInstalledAppIdParametersResponse = zParameters
export const zGetInstalledAppsByInstalledAppIdSavedMessagesPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
export const zGetInstalledAppsByInstalledAppIdSavedMessagesQuery = z.object({
@ -753,7 +762,7 @@ export const zGetInstalledAppsByInstalledAppIdSavedMessagesResponse
export const zPostInstalledAppsByInstalledAppIdSavedMessagesBody = zSavedMessageCreatePayload
export const zPostInstalledAppsByInstalledAppIdSavedMessagesPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -762,8 +771,8 @@ export const zPostInstalledAppsByInstalledAppIdSavedMessagesPath = z.object({
export const zPostInstalledAppsByInstalledAppIdSavedMessagesResponse = zResultResponse
export const zDeleteInstalledAppsByInstalledAppIdSavedMessagesByMessageIdPath = z.object({
installed_app_id: z.string(),
message_id: z.string(),
installed_app_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -774,7 +783,7 @@ export const zDeleteInstalledAppsByInstalledAppIdSavedMessagesByMessageIdRespons
export const zPostInstalledAppsByInstalledAppIdTextToAudioBody = zTextToAudioPayload
export const zPostInstalledAppsByInstalledAppIdTextToAudioPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -785,7 +794,7 @@ export const zPostInstalledAppsByInstalledAppIdTextToAudioResponse = zAudioBinar
export const zPostInstalledAppsByInstalledAppIdWorkflowsRunBody = zWorkflowRunPayload
export const zPostInstalledAppsByInstalledAppIdWorkflowsRunPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
})
/**
@ -794,7 +803,7 @@ export const zPostInstalledAppsByInstalledAppIdWorkflowsRunPath = z.object({
export const zPostInstalledAppsByInstalledAppIdWorkflowsRunResponse = zGeneratedAppResponse
export const zPostInstalledAppsByInstalledAppIdWorkflowsTasksByTaskIdStopPath = z.object({
installed_app_id: z.string(),
installed_app_id: z.uuid(),
task_id: z.string(),
})

2
packages/contracts/generated/api/console/notion/zod.gen.ts
View File

@ -48,7 +48,7 @@ export const zNotionIntegrateInfoListResponse = z.object({
})
export const zGetNotionPagesByPageIdByPageTypePreviewPath = z.object({
page_id: z.string(),
page_id: z.uuid(),
page_type: z.string(),
})

2
packages/contracts/generated/api/console/oauth/zod.gen.ts
View File

@ -117,7 +117,7 @@ export const zGetOauthDataSourceByProviderPath = z.object({
export const zGetOauthDataSourceByProviderResponse = zOAuthDataSourceResponse
export const zGetOauthDataSourceByProviderByBindingIdSyncPath = z.object({
binding_id: z.string(),
binding_id: z.uuid(),
provider: z.string(),
})

90
packages/contracts/generated/api/console/rag/zod.gen.ts
View File

@ -777,7 +777,7 @@ export const zGetRagPipelinesRecommendedPluginsQuery = z.object({
export const zGetRagPipelinesRecommendedPluginsResponse = zRagPipelineOpaqueResponse
export const zPostRagPipelinesTransformDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -810,7 +810,7 @@ export const zGetRagPipelinesByPipelineIdExportsQuery = z.object({
export const zGetRagPipelinesByPipelineIdExportsResponse = zSimpleDataResponse
export const zGetRagPipelinesByPipelineIdWorkflowRunsPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowRunsQuery = z.object({
@ -824,7 +824,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowRunsQuery = z.object({
export const zGetRagPipelinesByPipelineIdWorkflowRunsResponse = zWorkflowRunPaginationResponse
export const zPostRagPipelinesByPipelineIdWorkflowRunsTasksByTaskIdStopPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
task_id: z.string(),
})
@ -835,8 +835,8 @@ export const zPostRagPipelinesByPipelineIdWorkflowRunsTasksByTaskIdStopResponse
= zSimpleResultResponse
export const zGetRagPipelinesByPipelineIdWorkflowRunsByRunIdPath = z.object({
pipeline_id: z.string(),
run_id: z.string(),
pipeline_id: z.uuid(),
run_id: z.uuid(),
})
/**
@ -845,8 +845,8 @@ export const zGetRagPipelinesByPipelineIdWorkflowRunsByRunIdPath = z.object({
export const zGetRagPipelinesByPipelineIdWorkflowRunsByRunIdResponse = zWorkflowRunDetailResponse
export const zGetRagPipelinesByPipelineIdWorkflowRunsByRunIdNodeExecutionsPath = z.object({
pipeline_id: z.string(),
run_id: z.string(),
pipeline_id: z.uuid(),
run_id: z.uuid(),
})
/**
@ -856,7 +856,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowRunsByRunIdNodeExecutionsRespon
= zWorkflowRunNodeExecutionListResponse
export const zGetRagPipelinesByPipelineIdWorkflowsPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsQuery = z.object({
@ -872,7 +872,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsQuery = z.object({
export const zGetRagPipelinesByPipelineIdWorkflowsResponse = zWorkflowPaginationResponse
export const zGetRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -884,7 +884,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsRes
export const zGetRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsByBlockTypePath
= z.object({
block_type: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsByBlockTypeQuery
@ -899,7 +899,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDefaultWorkflowBlockConfigsByB
= zDefaultBlockConfigResponse
export const zGetRagPipelinesByPipelineIdWorkflowsDraftPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -910,7 +910,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftResponse = zWorkflowRespo
export const zPostRagPipelinesByPipelineIdWorkflowsDraftBody = zDraftWorkflowSyncPayload
export const zPostRagPipelinesByPipelineIdWorkflowsDraftPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -923,7 +923,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftDatasourceNodesByNodeIdR
export const zPostRagPipelinesByPipelineIdWorkflowsDraftDatasourceNodesByNodeIdRunPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -936,7 +936,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftDatasourceVariablesInspe
= zDatasourceVariablesPayload
export const zPostRagPipelinesByPipelineIdWorkflowsDraftDatasourceVariablesInspectPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -946,7 +946,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftDatasourceVariablesInspe
= zWorkflowRunNodeExecutionResponse
export const zGetRagPipelinesByPipelineIdWorkflowsDraftEnvironmentVariablesPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -960,7 +960,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftIterationNodesByNodeIdRu
export const zPostRagPipelinesByPipelineIdWorkflowsDraftIterationNodesByNodeIdRunPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -973,7 +973,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftLoopNodesByNodeIdRunBody
export const zPostRagPipelinesByPipelineIdWorkflowsDraftLoopNodesByNodeIdRunPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -984,7 +984,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftLoopNodesByNodeIdRunResp
export const zGetRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdLastRunPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -998,7 +998,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdRunBody
export const zPostRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdRunPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1009,7 +1009,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdRunResponse
export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariablesPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1019,7 +1019,7 @@ export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariables
export const zGetRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariablesPath = z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1029,7 +1029,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftNodesByNodeIdVariablesRes
= zWorkflowDraftVariableList
export const zGetRagPipelinesByPipelineIdWorkflowsDraftPreProcessingParametersPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsDraftPreProcessingParametersQuery = z.object({
@ -1043,7 +1043,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftPreProcessingParametersRe
= zRagPipelineStepParametersResponse
export const zGetRagPipelinesByPipelineIdWorkflowsDraftProcessingParametersPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsDraftProcessingParametersQuery = z.object({
@ -1059,7 +1059,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftProcessingParametersRespo
export const zPostRagPipelinesByPipelineIdWorkflowsDraftRunBody = zDraftWorkflowRunPayload
export const zPostRagPipelinesByPipelineIdWorkflowsDraftRunPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1068,7 +1068,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsDraftRunPath = z.object({
export const zPostRagPipelinesByPipelineIdWorkflowsDraftRunResponse = zRagPipelineOpaqueResponse
export const zGetRagPipelinesByPipelineIdWorkflowsDraftSystemVariablesPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1078,7 +1078,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftSystemVariablesResponse
= zWorkflowDraftVariableList
export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1087,7 +1087,7 @@ export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesPath = z.obje
export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesResponse = z.void()
export const zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesQuery = z.object({
@ -1102,8 +1102,8 @@ export const zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesResponse
= zWorkflowDraftVariableListWithoutValue
export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdPath = z.object({
pipeline_id: z.string(),
variable_id: z.string(),
pipeline_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -1112,8 +1112,8 @@ export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdP
export const zDeleteRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResponse = z.void()
export const zGetRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdPath = z.object({
pipeline_id: z.string(),
variable_id: z.string(),
pipeline_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -1126,8 +1126,8 @@ export const zPatchRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdBo
= zWorkflowDraftVariablePatchPayload
export const zPatchRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdPath = z.object({
pipeline_id: z.string(),
variable_id: z.string(),
pipeline_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -1137,8 +1137,8 @@ export const zPatchRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdRe
= zWorkflowDraftVariable
export const zPutRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResetPath = z.object({
pipeline_id: z.string(),
variable_id: z.string(),
pipeline_id: z.uuid(),
variable_id: z.uuid(),
})
export const zPutRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdResetResponse = z.union(
@ -1146,7 +1146,7 @@ export const zPutRagPipelinesByPipelineIdWorkflowsDraftVariablesByVariableIdRese
)
export const zGetRagPipelinesByPipelineIdWorkflowsPublishPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1155,7 +1155,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsPublishPath = z.object({
export const zGetRagPipelinesByPipelineIdWorkflowsPublishResponse = zWorkflowResponse
export const zPostRagPipelinesByPipelineIdWorkflowsPublishPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1170,7 +1170,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNod
export const zPostRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNodeIdPreviewPath
= z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1185,7 +1185,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNod
export const zPostRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNodeIdRunPath
= z.object({
node_id: z.string(),
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1195,7 +1195,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsPublishedDatasourceNodesByNod
= zRagPipelineOpaqueResponse
export const zGetRagPipelinesByPipelineIdWorkflowsPublishedPreProcessingParametersPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsPublishedPreProcessingParametersQuery = z.object({
@ -1209,7 +1209,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsPublishedPreProcessingParamete
= zRagPipelineStepParametersResponse
export const zGetRagPipelinesByPipelineIdWorkflowsPublishedProcessingParametersPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
export const zGetRagPipelinesByPipelineIdWorkflowsPublishedProcessingParametersQuery = z.object({
@ -1225,7 +1225,7 @@ export const zGetRagPipelinesByPipelineIdWorkflowsPublishedProcessingParametersR
export const zPostRagPipelinesByPipelineIdWorkflowsPublishedRunBody = zPublishedWorkflowRunPayload
export const zPostRagPipelinesByPipelineIdWorkflowsPublishedRunPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
})
/**
@ -1234,7 +1234,7 @@ export const zPostRagPipelinesByPipelineIdWorkflowsPublishedRunPath = z.object({
export const zPostRagPipelinesByPipelineIdWorkflowsPublishedRunResponse = zRagPipelineOpaqueResponse
export const zDeleteRagPipelinesByPipelineIdWorkflowsByWorkflowIdPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
workflow_id: z.string(),
})
@ -1246,7 +1246,7 @@ export const zDeleteRagPipelinesByPipelineIdWorkflowsByWorkflowIdResponse = z.vo
export const zPatchRagPipelinesByPipelineIdWorkflowsByWorkflowIdBody = zWorkflowUpdatePayload
export const zPatchRagPipelinesByPipelineIdWorkflowsByWorkflowIdPath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
workflow_id: z.string(),
})
@ -1256,7 +1256,7 @@ export const zPatchRagPipelinesByPipelineIdWorkflowsByWorkflowIdPath = z.object(
export const zPatchRagPipelinesByPipelineIdWorkflowsByWorkflowIdResponse = zWorkflowResponse
export const zPostRagPipelinesByPipelineIdWorkflowsByWorkflowIdRestorePath = z.object({
pipeline_id: z.string(),
pipeline_id: z.uuid(),
workflow_id: z.string(),
})

68
packages/contracts/generated/api/console/snippets/zod.gen.ts
View File

@ -387,7 +387,7 @@ export const zWorkflowDraftVariableListWithoutValue = z.object({
})
export const zGetSnippetsBySnippetIdWorkflowRunsPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
export const zGetSnippetsBySnippetIdWorkflowRunsQuery = z.object({
@ -401,7 +401,7 @@ export const zGetSnippetsBySnippetIdWorkflowRunsQuery = z.object({
export const zGetSnippetsBySnippetIdWorkflowRunsResponse = zWorkflowRunPaginationResponse
export const zPostSnippetsBySnippetIdWorkflowRunsTasksByTaskIdStopPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
task_id: z.string(),
})
@ -411,8 +411,8 @@ export const zPostSnippetsBySnippetIdWorkflowRunsTasksByTaskIdStopPath = z.objec
export const zPostSnippetsBySnippetIdWorkflowRunsTasksByTaskIdStopResponse = zSimpleResultResponse
export const zGetSnippetsBySnippetIdWorkflowRunsByRunIdPath = z.object({
run_id: z.string(),
snippet_id: z.string(),
run_id: z.uuid(),
snippet_id: z.uuid(),
})
/**
@ -421,8 +421,8 @@ export const zGetSnippetsBySnippetIdWorkflowRunsByRunIdPath = z.object({
export const zGetSnippetsBySnippetIdWorkflowRunsByRunIdResponse = zWorkflowRunDetailResponse
export const zGetSnippetsBySnippetIdWorkflowRunsByRunIdNodeExecutionsPath = z.object({
run_id: z.string(),
snippet_id: z.string(),
run_id: z.uuid(),
snippet_id: z.uuid(),
})
/**
@ -432,7 +432,7 @@ export const zGetSnippetsBySnippetIdWorkflowRunsByRunIdNodeExecutionsResponse
= zWorkflowRunNodeExecutionListResponse
export const zGetSnippetsBySnippetIdWorkflowsPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
export const zGetSnippetsBySnippetIdWorkflowsQuery = z.object({
@ -446,7 +446,7 @@ export const zGetSnippetsBySnippetIdWorkflowsQuery = z.object({
export const zGetSnippetsBySnippetIdWorkflowsResponse = zWorkflowPaginationResponse
export const zGetSnippetsBySnippetIdWorkflowsDefaultWorkflowBlockConfigsPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -456,7 +456,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDefaultWorkflowBlockConfigsResponse
= zDefaultBlockConfigsResponse
export const zGetSnippetsBySnippetIdWorkflowsDraftPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -467,7 +467,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftResponse = zSnippetWorkflowRes
export const zPostSnippetsBySnippetIdWorkflowsDraftBody = zSnippetDraftSyncPayload
export const zPostSnippetsBySnippetIdWorkflowsDraftPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -476,7 +476,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftPath = z.object({
export const zPostSnippetsBySnippetIdWorkflowsDraftResponse = zWorkflowRestoreResponse
export const zGetSnippetsBySnippetIdWorkflowsDraftConfigPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -485,7 +485,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftConfigPath = z.object({
export const zGetSnippetsBySnippetIdWorkflowsDraftConfigResponse = zSnippetDraftConfigResponse
export const zGetSnippetsBySnippetIdWorkflowsDraftConversationVariablesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -495,7 +495,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftConversationVariablesResponse
= zWorkflowDraftVariableList
export const zGetSnippetsBySnippetIdWorkflowsDraftEnvironmentVariablesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -509,7 +509,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftIterationNodesByNodeIdRunBody
export const zPostSnippetsBySnippetIdWorkflowsDraftIterationNodesByNodeIdRunPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -523,7 +523,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftLoopNodesByNodeIdRunBody
export const zPostSnippetsBySnippetIdWorkflowsDraftLoopNodesByNodeIdRunPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -534,7 +534,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftLoopNodesByNodeIdRunResponse
export const zGetSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdLastRunPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -548,7 +548,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdRunBody
export const zPostSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdRunPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -559,7 +559,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdRunResponse
export const zDeleteSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -569,7 +569,7 @@ export const zDeleteSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesRespo
export const zGetSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesPath = z.object({
node_id: z.string(),
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -581,7 +581,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftNodesByNodeIdVariablesResponse
export const zPostSnippetsBySnippetIdWorkflowsDraftRunBody = zSnippetDraftRunPayload
export const zPostSnippetsBySnippetIdWorkflowsDraftRunPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -590,7 +590,7 @@ export const zPostSnippetsBySnippetIdWorkflowsDraftRunPath = z.object({
export const zPostSnippetsBySnippetIdWorkflowsDraftRunResponse = zGeneratedAppResponse
export const zGetSnippetsBySnippetIdWorkflowsDraftSystemVariablesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -600,7 +600,7 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftSystemVariablesResponse
= zWorkflowDraftVariableList
export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -609,7 +609,7 @@ export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesPath = z.object({
export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesResponse = z.void()
export const zGetSnippetsBySnippetIdWorkflowsDraftVariablesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
export const zGetSnippetsBySnippetIdWorkflowsDraftVariablesQuery = z.object({
@ -624,8 +624,8 @@ export const zGetSnippetsBySnippetIdWorkflowsDraftVariablesResponse
= zWorkflowDraftVariableListWithoutValue
export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdPath = z.object({
snippet_id: z.string(),
variable_id: z.string(),
snippet_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -634,8 +634,8 @@ export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdPath =
export const zDeleteSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdResponse = z.void()
export const zGetSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdPath = z.object({
snippet_id: z.string(),
variable_id: z.string(),
snippet_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -648,8 +648,8 @@ export const zPatchSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdBody
= zWorkflowDraftVariableUpdatePayload
export const zPatchSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdPath = z.object({
snippet_id: z.string(),
variable_id: z.string(),
snippet_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -659,8 +659,8 @@ export const zPatchSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdRespons
= zWorkflowDraftVariable
export const zPutSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdResetPath = z.object({
snippet_id: z.string(),
variable_id: z.string(),
snippet_id: z.uuid(),
variable_id: z.uuid(),
})
export const zPutSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdResetResponse = z.union([
@ -669,7 +669,7 @@ export const zPutSnippetsBySnippetIdWorkflowsDraftVariablesByVariableIdResetResp
])
export const zGetSnippetsBySnippetIdWorkflowsPublishPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -680,7 +680,7 @@ export const zGetSnippetsBySnippetIdWorkflowsPublishResponse = zSnippetWorkflowR
export const zPostSnippetsBySnippetIdWorkflowsPublishBody = zPublishWorkflowPayload
export const zPostSnippetsBySnippetIdWorkflowsPublishPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -689,7 +689,7 @@ export const zPostSnippetsBySnippetIdWorkflowsPublishPath = z.object({
export const zPostSnippetsBySnippetIdWorkflowsPublishResponse = zWorkflowPublishResponse
export const zPostSnippetsBySnippetIdWorkflowsByWorkflowIdRestorePath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
workflow_id: z.string(),
})

4
packages/contracts/generated/api/console/tags/zod.gen.ts
View File

@ -52,7 +52,7 @@ export const zPostTagsBody = zTagBasePayload
export const zPostTagsResponse = zTagResponse
export const zDeleteTagsByTagIdPath = z.object({
tag_id: z.string(),
tag_id: z.uuid(),
})
/**
@ -63,7 +63,7 @@ export const zDeleteTagsByTagIdResponse = z.void()
export const zPatchTagsByTagIdBody = zTagUpdateRequestPayload
export const zPatchTagsByTagIdPath = z.object({
tag_id: z.string(),
tag_id: z.uuid(),
})
/**

26
packages/contracts/generated/api/console/trial-apps/zod.gen.ts
View File

@ -435,7 +435,7 @@ export const zSiteWritable = z.object({
})
export const zGetTrialAppsByAppIdPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -444,7 +444,7 @@ export const zGetTrialAppsByAppIdPath = z.object({
export const zGetTrialAppsByAppIdResponse = zTrialAppDetailWithSite
export const zPostTrialAppsByAppIdAudioToTextPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -455,7 +455,7 @@ export const zPostTrialAppsByAppIdAudioToTextResponse = zAudioTranscriptResponse
export const zPostTrialAppsByAppIdChatMessagesBody = zChatRequest
export const zPostTrialAppsByAppIdChatMessagesPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -466,7 +466,7 @@ export const zPostTrialAppsByAppIdChatMessagesResponse = zGeneratedAppResponse
export const zPostTrialAppsByAppIdCompletionMessagesBody = zCompletionRequest
export const zPostTrialAppsByAppIdCompletionMessagesPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -475,7 +475,7 @@ export const zPostTrialAppsByAppIdCompletionMessagesPath = z.object({
export const zPostTrialAppsByAppIdCompletionMessagesResponse = zGeneratedAppResponse
export const zGetTrialAppsByAppIdDatasetsPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
export const zGetTrialAppsByAppIdDatasetsQuery = z.object({
@ -490,8 +490,8 @@ export const zGetTrialAppsByAppIdDatasetsQuery = z.object({
export const zGetTrialAppsByAppIdDatasetsResponse = zTrialDatasetList
export const zGetTrialAppsByAppIdMessagesByMessageIdSuggestedQuestionsPath = z.object({
app_id: z.string(),
message_id: z.string(),
app_id: z.uuid(),
message_id: z.uuid(),
})
/**
@ -501,7 +501,7 @@ export const zGetTrialAppsByAppIdMessagesByMessageIdSuggestedQuestionsResponse
= zSuggestedQuestionsResponse
export const zGetTrialAppsByAppIdParametersPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -510,7 +510,7 @@ export const zGetTrialAppsByAppIdParametersPath = z.object({
export const zGetTrialAppsByAppIdParametersResponse = zParameters
export const zGetTrialAppsByAppIdSitePath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -521,7 +521,7 @@ export const zGetTrialAppsByAppIdSiteResponse = zSite
export const zPostTrialAppsByAppIdTextToAudioBody = zTextToSpeechRequest
export const zPostTrialAppsByAppIdTextToAudioPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -530,7 +530,7 @@ export const zPostTrialAppsByAppIdTextToAudioPath = z.object({
export const zPostTrialAppsByAppIdTextToAudioResponse = zAudioBinaryResponse
export const zGetTrialAppsByAppIdWorkflowsPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -541,7 +541,7 @@ export const zGetTrialAppsByAppIdWorkflowsResponse = zTrialWorkflow
export const zPostTrialAppsByAppIdWorkflowsRunBody = zWorkflowRunRequest
export const zPostTrialAppsByAppIdWorkflowsRunPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
})
/**
@ -550,7 +550,7 @@ export const zPostTrialAppsByAppIdWorkflowsRunPath = z.object({
export const zPostTrialAppsByAppIdWorkflowsRunResponse = zGeneratedAppResponse
export const zPostTrialAppsByAppIdWorkflowsTasksByTaskIdStopPath = z.object({
app_id: z.string(),
app_id: z.uuid(),
task_id: z.string(),
})

4
packages/contracts/generated/api/console/workspaces/types.gen.ts
View File

@ -32,7 +32,7 @@ export type AgentProviderListResponse = Array<{
}>
export type SnippetPagination = {
data?: Array<AnonymousInlineModelEfd591151Ea9>
data?: Array<AnonymousInlineModel744Ff9Cc03E6>
has_more?: boolean
limit?: number
page?: number
@ -769,7 +769,7 @@ export type WorkspaceCustomConfigResponse = {
replace_webapp_logo?: string | null
}
export type AnonymousInlineModelEfd591151Ea9 = {
export type AnonymousInlineModel744Ff9Cc03E6 = {
author_name?: string
created_at?: number
created_by?: string

22
packages/contracts/generated/api/console/workspaces/zod.gen.ts
View File

@ -776,7 +776,7 @@ export const zSnippet = z.object({
version: z.int().optional(),
})
export const zAnonymousInlineModelEfd591151Ea9 = z.object({
export const zAnonymousInlineModel744Ff9Cc03E6 = z.object({
author_name: z.string().optional(),
created_at: z.coerce
.bigint()
@ -810,7 +810,7 @@ export const zAnonymousInlineModelEfd591151Ea9 = z.object({
})
export const zSnippetPagination = z.object({
data: z.array(zAnonymousInlineModelEfd591151Ea9).optional(),
data: z.array(zAnonymousInlineModel744Ff9Cc03E6).optional(),
has_more: z.boolean().optional(),
limit: z.int().optional(),
page: z.int().optional(),
@ -1927,7 +1927,7 @@ export const zPostWorkspacesCurrentCustomizedSnippetsImportsByImportIdConfirmRes
= zSnippetImportResponse
export const zDeleteWorkspacesCurrentCustomizedSnippetsBySnippetIdPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -1936,7 +1936,7 @@ export const zDeleteWorkspacesCurrentCustomizedSnippetsBySnippetIdPath = z.objec
export const zDeleteWorkspacesCurrentCustomizedSnippetsBySnippetIdResponse = z.void()
export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -1947,7 +1947,7 @@ export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdResponse = zSnipp
export const zPatchWorkspacesCurrentCustomizedSnippetsBySnippetIdBody = zUpdateSnippetPayload
export const zPatchWorkspacesCurrentCustomizedSnippetsBySnippetIdPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -1956,7 +1956,7 @@ export const zPatchWorkspacesCurrentCustomizedSnippetsBySnippetIdPath = z.object
export const zPatchWorkspacesCurrentCustomizedSnippetsBySnippetIdResponse = zSnippet
export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdCheckDependenciesPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -1966,7 +1966,7 @@ export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdCheckDependencies
= zSnippetDependencyCheckResponse
export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdExportPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdExportQuery = z.object({
@ -1979,7 +1979,7 @@ export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdExportQuery = z.o
export const zGetWorkspacesCurrentCustomizedSnippetsBySnippetIdExportResponse = zTextFileResponse
export const zPostWorkspacesCurrentCustomizedSnippetsBySnippetIdUseCountIncrementPath = z.object({
snippet_id: z.string(),
snippet_id: z.uuid(),
})
/**
@ -2121,7 +2121,7 @@ export const zPostWorkspacesCurrentMembersSendOwnerTransferConfirmEmailResponse
= zSimpleResultDataResponse
export const zDeleteWorkspacesCurrentMembersByMemberIdPath = z.object({
member_id: z.string(),
member_id: z.uuid(),
})
/**
@ -2132,7 +2132,7 @@ export const zDeleteWorkspacesCurrentMembersByMemberIdResponse = zMemberActionTe
export const zPostWorkspacesCurrentMembersByMemberIdOwnerTransferBody = zOwnerTransferPayload
export const zPostWorkspacesCurrentMembersByMemberIdOwnerTransferPath = z.object({
member_id: z.string(),
member_id: z.uuid(),
})
/**
@ -2143,7 +2143,7 @@ export const zPostWorkspacesCurrentMembersByMemberIdOwnerTransferResponse = zSim
export const zPutWorkspacesCurrentMembersByMemberIdUpdateRoleBody = zMemberRoleUpdatePayload
export const zPutWorkspacesCurrentMembersByMemberIdUpdateRolePath = z.object({
member_id: z.string(),
member_id: z.uuid(),
})
/**

44
packages/contracts/generated/api/service/orpc.gen.ts
View File

@ -6,6 +6,7 @@ import * as z from 'zod'
import {
zDeleteAppsAnnotationsByAnnotationIdPath,
zDeleteAppsAnnotationsByAnnotationIdResponse,
zDeleteConversationsByCIdBody,
zDeleteConversationsByCIdPath,
zDeleteConversationsByCIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath,
@ -72,6 +73,7 @@ import {
zGetFormHumanInputByFormTokenResponse,
zGetInfoResponse,
zGetMessagesByMessageIdSuggestedPath,
zGetMessagesByMessageIdSuggestedQuery,
zGetMessagesByMessageIdSuggestedResponse,
zGetMessagesQuery,
zGetMessagesResponse,
@ -110,12 +112,15 @@ import {
zPostAppsAnnotationReplyByActionResponse,
zPostAppsAnnotationsBody,
zPostAppsAnnotationsResponse,
zPostAudioToTextBody,
zPostAudioToTextResponse,
zPostChatMessagesBody,
zPostChatMessagesByTaskIdStopBody,
zPostChatMessagesByTaskIdStopPath,
zPostChatMessagesByTaskIdStopResponse,
zPostChatMessagesResponse,
zPostCompletionMessagesBody,
zPostCompletionMessagesByTaskIdStopBody,
zPostCompletionMessagesByTaskIdStopPath,
zPostCompletionMessagesByTaskIdStopResponse,
zPostCompletionMessagesResponse,
@ -179,6 +184,7 @@ import {
zPostDatasetsByDatasetIdRetrieveBody,
zPostDatasetsByDatasetIdRetrievePath,
zPostDatasetsByDatasetIdRetrieveResponse,
zPostDatasetsPipelineFileUploadBody,
zPostDatasetsPipelineFileUploadResponse,
zPostDatasetsResponse,
zPostDatasetsTagsBindingBody,
@ -187,6 +193,7 @@ import {
zPostDatasetsTagsResponse,
zPostDatasetsTagsUnbindingBody,
zPostDatasetsTagsUnbindingResponse,
zPostFilesUploadBody,
zPostFilesUploadResponse,
zPostFormHumanInputByFormTokenBody,
zPostFormHumanInputByFormTokenPath,
@ -201,6 +208,7 @@ import {
zPostWorkflowsByWorkflowIdRunResponse,
zPostWorkflowsRunBody,
zPostWorkflowsRunResponse,
zPostWorkflowsTasksByTaskIdStopBody,
zPostWorkflowsTasksByTaskIdStopPath,
zPostWorkflowsTasksByTaskIdStopResponse,
zPutAppsAnnotationsByAnnotationIdBody,
@ -423,6 +431,7 @@ export const post3 = oc
summary: 'Convert audio to text using speech-to-text',
tags: ['service_api'],
})
.input(z.object({ body: zPostAudioToTextBody }))
.output(zPostAudioToTextResponse)
export const audioToText = {
@ -444,7 +453,12 @@ export const post4 = oc
summary: 'Stop a running chat message generation',
tags: ['service_api'],
})
.input(z.object({ params: zPostChatMessagesByTaskIdStopPath }))
.input(
z.object({
body: zPostChatMessagesByTaskIdStopBody,
params: zPostChatMessagesByTaskIdStopPath,
}),
)
.output(zPostChatMessagesByTaskIdStopResponse)
export const stop = {
@ -496,7 +510,12 @@ export const post6 = oc
summary: 'Stop a running completion task',
tags: ['service_api'],
})
.input(z.object({ params: zPostCompletionMessagesByTaskIdStopPath }))
.input(
z.object({
body: zPostCompletionMessagesByTaskIdStopBody,
params: zPostCompletionMessagesByTaskIdStopPath,
}),
)
.output(zPostCompletionMessagesByTaskIdStopResponse)
export const stop2 = {
@ -633,7 +652,7 @@ export const delete2 = oc
summary: 'Delete a specific conversation',
tags: ['service_api'],
})
.input(z.object({ params: zDeleteConversationsByCIdPath }))
.input(z.object({ body: zDeleteConversationsByCIdBody, params: zDeleteConversationsByCIdPath }))
.output(zDeleteConversationsByCIdResponse)
export const byCId = {
@ -685,6 +704,7 @@ export const post9 = oc
summary: 'Upload a file for use in conversations',
tags: ['service_api'],
})
.input(z.object({ body: zPostDatasetsPipelineFileUploadBody }))
.output(zPostDatasetsPipelineFileUploadResponse)
export const fileUpload = {
@ -835,9 +855,12 @@ export const post13 = oc
/**
* Create a new document by uploading a file
*
* @deprecated
*/
export const post14 = oc
.route({
deprecated: true,
description: 'Create a new document by uploading a file',
inputStructure: 'detailed',
method: 'POST',
@ -1937,6 +1960,7 @@ export const post33 = oc
summary: 'Upload a file for use in conversations',
tags: ['service_api'],
})
.input(z.object({ body: zPostFilesUploadBody }))
.output(zPostFilesUploadResponse)
export const upload = {
@ -2099,7 +2123,12 @@ export const get25 = oc
summary: 'Get suggested follow-up questions for a message',
tags: ['service_api'],
})
.input(z.object({ params: zGetMessagesByMessageIdSuggestedPath }))
.input(
z.object({
params: zGetMessagesByMessageIdSuggestedPath,
query: zGetMessagesByMessageIdSuggestedQuery,
}),
)
.output(zGetMessagesByMessageIdSuggestedResponse)
export const suggested = {
@ -2347,7 +2376,12 @@ export const post38 = oc
summary: 'Stop a running workflow task',
tags: ['service_api'],
})
.input(z.object({ params: zPostWorkflowsTasksByTaskIdStopPath }))
.input(
z.object({
body: zPostWorkflowsTasksByTaskIdStopBody,
params: zPostWorkflowsTasksByTaskIdStopPath,
}),
)
.output(zPostWorkflowsTasksByTaskIdStopResponse)
export const stop3 = {

297
packages/contracts/generated/api/service/types.gen.ts
View File

@ -115,6 +115,23 @@ export type ChatRequestPayload = {
workflow_id?: string | null
}
export type ChatRequestPayloadWithUser = {
auto_generate_name?: boolean
conversation_id?: string | null
files?: Array<{
[key: string]: unknown
}> | null
inputs: {
[key: string]: unknown
}
query: string
response_mode?: 'blocking' | 'streaming' | null
retriever_from?: string
trace_session_id?: string | null
user: string
workflow_id?: string | null
}
export type ChildChunkCreatePayload = {
content: string
}
@ -165,6 +182,20 @@ export type CompletionRequestPayload = {
trace_session_id?: string | null
}
export type CompletionRequestPayloadWithUser = {
files?: Array<{
[key: string]: unknown
}> | null
inputs: {
[key: string]: unknown
}
query?: string
response_mode?: 'blocking' | 'streaming' | null
retriever_from?: string
trace_session_id?: string | null
user: string
}
export type Condition = {
comparison_operator:
| '<'
@ -201,11 +232,37 @@ export type ConversationListQuery = {
sort_by?: '-created_at' | '-updated_at' | 'created_at' | 'updated_at'
}
export type ConversationRenamePayload = {
export type ConversationRenamePayload = (
| {
auto_generate: true
name?: string | null
}
| {
auto_generate?: false
name: string
}
) & {
auto_generate?: boolean
name?: string | null
}
export type ConversationRenamePayloadWithUser = (
| {
auto_generate: true
name?: string | null
user?: string
}
| {
auto_generate?: false
name: string
user?: string
}
) & {
auto_generate?: boolean
name?: string | null
user?: string
}
export type ConversationVariableInfiniteScrollPaginationResponse = {
data: Array<ConversationVariableResponse>
has_more: boolean
@ -226,6 +283,11 @@ export type ConversationVariableUpdatePayload = {
value: unknown
}
export type ConversationVariableUpdatePayloadWithUser = {
user?: string
value: unknown
}
export type ConversationVariablesQuery = {
last_id?: string | null
limit?: number
@ -651,7 +713,24 @@ export type DocumentTextCreatePayload = {
text: string
}
export type DocumentTextUpdate = {
export type DocumentTextUpdate = (
| {
doc_form?: string
doc_language?: string
name: string
process_rule?: ProcessRule | null
retrieval_model?: RetrievalModel | null
text: string
}
| {
doc_form?: string
doc_language?: string
name?: string | null
process_rule?: ProcessRule | null
retrieval_model?: RetrievalModel | null
text?: null
}
) & {
doc_form?: string
doc_language?: string
name?: string | null
@ -875,6 +954,14 @@ export type HumanInputFormSubmitPayload = {
}
}
export type HumanInputFormSubmitPayloadWithUser = {
action: string
inputs: {
[key: string]: JsonValue2
}
user: string
}
export type HumanInputFormSubmitResponse = {
[key: string]: never
}
@ -923,6 +1010,12 @@ export type MessageFeedbackPayload = {
rating?: 'dislike' | 'like' | null
}
export type MessageFeedbackPayloadWithUser = {
content?: string | null
rating?: 'dislike' | 'like' | null
user: string
}
export type MessageFile = {
belongs_to?: string | null
filename: string
@ -1025,6 +1118,10 @@ export type ModelStatus
export type ModelType = 'llm' | 'moderation' | 'rerank' | 'speech2text' | 'text-embedding' | 'tts'
export type OptionalServiceApiUserPayload = {
user?: string
}
export type ParagraphInputConfig = {
default?: StringSource | null
output_variable_name: string
@ -1112,6 +1209,10 @@ export type ProviderWithModelsResponse = {
tenant_id: string
}
export type RequiredServiceApiUserPayload = {
user: string
}
export type RerankingModel = {
reranking_model_name?: string | null
reranking_provider_name?: string | null
@ -1356,11 +1457,17 @@ export type TagDeletePayload = {
tag_id: string
}
export type TagUnbindingPayload = {
tag_id?: string | null
tag_ids?: Array<string>
target_id: string
}
export type TagUnbindingPayload
= | {
tag_id: string
tag_ids?: Array<string>
target_id: string
}
| {
tag_id?: string
tag_ids: Array<string>
target_id: string
}
export type TagUpdatePayload = {
name: string
@ -1374,6 +1481,14 @@ export type TextToAudioPayload = {
voice?: string | null
}
export type TextToAudioPayloadWithUser = {
message_id?: string | null
streaming?: boolean | null
text?: string | null
user?: string
voice?: string | null
}
export type UrlResponse = {
url: string
}
@ -1472,6 +1587,18 @@ export type WorkflowRunPayload = {
trace_session_id?: string | null
}
export type WorkflowRunPayloadWithUser = {
files?: Array<{
[key: string]: unknown
}> | null
inputs: {
[key: string]: unknown
}
response_mode?: 'blocking' | 'streaming' | null
trace_session_id?: string | null
user: string
}
export type WorkflowRunResponse = {
created_at?: number | null
elapsed_time?: number | number | null
@ -1544,6 +1671,7 @@ export type GetAppFeedbacksData = {
export type GetAppFeedbacksErrors = {
401: unknown
403: unknown
}
export type GetAppFeedbacksResponses = {
@ -1555,7 +1683,7 @@ export type GetAppFeedbacksResponse = GetAppFeedbacksResponses[keyof GetAppFeedb
export type PostAppsAnnotationReplyByActionData = {
body: AnnotationReplyActionPayload
path: {
action: string
action: 'disable' | 'enable'
}
query?: never
url: '/apps/annotation-reply/{action}'
@ -1563,6 +1691,7 @@ export type PostAppsAnnotationReplyByActionData = {
export type PostAppsAnnotationReplyByActionErrors = {
401: unknown
403: unknown
}
export type PostAppsAnnotationReplyByActionResponses = {
@ -1584,6 +1713,7 @@ export type GetAppsAnnotationReplyByActionStatusByJobIdData = {
export type GetAppsAnnotationReplyByActionStatusByJobIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1607,6 +1737,7 @@ export type GetAppsAnnotationsData = {
export type GetAppsAnnotationsErrors = {
401: unknown
403: unknown
}
export type GetAppsAnnotationsResponses = {
@ -1625,6 +1756,7 @@ export type PostAppsAnnotationsData = {
export type PostAppsAnnotationsErrors = {
401: unknown
403: unknown
}
export type PostAppsAnnotationsResponses = {
@ -1679,7 +1811,10 @@ export type PutAppsAnnotationsByAnnotationIdResponse
= PutAppsAnnotationsByAnnotationIdResponses[keyof PutAppsAnnotationsByAnnotationIdResponses]
export type PostAudioToTextData = {
body?: never
body: {
file: Blob | File
user?: string
}
path?: never
query?: never
url: '/audio-to-text'
@ -1688,6 +1823,7 @@ export type PostAudioToTextData = {
export type PostAudioToTextErrors = {
400: unknown
401: unknown
403: unknown
413: unknown
415: unknown
500: unknown
@ -1700,7 +1836,7 @@ export type PostAudioToTextResponses = {
export type PostAudioToTextResponse = PostAudioToTextResponses[keyof PostAudioToTextResponses]
export type PostChatMessagesData = {
body: ChatRequestPayload
body: ChatRequestPayloadWithUser
path?: never
query?: never
url: '/chat-messages'
@ -1709,6 +1845,7 @@ export type PostChatMessagesData = {
export type PostChatMessagesErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
429: unknown
500: unknown
@ -1721,7 +1858,7 @@ export type PostChatMessagesResponses = {
export type PostChatMessagesResponse = PostChatMessagesResponses[keyof PostChatMessagesResponses]
export type PostChatMessagesByTaskIdStopData = {
body?: never
body: RequiredServiceApiUserPayload
path: {
task_id: string
}
@ -1731,6 +1868,7 @@ export type PostChatMessagesByTaskIdStopData = {
export type PostChatMessagesByTaskIdStopErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1742,7 +1880,7 @@ export type PostChatMessagesByTaskIdStopResponse
= PostChatMessagesByTaskIdStopResponses[keyof PostChatMessagesByTaskIdStopResponses]
export type PostCompletionMessagesData = {
body: CompletionRequestPayload
body: CompletionRequestPayloadWithUser
path?: never
query?: never
url: '/completion-messages'
@ -1751,6 +1889,7 @@ export type PostCompletionMessagesData = {
export type PostCompletionMessagesErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
500: unknown
}
@ -1763,7 +1902,7 @@ export type PostCompletionMessagesResponse
= PostCompletionMessagesResponses[keyof PostCompletionMessagesResponses]
export type PostCompletionMessagesByTaskIdStopData = {
body?: never
body: RequiredServiceApiUserPayload
path: {
task_id: string
}
@ -1773,6 +1912,7 @@ export type PostCompletionMessagesByTaskIdStopData = {
export type PostCompletionMessagesByTaskIdStopErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1790,12 +1930,14 @@ export type GetConversationsData = {
last_id?: string
limit?: number
sort_by?: '-created_at' | '-updated_at' | 'created_at' | 'updated_at'
user?: string
}
url: '/conversations'
}
export type GetConversationsErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1806,7 +1948,7 @@ export type GetConversationsResponses = {
export type GetConversationsResponse = GetConversationsResponses[keyof GetConversationsResponses]
export type DeleteConversationsByCIdData = {
body?: never
body: OptionalServiceApiUserPayload
path: {
c_id: string
}
@ -1816,6 +1958,7 @@ export type DeleteConversationsByCIdData = {
export type DeleteConversationsByCIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1827,7 +1970,7 @@ export type DeleteConversationsByCIdResponse
= DeleteConversationsByCIdResponses[keyof DeleteConversationsByCIdResponses]
export type PostConversationsByCIdNameData = {
body: ConversationRenamePayload
body: ConversationRenamePayloadWithUser
path: {
c_id: string
}
@ -1837,6 +1980,7 @@ export type PostConversationsByCIdNameData = {
export type PostConversationsByCIdNameErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1855,6 +1999,7 @@ export type GetConversationsByCIdVariablesData = {
query?: {
last_id?: string
limit?: number
user?: string
variable_name?: string
}
url: '/conversations/{c_id}/variables'
@ -1862,6 +2007,7 @@ export type GetConversationsByCIdVariablesData = {
export type GetConversationsByCIdVariablesErrors = {
401: unknown
403: unknown
404: unknown
}
@ -1873,7 +2019,7 @@ export type GetConversationsByCIdVariablesResponse
= GetConversationsByCIdVariablesResponses[keyof GetConversationsByCIdVariablesResponses]
export type PutConversationsByCIdVariablesByVariableIdData = {
body: ConversationVariableUpdatePayload
body: ConversationVariableUpdatePayloadWithUser
path: {
c_id: string
variable_id: string
@ -1885,6 +2031,7 @@ export type PutConversationsByCIdVariablesByVariableIdData = {
export type PutConversationsByCIdVariablesByVariableIdErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
}
@ -1910,6 +2057,7 @@ export type GetDatasetsData = {
export type GetDatasetsErrors = {
401: unknown
403: unknown
}
export type GetDatasetsResponses = {
@ -1928,6 +2076,7 @@ export type PostDatasetsData = {
export type PostDatasetsErrors = {
400: unknown
401: unknown
403: unknown
}
export type PostDatasetsResponses = {
@ -1937,7 +2086,9 @@ export type PostDatasetsResponses = {
export type PostDatasetsResponse = PostDatasetsResponses[keyof PostDatasetsResponses]
export type PostDatasetsPipelineFileUploadData = {
body?: never
body: {
file: Blob | File
}
path?: never
query?: never
url: '/datasets/pipeline/file-upload'
@ -1946,6 +2097,7 @@ export type PostDatasetsPipelineFileUploadData = {
export type PostDatasetsPipelineFileUploadErrors = {
400: unknown
401: unknown
403: unknown
413: unknown
415: unknown
}
@ -1985,6 +2137,7 @@ export type GetDatasetsTagsData = {
export type GetDatasetsTagsErrors = {
401: unknown
403: unknown
}
export type GetDatasetsTagsResponses = {
@ -2078,6 +2231,7 @@ export type DeleteDatasetsByDatasetIdData = {
export type DeleteDatasetsByDatasetIdErrors = {
401: unknown
403: unknown
404: unknown
409: unknown
}
@ -2148,6 +2302,7 @@ export type PostDatasetsByDatasetIdDocumentCreateByFileData = {
export type PostDatasetsByDatasetIdDocumentCreateByFileErrors = {
400: unknown
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdDocumentCreateByFileResponses = {
@ -2169,6 +2324,7 @@ export type PostDatasetsByDatasetIdDocumentCreateByTextData = {
export type PostDatasetsByDatasetIdDocumentCreateByTextErrors = {
400: unknown
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdDocumentCreateByTextResponses = {
@ -2193,6 +2349,7 @@ export type PostDatasetsByDatasetIdDocumentCreateByFile2Data = {
export type PostDatasetsByDatasetIdDocumentCreateByFile2Errors = {
400: unknown
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdDocumentCreateByFile2Responses = {
@ -2214,6 +2371,7 @@ export type PostDatasetsByDatasetIdDocumentCreateByText2Data = {
export type PostDatasetsByDatasetIdDocumentCreateByText2Errors = {
400: unknown
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdDocumentCreateByText2Responses = {
@ -2239,6 +2397,7 @@ export type GetDatasetsByDatasetIdDocumentsData = {
export type GetDatasetsByDatasetIdDocumentsErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2259,13 +2418,16 @@ export type PostDatasetsByDatasetIdDocumentsDownloadZipData = {
}
export type PostDatasetsByDatasetIdDocumentsDownloadZipErrors = {
401: unknown
403: unknown
404: unknown
401: Blob | File
403: Blob | File
404: Blob | File
}
export type PostDatasetsByDatasetIdDocumentsDownloadZipError
= PostDatasetsByDatasetIdDocumentsDownloadZipErrors[keyof PostDatasetsByDatasetIdDocumentsDownloadZipErrors]
export type PostDatasetsByDatasetIdDocumentsDownloadZipResponses = {
200: BinaryFileResponse
200: Blob | File
}
export type PostDatasetsByDatasetIdDocumentsDownloadZipResponse
@ -2282,6 +2444,7 @@ export type PostDatasetsByDatasetIdDocumentsMetadataData = {
export type PostDatasetsByDatasetIdDocumentsMetadataErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2295,7 +2458,7 @@ export type PostDatasetsByDatasetIdDocumentsMetadataResponse
export type PatchDatasetsByDatasetIdDocumentsStatusByActionData = {
body: DocumentStatusPayload
path: {
action: string
action: 'archive' | 'disable' | 'enable' | 'un_archive'
dataset_id: string
}
query?: never
@ -2328,6 +2491,7 @@ export type GetDatasetsByDatasetIdDocumentsByBatchIndexingStatusData = {
export type GetDatasetsByDatasetIdDocumentsByBatchIndexingStatusErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2401,6 +2565,7 @@ export type PatchDatasetsByDatasetIdDocumentsByDocumentIdData = {
export type PatchDatasetsByDatasetIdDocumentsByDocumentIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2451,6 +2616,7 @@ export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsData = {
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2474,6 +2640,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsData = {
export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
}
@ -2497,6 +2664,7 @@ export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdDat
export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2520,6 +2688,7 @@ export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdData =
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2543,6 +2712,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdData
export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2570,6 +2740,7 @@ export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildC
export type GetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2593,6 +2764,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChild
export type PostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2619,6 +2791,7 @@ export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export type DeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdErrors
= {
401: unknown
403: unknown
404: unknown
}
@ -2646,6 +2819,7 @@ export type PatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChil
export type PatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdErrors
= {
401: unknown
403: unknown
404: unknown
}
@ -2672,6 +2846,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileData = {
export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2694,6 +2869,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextData = {
export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2719,6 +2895,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Data = {
export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Errors = {
401: unknown
403: unknown
404: unknown
}
@ -2741,6 +2918,7 @@ export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Data = {
export type PostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Errors = {
401: unknown
403: unknown
404: unknown
}
@ -2762,6 +2940,7 @@ export type PostDatasetsByDatasetIdHitTestingData = {
export type PostDatasetsByDatasetIdHitTestingErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2783,6 +2962,7 @@ export type GetDatasetsByDatasetIdMetadataData = {
export type GetDatasetsByDatasetIdMetadataErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2804,6 +2984,7 @@ export type PostDatasetsByDatasetIdMetadataData = {
export type PostDatasetsByDatasetIdMetadataErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2825,6 +3006,7 @@ export type GetDatasetsByDatasetIdMetadataBuiltInData = {
export type GetDatasetsByDatasetIdMetadataBuiltInErrors = {
401: unknown
403: unknown
}
export type GetDatasetsByDatasetIdMetadataBuiltInResponses = {
@ -2837,7 +3019,7 @@ export type GetDatasetsByDatasetIdMetadataBuiltInResponse
export type PostDatasetsByDatasetIdMetadataBuiltInByActionData = {
body?: never
path: {
action: string
action: 'disable' | 'enable'
dataset_id: string
}
query?: never
@ -2846,6 +3028,7 @@ export type PostDatasetsByDatasetIdMetadataBuiltInByActionData = {
export type PostDatasetsByDatasetIdMetadataBuiltInByActionErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2868,6 +3051,7 @@ export type DeleteDatasetsByDatasetIdMetadataByMetadataIdData = {
export type DeleteDatasetsByDatasetIdMetadataByMetadataIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2890,6 +3074,7 @@ export type PatchDatasetsByDatasetIdMetadataByMetadataIdData = {
export type PatchDatasetsByDatasetIdMetadataByMetadataIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2913,6 +3098,7 @@ export type GetDatasetsByDatasetIdPipelineDatasourcePluginsData = {
export type GetDatasetsByDatasetIdPipelineDatasourcePluginsErrors = {
401: unknown
403: unknown
}
export type GetDatasetsByDatasetIdPipelineDatasourcePluginsResponses = {
@ -2934,6 +3120,7 @@ export type PostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunData = {
export type PostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunErrors = {
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunResponses = {
@ -2954,6 +3141,7 @@ export type PostDatasetsByDatasetIdPipelineRunData = {
export type PostDatasetsByDatasetIdPipelineRunErrors = {
401: unknown
403: unknown
}
export type PostDatasetsByDatasetIdPipelineRunResponses = {
@ -2974,6 +3162,7 @@ export type PostDatasetsByDatasetIdRetrieveData = {
export type PostDatasetsByDatasetIdRetrieveErrors = {
401: unknown
403: unknown
404: unknown
}
@ -2995,6 +3184,7 @@ export type GetDatasetsByDatasetIdTagsData = {
export type GetDatasetsByDatasetIdTagsErrors = {
401: unknown
403: unknown
}
export type GetDatasetsByDatasetIdTagsResponses = {
@ -3015,6 +3205,7 @@ export type GetEndUsersByEndUserIdData = {
export type GetEndUsersByEndUserIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3026,7 +3217,10 @@ export type GetEndUsersByEndUserIdResponse
= GetEndUsersByEndUserIdResponses[keyof GetEndUsersByEndUserIdResponses]
export type PostFilesUploadData = {
body?: never
body: {
file: Blob | File
user?: string
}
path?: never
query?: never
url: '/files/upload'
@ -3035,6 +3229,7 @@ export type PostFilesUploadData = {
export type PostFilesUploadErrors = {
400: unknown
401: unknown
403: unknown
413: unknown
415: unknown
}
@ -3052,18 +3247,22 @@ export type GetFilesByFileIdPreviewData = {
}
query?: {
as_attachment?: boolean
user?: string
}
url: '/files/{file_id}/preview'
}
export type GetFilesByFileIdPreviewErrors = {
401: unknown
403: unknown
404: unknown
401: Blob | File
403: Blob | File
404: Blob | File
}
export type GetFilesByFileIdPreviewError
= GetFilesByFileIdPreviewErrors[keyof GetFilesByFileIdPreviewErrors]
export type GetFilesByFileIdPreviewResponses = {
200: BinaryFileResponse
200: Blob | File
}
export type GetFilesByFileIdPreviewResponse
@ -3080,6 +3279,7 @@ export type GetFormHumanInputByFormTokenData = {
export type GetFormHumanInputByFormTokenErrors = {
401: unknown
403: unknown
404: unknown
412: unknown
}
@ -3092,7 +3292,7 @@ export type GetFormHumanInputByFormTokenResponse
= GetFormHumanInputByFormTokenResponses[keyof GetFormHumanInputByFormTokenResponses]
export type PostFormHumanInputByFormTokenData = {
body: HumanInputFormSubmitPayload
body: HumanInputFormSubmitPayloadWithUser
path: {
form_token: string
}
@ -3103,6 +3303,7 @@ export type PostFormHumanInputByFormTokenData = {
export type PostFormHumanInputByFormTokenErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
412: unknown
}
@ -3123,6 +3324,7 @@ export type GetInfoData = {
export type GetInfoErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3139,12 +3341,14 @@ export type GetMessagesData = {
conversation_id: string
first_id?: string
limit?: number
user?: string
}
url: '/messages'
}
export type GetMessagesErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3155,7 +3359,7 @@ export type GetMessagesResponses = {
export type GetMessagesResponse = GetMessagesResponses[keyof GetMessagesResponses]
export type PostMessagesByMessageIdFeedbacksData = {
body: MessageFeedbackPayload
body: MessageFeedbackPayloadWithUser
path: {
message_id: string
}
@ -3165,6 +3369,7 @@ export type PostMessagesByMessageIdFeedbacksData = {
export type PostMessagesByMessageIdFeedbacksErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3180,13 +3385,16 @@ export type GetMessagesByMessageIdSuggestedData = {
path: {
message_id: string
}
query?: never
query: {
user: string
}
url: '/messages/{message_id}/suggested'
}
export type GetMessagesByMessageIdSuggestedErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
500: unknown
}
@ -3207,6 +3415,7 @@ export type GetMetaData = {
export type GetMetaErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3225,6 +3434,7 @@ export type GetParametersData = {
export type GetParametersErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3253,20 +3463,23 @@ export type GetSiteResponses = {
export type GetSiteResponse = GetSiteResponses[keyof GetSiteResponses]
export type PostTextToAudioData = {
body: TextToAudioPayload
body: TextToAudioPayloadWithUser
path?: never
query?: never
url: '/text-to-audio'
}
export type PostTextToAudioErrors = {
400: unknown
401: unknown
500: unknown
400: Blob | File
401: Blob | File
403: Blob | File
500: Blob | File
}
export type PostTextToAudioError = PostTextToAudioErrors[keyof PostTextToAudioErrors]
export type PostTextToAudioResponses = {
200: AudioBinaryResponse
200: Blob | File
}
export type PostTextToAudioResponse = PostTextToAudioResponses[keyof PostTextToAudioResponses]
@ -3286,6 +3499,7 @@ export type GetWorkflowByTaskIdEventsData = {
export type GetWorkflowByTaskIdEventsErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3314,6 +3528,7 @@ export type GetWorkflowsLogsData = {
export type GetWorkflowsLogsErrors = {
401: unknown
403: unknown
}
export type GetWorkflowsLogsResponses = {
@ -3323,7 +3538,7 @@ export type GetWorkflowsLogsResponses = {
export type GetWorkflowsLogsResponse = GetWorkflowsLogsResponses[keyof GetWorkflowsLogsResponses]
export type PostWorkflowsRunData = {
body: WorkflowRunPayload
body: WorkflowRunPayloadWithUser
path?: never
query?: never
url: '/workflows/run'
@ -3332,6 +3547,7 @@ export type PostWorkflowsRunData = {
export type PostWorkflowsRunErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
429: unknown
500: unknown
@ -3354,6 +3570,7 @@ export type GetWorkflowsRunByWorkflowRunIdData = {
export type GetWorkflowsRunByWorkflowRunIdErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3365,7 +3582,7 @@ export type GetWorkflowsRunByWorkflowRunIdResponse
= GetWorkflowsRunByWorkflowRunIdResponses[keyof GetWorkflowsRunByWorkflowRunIdResponses]
export type PostWorkflowsTasksByTaskIdStopData = {
body?: never
body: RequiredServiceApiUserPayload
path: {
task_id: string
}
@ -3375,6 +3592,7 @@ export type PostWorkflowsTasksByTaskIdStopData = {
export type PostWorkflowsTasksByTaskIdStopErrors = {
401: unknown
403: unknown
404: unknown
}
@ -3386,7 +3604,7 @@ export type PostWorkflowsTasksByTaskIdStopResponse
= PostWorkflowsTasksByTaskIdStopResponses[keyof PostWorkflowsTasksByTaskIdStopResponses]
export type PostWorkflowsByWorkflowIdRunData = {
body: WorkflowRunPayload
body: WorkflowRunPayloadWithUser
path: {
workflow_id: string
}
@ -3397,6 +3615,7 @@ export type PostWorkflowsByWorkflowIdRunData = {
export type PostWorkflowsByWorkflowIdRunErrors = {
400: unknown
401: unknown
403: unknown
404: unknown
429: unknown
500: unknown

415
packages/contracts/generated/api/service/zod.gen.ts
View File

@ -140,6 +140,22 @@ export const zChatRequestPayload = z.object({
workflow_id: z.string().nullish(),
})
/**
* ChatRequestPayload
*/
export const zChatRequestPayloadWithUser = z.object({
auto_generate_name: z.boolean().optional().default(true),
conversation_id: z.string().nullish(),
files: z.array(z.record(z.string(), z.unknown())).nullish(),
inputs: z.record(z.string(), z.unknown()),
query: z.string(),
response_mode: z.enum(['blocking', 'streaming']).nullish(),
retriever_from: z.string().optional().default('dev'),
trace_session_id: z.string().nullish(),
user: z.string(),
workflow_id: z.string().nullish(),
})
/**
* ChildChunkCreatePayload
*/
@ -207,6 +223,19 @@ export const zCompletionRequestPayload = z.object({
trace_session_id: z.string().nullish(),
})
/**
* CompletionRequestPayload
*/
export const zCompletionRequestPayloadWithUser = z.object({
files: z.array(z.record(z.string(), z.unknown())).nullish(),
inputs: z.record(z.string(), z.unknown()),
query: z.string().optional().default(''),
response_mode: z.enum(['blocking', 'streaming']).nullish(),
retriever_from: z.string().optional().default('dev'),
trace_session_id: z.string().nullish(),
user: z.string(),
})
/**
* Condition
*
@ -249,13 +278,42 @@ export const zConversationListQuery = z.object({
.default('-updated_at'),
})
/**
* ConversationRenamePayload
*/
export const zConversationRenamePayload = z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
})
export const zConversationRenamePayload = z.intersection(
z.union([
z.object({
auto_generate: z.literal(true),
name: z.string().nullish(),
}),
z.object({
auto_generate: z.literal(false).optional().default(false),
name: z.string().regex(/.*\S.*/),
}),
]),
z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
}),
)
export const zConversationRenamePayloadWithUser = z.intersection(
z.union([
z.object({
auto_generate: z.literal(true),
name: z.string().nullish(),
user: z.string().optional(),
}),
z.object({
auto_generate: z.literal(false).optional().default(false),
name: z.string().regex(/.*\S.*/),
user: z.string().optional(),
}),
]),
z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
user: z.string().optional(),
}),
)
/**
* ConversationVariableResponse
@ -286,6 +344,14 @@ export const zConversationVariableUpdatePayload = z.object({
value: z.unknown(),
})
/**
* ConversationVariableUpdatePayload
*/
export const zConversationVariableUpdatePayloadWithUser = z.object({
user: z.string().optional(),
value: z.unknown(),
})
/**
* ConversationVariablesQuery
*/
@ -1071,6 +1137,15 @@ export const zHumanInputFormSubmitPayload = z.object({
inputs: z.record(z.string(), zJsonValue2),
})
/**
* HumanInputFormSubmitPayload
*/
export const zHumanInputFormSubmitPayloadWithUser = z.object({
action: z.string(),
inputs: z.record(z.string(), zJsonValue2),
user: z.string(),
})
/**
* KnowledgeTagResponse
*/
@ -1094,6 +1169,15 @@ export const zMessageFeedbackPayload = z.object({
rating: z.enum(['dislike', 'like']).nullish(),
})
/**
* MessageFeedbackPayload
*/
export const zMessageFeedbackPayloadWithUser = z.object({
content: z.string().nullish(),
rating: z.enum(['dislike', 'like']).nullish(),
user: z.string(),
})
/**
* MessageFile
*/
@ -1235,6 +1319,13 @@ export const zModelType = z.enum([
'tts',
])
/**
* ServiceApiUserPayload
*/
export const zOptionalServiceApiUserPayload = z.object({
user: z.string().optional(),
})
/**
* PermissionEnum
*
@ -1322,6 +1413,13 @@ export const zProviderWithModelsListResponse = z.object({
data: z.array(zProviderWithModelsResponse),
})
/**
* ServiceApiUserPayload
*/
export const zRequiredServiceApiUserPayload = z.object({
user: z.string(),
})
/**
* RerankingModel
*/
@ -1654,13 +1752,20 @@ export const zTagDeletePayload = z.object({
/**
* TagUnbindingPayload
*
* Accept the legacy single-tag Service API payload while exposing a normalized tag_ids list internally.
* Accepts either the legacy tag_id payload or the normalized tag_ids payload.
*/
export const zTagUnbindingPayload = z.object({
tag_id: z.string().nullish(),
tag_ids: z.array(z.string()).optional(),
target_id: z.string(),
})
export const zTagUnbindingPayload = z.union([
z.object({
tag_id: z.string(),
tag_ids: z.array(z.string()).min(1).optional(),
target_id: z.string(),
}),
z.object({
tag_id: z.string().optional(),
tag_ids: z.array(z.string()).min(1),
target_id: z.string(),
}),
])
/**
* TagUpdatePayload
@ -1680,6 +1785,17 @@ export const zTextToAudioPayload = z.object({
voice: z.string().nullish(),
})
/**
* TextToAudioPayload
*/
export const zTextToAudioPayloadWithUser = z.object({
message_id: z.string().nullish(),
streaming: z.boolean().nullish(),
text: z.string().nullish(),
user: z.string().optional(),
voice: z.string().nullish(),
})
/**
* UrlResponse
*/
@ -1899,17 +2015,34 @@ export const zDocumentTextCreatePayload = z.object({
text: z.string(),
})
/**
* DocumentTextUpdate
*/
export const zDocumentTextUpdate = z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
name: z.string().nullish(),
process_rule: zProcessRule.nullish(),
retrieval_model: zRetrievalModel.nullish(),
text: z.string().nullish(),
})
export const zDocumentTextUpdate = z.intersection(
z.union([
z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
name: z.string(),
process_rule: zProcessRule.nullish(),
retrieval_model: zRetrievalModel.nullish(),
text: z.string(),
}),
z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
name: z.string().nullish(),
process_rule: zProcessRule.nullish(),
retrieval_model: zRetrievalModel.nullish(),
text: z.null().optional(),
}),
]),
z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
name: z.string().nullish(),
process_rule: zProcessRule.nullish(),
retrieval_model: zRetrievalModel.nullish(),
text: z.string().nullish(),
}),
)
/**
* HitTestingPayload
@ -2005,6 +2138,17 @@ export const zWorkflowRunPayload = z.object({
trace_session_id: z.string().nullish(),
})
/**
* WorkflowRunPayload
*/
export const zWorkflowRunPayloadWithUser = z.object({
files: z.array(z.record(z.string(), z.unknown())).nullish(),
inputs: z.record(z.string(), z.unknown()),
response_mode: z.enum(['blocking', 'streaming']).nullish(),
trace_session_id: z.string().nullish(),
user: z.string(),
})
/**
* WorkflowRunResponse
*/
@ -2078,7 +2222,7 @@ export const zGetAppFeedbacksResponse = zAppFeedbackListResponse
export const zPostAppsAnnotationReplyByActionBody = zAnnotationReplyActionPayload
export const zPostAppsAnnotationReplyByActionPath = z.object({
action: z.string(),
action: z.enum(['disable', 'enable']),
})
/**
@ -2088,7 +2232,7 @@ export const zPostAppsAnnotationReplyByActionResponse = zAnnotationJobStatusResp
export const zGetAppsAnnotationReplyByActionStatusByJobIdPath = z.object({
action: z.string(),
job_id: z.string(),
job_id: z.uuid(),
})
/**
@ -2115,7 +2259,7 @@ export const zPostAppsAnnotationsBody = zAnnotationCreatePayload
export const zPostAppsAnnotationsResponse = zAnnotation
export const zDeleteAppsAnnotationsByAnnotationIdPath = z.object({
annotation_id: z.string(),
annotation_id: z.uuid(),
})
/**
@ -2126,7 +2270,7 @@ export const zDeleteAppsAnnotationsByAnnotationIdResponse = z.void()
export const zPutAppsAnnotationsByAnnotationIdBody = zAnnotationCreatePayload
export const zPutAppsAnnotationsByAnnotationIdPath = z.object({
annotation_id: z.string(),
annotation_id: z.uuid(),
})
/**
@ -2134,18 +2278,25 @@ export const zPutAppsAnnotationsByAnnotationIdPath = z.object({
*/
export const zPutAppsAnnotationsByAnnotationIdResponse = zAnnotation
export const zPostAudioToTextBody = z.object({
file: z.custom<Blob | File>(),
user: z.string().optional(),
})
/**
* Audio successfully transcribed
*/
export const zPostAudioToTextResponse = zAudioTranscriptResponse
export const zPostChatMessagesBody = zChatRequestPayload
export const zPostChatMessagesBody = zChatRequestPayloadWithUser
/**
* Message sent successfully
*/
export const zPostChatMessagesResponse = zGeneratedAppResponse
export const zPostChatMessagesByTaskIdStopBody = zRequiredServiceApiUserPayload
export const zPostChatMessagesByTaskIdStopPath = z.object({
task_id: z.string(),
})
@ -2155,13 +2306,15 @@ export const zPostChatMessagesByTaskIdStopPath = z.object({
*/
export const zPostChatMessagesByTaskIdStopResponse = zSimpleResultResponse
export const zPostCompletionMessagesBody = zCompletionRequestPayload
export const zPostCompletionMessagesBody = zCompletionRequestPayloadWithUser
/**
* Completion created successfully
*/
export const zPostCompletionMessagesResponse = zGeneratedAppResponse
export const zPostCompletionMessagesByTaskIdStopBody = zRequiredServiceApiUserPayload
export const zPostCompletionMessagesByTaskIdStopPath = z.object({
task_id: z.string(),
})
@ -2178,6 +2331,7 @@ export const zGetConversationsQuery = z.object({
.enum(['-created_at', '-updated_at', 'created_at', 'updated_at'])
.optional()
.default('-updated_at'),
user: z.string().optional(),
})
/**
@ -2185,8 +2339,10 @@ export const zGetConversationsQuery = z.object({
*/
export const zGetConversationsResponse = zConversationInfiniteScrollPagination
export const zDeleteConversationsByCIdBody = zOptionalServiceApiUserPayload
export const zDeleteConversationsByCIdPath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
/**
@ -2194,10 +2350,10 @@ export const zDeleteConversationsByCIdPath = z.object({
*/
export const zDeleteConversationsByCIdResponse = z.void()
export const zPostConversationsByCIdNameBody = zConversationRenamePayload
export const zPostConversationsByCIdNameBody = zConversationRenamePayloadWithUser
export const zPostConversationsByCIdNamePath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
/**
@ -2206,12 +2362,13 @@ export const zPostConversationsByCIdNamePath = z.object({
export const zPostConversationsByCIdNameResponse = zSimpleConversation
export const zGetConversationsByCIdVariablesPath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
export const zGetConversationsByCIdVariablesQuery = z.object({
last_id: z.string().optional(),
limit: z.int().gte(1).lte(100).optional().default(20),
user: z.string().optional(),
variable_name: z.string().min(1).max(255).optional(),
})
@ -2221,11 +2378,12 @@ export const zGetConversationsByCIdVariablesQuery = z.object({
export const zGetConversationsByCIdVariablesResponse
= zConversationVariableInfiniteScrollPaginationResponse
export const zPutConversationsByCIdVariablesByVariableIdBody = zConversationVariableUpdatePayload
export const zPutConversationsByCIdVariablesByVariableIdBody
= zConversationVariableUpdatePayloadWithUser
export const zPutConversationsByCIdVariablesByVariableIdPath = z.object({
c_id: z.string(),
variable_id: z.string(),
c_id: z.uuid(),
variable_id: z.uuid(),
})
/**
@ -2253,6 +2411,10 @@ export const zPostDatasetsBody = zDatasetCreatePayload
*/
export const zPostDatasetsResponse = zDatasetDetailResponse
export const zPostDatasetsPipelineFileUploadBody = z.object({
file: z.custom<Blob | File>(),
})
/**
* File uploaded successfully
*/
@ -2299,7 +2461,7 @@ export const zPostDatasetsTagsUnbindingBody = zTagUnbindingPayload
export const zPostDatasetsTagsUnbindingResponse = z.void()
export const zDeleteDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2308,7 +2470,7 @@ export const zDeleteDatasetsByDatasetIdPath = z.object({
export const zDeleteDatasetsByDatasetIdResponse = z.void()
export const zGetDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2319,7 +2481,7 @@ export const zGetDatasetsByDatasetIdResponse = zDatasetDetailWithPartialMembersR
export const zPatchDatasetsByDatasetIdBody = zDatasetUpdatePayload
export const zPatchDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2333,7 +2495,7 @@ export const zPostDatasetsByDatasetIdDocumentCreateByFileBody = z.object({
})
export const zPostDatasetsByDatasetIdDocumentCreateByFilePath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2344,7 +2506,7 @@ export const zPostDatasetsByDatasetIdDocumentCreateByFileResponse = zDocumentAnd
export const zPostDatasetsByDatasetIdDocumentCreateByTextBody = zDocumentTextCreatePayload
export const zPostDatasetsByDatasetIdDocumentCreateByTextPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2358,7 +2520,7 @@ export const zPostDatasetsByDatasetIdDocumentCreateByFile2Body = z.object({
})
export const zPostDatasetsByDatasetIdDocumentCreateByFile2Path = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2369,7 +2531,7 @@ export const zPostDatasetsByDatasetIdDocumentCreateByFile2Response = zDocumentAn
export const zPostDatasetsByDatasetIdDocumentCreateByText2Body = zDocumentTextCreatePayload
export const zPostDatasetsByDatasetIdDocumentCreateByText2Path = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2378,7 +2540,7 @@ export const zPostDatasetsByDatasetIdDocumentCreateByText2Path = z.object({
export const zPostDatasetsByDatasetIdDocumentCreateByText2Response = zDocumentAndBatchResponse
export const zGetDatasetsByDatasetIdDocumentsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsQuery = z.object({
@ -2396,18 +2558,18 @@ export const zGetDatasetsByDatasetIdDocumentsResponse = zDocumentListResponse
export const zPostDatasetsByDatasetIdDocumentsDownloadZipBody = zDocumentBatchDownloadZipPayload
export const zPostDatasetsByDatasetIdDocumentsDownloadZipPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
* ZIP archive generated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsDownloadZipResponse = zBinaryFileResponse
export const zPostDatasetsByDatasetIdDocumentsDownloadZipResponse = z.custom<Blob | File>()
export const zPostDatasetsByDatasetIdDocumentsMetadataBody = zMetadataOperationData
export const zPostDatasetsByDatasetIdDocumentsMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2418,8 +2580,8 @@ export const zPostDatasetsByDatasetIdDocumentsMetadataResponse = zDatasetMetadat
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionBody = zDocumentStatusPayload
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
action: z.enum(['archive', 'disable', 'enable', 'un_archive']),
dataset_id: z.uuid(),
})
/**
@ -2429,7 +2591,7 @@ export const zPatchDatasetsByDatasetIdDocumentsStatusByActionResponse = zSimpleR
export const zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusPath = z.object({
batch: z.string(),
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2439,8 +2601,8 @@ export const zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusResponse
= zDocumentStatusListResponse
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2449,8 +2611,8 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.void()
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery = z.object({
@ -2468,8 +2630,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdBody = z.object({
})
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2478,8 +2640,8 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdResponse = zDocumentAndBatchResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2488,8 +2650,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath = z.object
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse = zUrlResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.object({
@ -2507,8 +2669,8 @@ export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse = zSeg
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBody = zSegmentCreatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2518,9 +2680,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse
= zSegmentCreateListResponse
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2529,9 +2691,9 @@ export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdP
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse = z.void()
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2544,9 +2706,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBod
= zSegmentUpdatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2557,9 +2719,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdRes
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery
@ -2580,9 +2742,9 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2593,10 +2755,10 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChi
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_id: z.uuid(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2610,10 +2772,10 @@ export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdCh
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_id: z.uuid(),
dataset_id: z.uuid(),
document_id: z.uuid(),
segment_id: z.uuid(),
})
/**
@ -2628,8 +2790,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileBody = z.o
})
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFilePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2641,8 +2803,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileResponse
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextBody = zDocumentTextUpdate
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2657,8 +2819,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Body = z.
})
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Path = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2670,8 +2832,8 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Response
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Body = zDocumentTextUpdate
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Path = z.object({
dataset_id: z.string(),
document_id: z.string(),
dataset_id: z.uuid(),
document_id: z.uuid(),
})
/**
@ -2683,7 +2845,7 @@ export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Response
export const zPostDatasetsByDatasetIdHitTestingBody = zHitTestingPayload
export const zPostDatasetsByDatasetIdHitTestingPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2692,7 +2854,7 @@ export const zPostDatasetsByDatasetIdHitTestingPath = z.object({
export const zPostDatasetsByDatasetIdHitTestingResponse = zHitTestingResponse
export const zGetDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2703,7 +2865,7 @@ export const zGetDatasetsByDatasetIdMetadataResponse = zDatasetMetadataListRespo
export const zPostDatasetsByDatasetIdMetadataBody = zMetadataArgs
export const zPostDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2712,7 +2874,7 @@ export const zPostDatasetsByDatasetIdMetadataPath = z.object({
export const zPostDatasetsByDatasetIdMetadataResponse = zDatasetMetadataResponse
export const zGetDatasetsByDatasetIdMetadataBuiltInPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2721,8 +2883,8 @@ export const zGetDatasetsByDatasetIdMetadataBuiltInPath = z.object({
export const zGetDatasetsByDatasetIdMetadataBuiltInResponse = zDatasetMetadataBuiltInFieldsResponse
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
action: z.enum(['disable', 'enable']),
dataset_id: z.uuid(),
})
/**
@ -2732,8 +2894,8 @@ export const zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse
= zDatasetMetadataActionResponse
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
dataset_id: z.uuid(),
metadata_id: z.uuid(),
})
/**
@ -2744,8 +2906,8 @@ export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse = z.void()
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdBody = zMetadataUpdatePayload
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
dataset_id: z.uuid(),
metadata_id: z.uuid(),
})
/**
@ -2754,7 +2916,7 @@ export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse = zDatasetMetadataResponse
export const zGetDatasetsByDatasetIdPipelineDatasourcePluginsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
export const zGetDatasetsByDatasetIdPipelineDatasourcePluginsQuery = z.object({
@ -2771,7 +2933,7 @@ export const zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunBody
= zDatasourceNodeRunPayload
export const zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
node_id: z.string(),
})
@ -2784,7 +2946,7 @@ export const zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunResponse
export const zPostDatasetsByDatasetIdPipelineRunBody = zPipelineRunApiEntity
export const zPostDatasetsByDatasetIdPipelineRunPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2795,7 +2957,7 @@ export const zPostDatasetsByDatasetIdPipelineRunResponse = zGeneratedAppResponse
export const zPostDatasetsByDatasetIdRetrieveBody = zHitTestingPayload
export const zPostDatasetsByDatasetIdRetrievePath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2804,7 +2966,7 @@ export const zPostDatasetsByDatasetIdRetrievePath = z.object({
export const zPostDatasetsByDatasetIdRetrieveResponse = zHitTestingResponse
export const zGetDatasetsByDatasetIdTagsPath = z.object({
dataset_id: z.string(),
dataset_id: z.uuid(),
})
/**
@ -2813,7 +2975,7 @@ export const zGetDatasetsByDatasetIdTagsPath = z.object({
export const zGetDatasetsByDatasetIdTagsResponse = zDatasetBoundTagListResponse
export const zGetEndUsersByEndUserIdPath = z.object({
end_user_id: z.string(),
end_user_id: z.uuid(),
})
/**
@ -2821,23 +2983,29 @@ export const zGetEndUsersByEndUserIdPath = z.object({
*/
export const zGetEndUsersByEndUserIdResponse = zEndUserDetail
export const zPostFilesUploadBody = z.object({
file: z.custom<Blob | File>(),
user: z.string().optional(),
})
/**
* File uploaded successfully
*/
export const zPostFilesUploadResponse = zFileResponse
export const zGetFilesByFileIdPreviewPath = z.object({
file_id: z.string(),
file_id: z.uuid(),
})
export const zGetFilesByFileIdPreviewQuery = z.object({
as_attachment: z.boolean().optional().default(false),
user: z.string().optional(),
})
/**
* File retrieved successfully
*/
export const zGetFilesByFileIdPreviewResponse = zBinaryFileResponse
export const zGetFilesByFileIdPreviewResponse = z.custom<Blob | File>()
export const zGetFormHumanInputByFormTokenPath = z.object({
form_token: z.string(),
@ -2848,7 +3016,7 @@ export const zGetFormHumanInputByFormTokenPath = z.object({
*/
export const zGetFormHumanInputByFormTokenResponse = zHumanInputFormDefinitionResponse
export const zPostFormHumanInputByFormTokenBody = zHumanInputFormSubmitPayload
export const zPostFormHumanInputByFormTokenBody = zHumanInputFormSubmitPayloadWithUser
export const zPostFormHumanInputByFormTokenPath = z.object({
form_token: z.string(),
@ -2868,6 +3036,7 @@ export const zGetMessagesQuery = z.object({
conversation_id: z.string(),
first_id: z.string().optional(),
limit: z.int().gte(1).lte(100).optional().default(20),
user: z.string().optional(),
})
/**
@ -2875,10 +3044,10 @@ export const zGetMessagesQuery = z.object({
*/
export const zGetMessagesResponse = zMessageInfiniteScrollPagination
export const zPostMessagesByMessageIdFeedbacksBody = zMessageFeedbackPayload
export const zPostMessagesByMessageIdFeedbacksBody = zMessageFeedbackPayloadWithUser
export const zPostMessagesByMessageIdFeedbacksPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
/**
@ -2887,7 +3056,11 @@ export const zPostMessagesByMessageIdFeedbacksPath = z.object({
export const zPostMessagesByMessageIdFeedbacksResponse = zResultResponse
export const zGetMessagesByMessageIdSuggestedPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
export const zGetMessagesByMessageIdSuggestedQuery = z.object({
user: z.string(),
})
/**
@ -2910,12 +3083,12 @@ export const zGetParametersResponse = zParameters
*/
export const zGetSiteResponse = zSite
export const zPostTextToAudioBody = zTextToAudioPayload
export const zPostTextToAudioBody = zTextToAudioPayloadWithUser
/**
* Text successfully converted to audio
*/
export const zPostTextToAudioResponse = zAudioBinaryResponse
export const zPostTextToAudioResponse = z.custom<Blob | File>()
export const zGetWorkflowByTaskIdEventsPath = z.object({
task_id: z.string(),
@ -2948,7 +3121,7 @@ export const zGetWorkflowsLogsQuery = z.object({
*/
export const zGetWorkflowsLogsResponse = zWorkflowAppLogPaginationResponse
export const zPostWorkflowsRunBody = zWorkflowRunPayload
export const zPostWorkflowsRunBody = zWorkflowRunPayloadWithUser
/**
* Workflow executed successfully
@ -2964,6 +3137,8 @@ export const zGetWorkflowsRunByWorkflowRunIdPath = z.object({
*/
export const zGetWorkflowsRunByWorkflowRunIdResponse = zWorkflowRunResponse
export const zPostWorkflowsTasksByTaskIdStopBody = zRequiredServiceApiUserPayload
export const zPostWorkflowsTasksByTaskIdStopPath = z.object({
task_id: z.string(),
})
@ -2973,7 +3148,7 @@ export const zPostWorkflowsTasksByTaskIdStopPath = z.object({
*/
export const zPostWorkflowsTasksByTaskIdStopResponse = zSimpleResultResponse
export const zPostWorkflowsByWorkflowIdRunBody = zWorkflowRunPayload
export const zPostWorkflowsByWorkflowIdRunBody = zWorkflowRunPayloadWithUser
export const zPostWorkflowsByWorkflowIdRunPath = z.object({
workflow_id: z.string(),

11
packages/contracts/generated/api/web/types.gen.ts
View File

@ -146,7 +146,16 @@ export type ConversationListQuery = {
sort_by?: '-created_at' | '-updated_at' | 'created_at' | 'updated_at'
}
export type ConversationRenamePayload = {
export type ConversationRenamePayload = (
| {
auto_generate: true
name?: string | null
}
| {
auto_generate?: false
name: string
}
) & {
auto_generate?: boolean
name?: string | null
}

39
packages/contracts/generated/api/web/zod.gen.ts
View File

@ -168,13 +168,22 @@ export const zConversationListQuery = z.object({
.default('-updated_at'),
})
/**
* ConversationRenamePayload
*/
export const zConversationRenamePayload = z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
})
export const zConversationRenamePayload = z.intersection(
z.union([
z.object({
auto_generate: z.literal(true),
name: z.string().nullish(),
}),
z.object({
auto_generate: z.literal(false).optional().default(false),
name: z.string().regex(/.*\S.*/),
}),
]),
z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
}),
)
/**
* EmailCodeLoginSendPayload
@ -954,7 +963,7 @@ export const zGetConversationsQuery = z.object({
export const zGetConversationsResponse = zConversationInfiniteScrollPagination
export const zDeleteConversationsByCIdPath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
/**
@ -965,7 +974,7 @@ export const zDeleteConversationsByCIdResponse = z.void()
export const zPostConversationsByCIdNameBody = zConversationRenamePayload
export const zPostConversationsByCIdNamePath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
export const zPostConversationsByCIdNameQuery = z.object({
@ -979,7 +988,7 @@ export const zPostConversationsByCIdNameQuery = z.object({
export const zPostConversationsByCIdNameResponse = zSimpleConversation
export const zPatchConversationsByCIdPinPath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
/**
@ -988,7 +997,7 @@ export const zPatchConversationsByCIdPinPath = z.object({
export const zPatchConversationsByCIdPinResponse = zResultResponse
export const zPatchConversationsByCIdUnpinPath = z.object({
c_id: z.string(),
c_id: z.uuid(),
})
/**
@ -1106,7 +1115,7 @@ export const zGetMessagesResponse = zWebMessageInfiniteScrollPagination
export const zPostMessagesByMessageIdFeedbacksBody = zMessageFeedbackPayload
export const zPostMessagesByMessageIdFeedbacksPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
export const zPostMessagesByMessageIdFeedbacksQuery = z.object({
@ -1120,7 +1129,7 @@ export const zPostMessagesByMessageIdFeedbacksQuery = z.object({
export const zPostMessagesByMessageIdFeedbacksResponse = zResultResponse
export const zGetMessagesByMessageIdMoreLikeThisPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
export const zGetMessagesByMessageIdMoreLikeThisQuery = z.object({
@ -1133,7 +1142,7 @@ export const zGetMessagesByMessageIdMoreLikeThisQuery = z.object({
export const zGetMessagesByMessageIdMoreLikeThisResponse = zGeneratedAppResponse
export const zGetMessagesByMessageIdSuggestedQuestionsPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
/**
@ -1198,7 +1207,7 @@ export const zPostSavedMessagesQuery = z.object({
export const zPostSavedMessagesResponse = zResultResponse
export const zDeleteSavedMessagesByMessageIdPath = z.object({
message_id: z.string(),
message_id: z.uuid(),
})
/**