// This file is auto-generated by @hey-api/openapi-ts import * as z from 'zod' /** * AudioTranscriptResponse */ export const zAudioTranscriptResponse = z.object({ text: z.string(), }) /** * ChatRequest */ export const zChatRequest = z.object({ conversation_id: z.string().nullish(), files: z.array(z.unknown()).nullish(), inputs: z.record(z.string(), z.unknown()), parent_message_id: z.string().nullish(), query: z.string(), retriever_from: z.string().optional().default('explore_app'), }) /** * CompletionRequest */ export const zCompletionRequest = z.object({ files: z.array(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('explore_app'), }) /** * FileResponse */ export const zFileResponse = z.object({ conversation_id: z.uuid().nullish(), created_at: z.int().nullish(), created_by: z.uuid().nullish(), extension: z.string().nullish(), file_key: z.string().nullish(), id: z.uuid(), mime_type: z.string().nullish(), name: z.string(), original_url: z.string().nullish(), preview_url: z.string().nullish(), reference: z.string().nullish(), size: z.int(), source_url: z.string().nullish(), tenant_id: z.uuid().nullish(), user_id: z.uuid().nullish(), }) /** * SuggestedQuestionsResponse */ export const zSuggestedQuestionsResponse = z.object({ data: z.array(z.string()), }) /** * RemoteFileUploadPayload */ export const zRemoteFileUploadPayload = z.object({ url: z.string(), }) /** * FileWithSignedUrl */ export const zFileWithSignedUrl = z.object({ created_at: z.int().nullable(), created_by: z.string().nullable(), extension: z.string().nullable(), id: z.string(), mime_type: z.string().nullable(), name: z.string(), size: z.int(), url: z.string().nullable(), }) /** * Site */ export const zSite = z.object({ chat_color_theme: z.string().nullish(), chat_color_theme_inverted: z.boolean(), copyright: z.string().nullish(), custom_disclaimer: z.string().nullish(), default_language: z.string(), description: z.string().nullish(), icon: z.string().nullish(), icon_background: z.string().nullish(), icon_type: z.string().nullish(), icon_url: z.string().nullable(), input_placeholder: z.string().nullish(), privacy_policy: z.string().nullish(), show_workflow_steps: z.boolean(), title: z.string(), use_icon_as_answer_icon: z.boolean(), }) /** * TextToSpeechRequest */ export const zTextToSpeechRequest = z.object({ message_id: z.string().nullish(), streaming: z.boolean().nullish(), text: z.string().nullish(), voice: z.string().nullish(), }) /** * AudioBinaryResponse */ export const zAudioBinaryResponse = z.custom( (value) => value instanceof Blob || value instanceof File, ) /** * WorkflowRunRequest */ export const zWorkflowRunRequest = z.object({ files: z.array(z.unknown()).nullish(), inputs: z.record(z.string(), z.unknown()), }) /** * SimpleResultResponse */ export const zSimpleResultResponse = z.object({ result: z.string(), }) /** * TrialDeletedToolResponse */ export const zTrialDeletedToolResponse = z.object({ provider_id: z.string(), tool_name: z.string(), type: z.string(), }) export const zTrialIconType = z.enum(['emoji', 'image', 'link']) export const zTrialAppMode = z.enum([ 'advanced-chat', 'agent-chat', 'chat', 'completion', 'workflow', ]) /** * TrialSiteResponse */ export const zTrialSiteResponse = z.object({ access_token: z.string().nullish(), app_base_url: z.string().nullish(), chat_color_theme: z.string().nullish(), chat_color_theme_inverted: z.boolean().nullish(), code: z.string().nullish(), copyright: z.string().nullish(), created_at: z.int().nullish(), created_by: z.string().nullish(), custom_disclaimer: z.string().nullish(), customize_domain: z.string().nullish(), customize_token_strategy: z.string().nullish(), default_language: z.string(), description: z.string().nullish(), icon: z.string().nullish(), icon_background: z.string().nullish(), icon_type: zTrialIconType.nullish(), icon_url: z.string().nullish(), input_placeholder: z.string().nullish(), privacy_policy: z.string().nullish(), prompt_public: z.boolean().nullish(), show_workflow_steps: z.boolean().nullish(), title: z.string(), updated_at: z.int().nullish(), updated_by: z.string().nullish(), use_icon_as_answer_icon: z.boolean().nullish(), }) /** * TrialTagResponse */ export const zTrialTagResponse = z.object({ id: z.string(), name: z.string(), type: z.string(), }) /** * TrialWorkflowPartialResponse */ export const zTrialWorkflowPartialResponse = z.object({ created_at: z.int().nullish(), created_by: z.string().nullish(), id: z.string(), updated_at: z.int().nullish(), updated_by: z.string().nullish(), }) /** * TrialDatasetResponse */ export const zTrialDatasetResponse = z.object({ created_at: z.int().nullish(), created_by: z.string().nullish(), data_source_type: z.string().nullish(), description: z.string().nullish(), id: z.string(), indexing_technique: z.string().nullish(), name: z.string(), permission: z.string().nullish(), permission_keys: z.array(z.string()).optional(), }) /** * TrialDatasetListResponse */ export const zTrialDatasetListResponse = z.object({ data: z.array(zTrialDatasetResponse), has_more: z.boolean(), limit: z.int(), page: z.int(), total: z.int(), }) /** * SystemParameters */ export const zSystemParameters = z.object({ audio_file_size_limit: z.int(), file_size_limit: z.int(), image_file_size_limit: z.int(), video_file_size_limit: z.int(), workflow_file_upload_limit: z.int(), }) /** * Parameters */ export const zParameters = z.object({ annotation_reply: z.object({ enabled: z.boolean().optional(), }), file_upload: z.object({ allowed_file_extensions: z.array(z.string()).optional(), allowed_file_types: z .array(z.enum(['audio', 'custom', 'document', 'image', 'video'])) .optional(), allowed_file_upload_methods: z.array(z.enum(['local_file', 'remote_url'])).optional(), enabled: z.boolean().optional(), image: z .object({ detail: z.string().optional(), enabled: z.boolean().optional(), number_limits: z.int().optional(), transfer_methods: z.array(z.string()).optional(), }) .optional(), number_limits: z.int().optional(), }), more_like_this: z.object({ enabled: z.boolean().optional(), }), opening_statement: z.string().nullish(), retriever_resource: z.object({ enabled: z.boolean().optional(), }), sensitive_word_avoidance: z.object({ enabled: z.boolean().optional(), }), speech_to_text: z.object({ enabled: z.boolean().optional(), }), suggested_questions: z.array(z.string()), suggested_questions_after_answer: z.object({ enabled: z.boolean().optional(), }), system_parameters: zSystemParameters, text_to_speech: z.object({ autoPlay: z.string().optional(), enabled: z.boolean().optional(), language: z.string().optional(), voice: z.string().optional(), }), user_input_form: z.array( z.union([ z .object({ 'text-input': z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ select: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ paragraph: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ number: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ external_data_tool: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ file: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ 'file-list': z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ checkbox: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), z .object({ json_object: z.object({ allowed_file_extensions: z.array(z.string()).nullish(), allowed_file_types: z.array(z.string()).nullish(), allowed_file_upload_methods: z.array(z.string()).nullish(), config: z.record(z.string(), z.unknown()).optional(), default: z.unknown().optional(), description: z.string().optional(), hide: z.boolean().optional(), json_schema: z.record(z.string(), z.unknown()).nullish(), label: z.string(), max_length: z.int().nullish(), options: z.array(z.string()).optional(), required: z.boolean().optional(), type: z .enum([ 'checkbox', 'external_data_tool', 'file', 'file-list', 'json_object', 'number', 'paragraph', 'select', 'text-input', ]) .optional(), variable: z.string(), }), }) .strict(), ]), ), }) /** * WorkflowConversationVariableResponse */ export const zWorkflowConversationVariableResponse = z.object({ description: z.string(), id: z.string(), name: z.string(), value: z.unknown(), value_type: z.string(), }) /** * TrialSimpleAccount */ export const zTrialSimpleAccount = z.object({ email: z.string().nullish(), id: z.string(), name: z.string().nullish(), }) export const zJsonObject = z.record(z.string(), z.unknown()) /** * TrialWorkflowResponse */ export const zTrialWorkflowResponse = z.object({ conversation_variables: z.array(zWorkflowConversationVariableResponse).optional(), created_at: z.int().nullish(), created_by: zTrialSimpleAccount.nullish(), environment_variables: z.array(zJsonObject).optional(), features: zJsonObject.optional(), graph: zJsonObject, hash: z.string().nullish(), id: z.string(), marked_comment: z.string().nullish(), marked_name: z.string().nullish(), rag_pipeline_variables: z.array(zJsonObject).optional(), tool_published: z.boolean().nullish(), updated_at: z.int().nullish(), updated_by: zTrialSimpleAccount.nullish(), version: z.string().nullish(), }) /** * TrialAppAgentMode */ export const zTrialAppAgentMode = z.object({ enabled: z.boolean().nullish(), strategy: z.string().nullish(), tools: z.array(zJsonObject).optional(), }) /** * TrialAppModel */ export const zTrialAppModel = z.object({ completion_params: zJsonObject.optional(), mode: z.string().nullish(), name: z.string(), provider: z.string(), }) /** * TrialAppModelConfigResponse */ export const zTrialAppModelConfigResponse = z.object({ agent_mode: zTrialAppAgentMode.nullish(), annotation_reply: zJsonObject.nullish(), chat_prompt_config: zJsonObject.nullish(), completion_prompt_config: zJsonObject.nullish(), created_at: z.int().nullish(), created_by: z.string().nullish(), dataset_configs: zJsonObject.nullish(), dataset_query_variable: z.string().nullish(), external_data_tools: z.array(zJsonObject).optional(), file_upload: zJsonObject.nullish(), model: zTrialAppModel.nullish(), more_like_this: zJsonObject.nullish(), opening_statement: z.string().nullish(), pre_prompt: z.string().nullish(), prompt_type: z.string().nullish(), retriever_resource: zJsonObject.nullish(), sensitive_word_avoidance: zJsonObject.nullish(), speech_to_text: zJsonObject.nullish(), suggested_questions: z.array(z.string()).optional(), suggested_questions_after_answer: zJsonObject.nullish(), text_to_speech: zJsonObject.nullish(), updated_at: z.int().nullish(), updated_by: z.string().nullish(), user_input_form: z.array(zJsonObject).optional(), }) /** * TrialAppDetailResponse */ export const zTrialAppDetailResponse = z.object({ access_mode: z.string().nullish(), api_base_url: z.string().nullish(), created_at: z.int().nullish(), created_by: z.string().nullish(), deleted_tools: z.array(zTrialDeletedToolResponse).optional(), description: z.string().nullish(), enable_api: z.boolean(), enable_site: z.boolean(), icon: z.string().nullish(), icon_background: z.string().nullish(), icon_type: zTrialIconType.nullish(), icon_url: z.string().nullish(), id: z.string(), max_active_requests: z.int().nullish(), mode: zTrialAppMode, model_config: zTrialAppModelConfigResponse.nullish(), name: z.string(), permission_keys: z.array(z.string()).optional(), site: zTrialSiteResponse, tags: z.array(zTrialTagResponse).optional(), updated_at: z.int().nullish(), updated_by: z.string().nullish(), use_icon_as_answer_icon: z.boolean().nullish(), workflow: zTrialWorkflowPartialResponse.nullish(), }) /** * Site */ export const zSiteWritable = z.object({ chat_color_theme: z.string().nullish(), chat_color_theme_inverted: z.boolean(), copyright: z.string().nullish(), custom_disclaimer: z.string().nullish(), default_language: z.string(), description: z.string().nullish(), icon: z.string().nullish(), icon_background: z.string().nullish(), icon_type: z.string().nullish(), input_placeholder: z.string().nullish(), privacy_policy: z.string().nullish(), show_workflow_steps: z.boolean(), title: z.string(), use_icon_as_answer_icon: z.boolean(), }) export const zGetTrialAppsByAppIdPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zGetTrialAppsByAppIdResponse = zTrialAppDetailResponse export const zPostTrialAppsByAppIdAudioToTextPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zPostTrialAppsByAppIdAudioToTextResponse = zAudioTranscriptResponse export const zPostTrialAppsByAppIdChatMessagesBody = zChatRequest export const zPostTrialAppsByAppIdChatMessagesPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zPostTrialAppsByAppIdChatMessagesResponse = z.record(z.string(), z.unknown()) export const zPostTrialAppsByAppIdCompletionMessagesBody = zCompletionRequest export const zPostTrialAppsByAppIdCompletionMessagesPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zPostTrialAppsByAppIdCompletionMessagesResponse = z.record(z.string(), z.unknown()) export const zGetTrialAppsByAppIdDatasetsPath = z.object({ app_id: z.uuid(), }) export const zGetTrialAppsByAppIdDatasetsQuery = z.object({ ids: z.array(z.string()).optional(), limit: z.int().gte(1).optional().default(20), page: z.int().gte(1).optional().default(1), }) /** * Success */ export const zGetTrialAppsByAppIdDatasetsResponse = zTrialDatasetListResponse export const zPostTrialAppsByAppIdFilesUploadBody = z.object({ file: z.custom((value) => value instanceof Blob || value instanceof File), source: z.enum(['datasets']).optional(), }) export const zPostTrialAppsByAppIdFilesUploadPath = z.object({ app_id: z.uuid(), }) /** * File uploaded successfully */ export const zPostTrialAppsByAppIdFilesUploadResponse = zFileResponse export const zGetTrialAppsByAppIdMessagesByMessageIdSuggestedQuestionsPath = z.object({ app_id: z.uuid(), message_id: z.uuid(), }) /** * Success */ export const zGetTrialAppsByAppIdMessagesByMessageIdSuggestedQuestionsResponse = zSuggestedQuestionsResponse export const zGetTrialAppsByAppIdParametersPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zGetTrialAppsByAppIdParametersResponse = zParameters export const zPostTrialAppsByAppIdRemoteFilesUploadBody = zRemoteFileUploadPayload export const zPostTrialAppsByAppIdRemoteFilesUploadPath = z.object({ app_id: z.uuid(), }) /** * File uploaded successfully */ export const zPostTrialAppsByAppIdRemoteFilesUploadResponse = zFileWithSignedUrl export const zGetTrialAppsByAppIdSitePath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zGetTrialAppsByAppIdSiteResponse = zSite export const zPostTrialAppsByAppIdTextToAudioBody = zTextToSpeechRequest export const zPostTrialAppsByAppIdTextToAudioPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zPostTrialAppsByAppIdTextToAudioResponse = zAudioBinaryResponse export const zGetTrialAppsByAppIdWorkflowsPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zGetTrialAppsByAppIdWorkflowsResponse = zTrialWorkflowResponse export const zPostTrialAppsByAppIdWorkflowsRunBody = zWorkflowRunRequest export const zPostTrialAppsByAppIdWorkflowsRunPath = z.object({ app_id: z.uuid(), }) /** * Success */ export const zPostTrialAppsByAppIdWorkflowsRunResponse = z.record(z.string(), z.unknown()) export const zPostTrialAppsByAppIdWorkflowsTasksByTaskIdStopPath = z.object({ app_id: z.uuid(), task_id: z.string(), }) /** * Success */ export const zPostTrialAppsByAppIdWorkflowsTasksByTaskIdStopResponse = zSimpleResultResponse