Files
dify/packages/contracts/generated/api/service/zod.gen.ts
FFXN 107bba0116 feat: dev snippet fronted (#36784)
Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: EvanYao826 <155432245+EvanYao826@users.noreply.github.com>
Co-authored-by: yyh <92089059+lyzno1@users.noreply.github.com>
Co-authored-by: 盐粒 Yanli <yanli@dify.ai>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Tianle <40735546+Tianlel@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yunlu Wen <yunlu.wen@dify.ai>
Co-authored-by: zyssyz123 <916125788@qq.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: chariri <w@chariri.moe>
Co-authored-by: Asuka Minato <i@asukaminato.eu.org>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Nian <11332799+Lillian68@users.noreply.github.com>
Co-authored-by: 非法操作 <hjlarry@163.com>
Co-authored-by: Carmen Fernández Ruiz <279459669+zeus1959@users.noreply.github.com>
Co-authored-by: wangxiaolei <fatelei@gmail.com>
Co-authored-by: QuantumGhost <obelisk.reg+git@gmail.com>
Co-authored-by: L1nSn0w <l1nsn0w@qq.com>
Co-authored-by: Evan <2869018789@qq.com>
Co-authored-by: Escape0707 <tothesong@gmail.com>
Co-authored-by: Jingyi <jingyi.qi@dify.ai>
Co-authored-by: Amr Sherif <140330826+amr-sheriff@users.noreply.github.com>
Co-authored-by: ZHOU ZHICHEN <118870511+zhuiguangzhe2003@users.noreply.github.com>
Co-authored-by: unknown <EI05187@apwx.com>
Co-authored-by: JzoNg <jzongcode@gmail.com>
Co-authored-by: Xiyuan Chen <52963600+GareArc@users.noreply.github.com>
Co-authored-by: -LAN- <laipz8200@outlook.com>
2026-05-28 17:34:14 +08:00

2120 lines
51 KiB
TypeScript

// This file is auto-generated by @hey-api/openapi-ts
import * as z from 'zod'
/**
* Annotation
*/
export const zAnnotation = z.object({
content: z.string().nullish(),
created_at: z.int().nullish(),
hit_count: z.int().nullish(),
id: z.string(),
question: z.string().nullish(),
})
/**
* AnnotationCreatePayload
*/
export const zAnnotationCreatePayload = z.object({
answer: z.string(),
question: z.string(),
})
/**
* AnnotationList
*/
export const zAnnotationList = z.object({
data: z.array(zAnnotation),
has_more: z.boolean(),
limit: z.int(),
page: z.int(),
total: z.int(),
})
/**
* AnnotationReplyActionPayload
*/
export const zAnnotationReplyActionPayload = z.object({
embedding_model_name: z.string(),
embedding_provider_name: z.string(),
score_threshold: z.number(),
})
/**
* AppInfoResponse
*/
export const zAppInfoResponse = z.object({
author_name: z.string().nullable(),
description: z.string().nullable(),
mode: z.string(),
name: z.string(),
tags: z.array(z.string()),
})
/**
* ChatRequestPayload
*/
export const zChatRequestPayload = 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'),
workflow_id: z.string().nullish(),
})
/**
* ChildChunkCreatePayload
*/
export const zChildChunkCreatePayload = z.object({
content: z.string(),
})
/**
* ChildChunkListQuery
*/
export const zChildChunkListQuery = z.object({
keyword: z.string().nullish(),
limit: z.int().gte(1).optional().default(20),
page: z.int().gte(1).optional().default(1),
})
/**
* ChildChunkUpdatePayload
*/
export const zChildChunkUpdatePayload = z.object({
content: z.string(),
})
/**
* CompletionRequestPayload
*/
export const zCompletionRequestPayload = 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'),
})
/**
* Condition
*
* Condition detail
*/
export const zCondition = z.object({
comparison_operator: z.enum([
'<',
'=',
'>',
'after',
'before',
'contains',
'empty',
'end with',
'in',
'is',
'is not',
'not contains',
'not empty',
'not in',
'start with',
'≠',
'≤',
'≥',
]),
name: z.string(),
value: z.unknown().optional(),
})
/**
* ConversationListQuery
*/
export const zConversationListQuery = z.object({
last_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
sort_by: z
.enum(['-created_at', '-updated_at', 'created_at', 'updated_at'])
.optional()
.default('-updated_at'),
})
/**
* ConversationRenamePayload
*/
export const zConversationRenamePayload = z.object({
auto_generate: z.boolean().optional().default(false),
name: z.string().nullish(),
})
/**
* ConversationVariableResponse
*/
export const zConversationVariableResponse = z.object({
created_at: z.int().nullish(),
description: z.string().nullish(),
id: z.string(),
name: z.string(),
updated_at: z.int().nullish(),
value: z.string().nullish(),
value_type: z.string(),
})
/**
* ConversationVariableInfiniteScrollPaginationResponse
*/
export const zConversationVariableInfiniteScrollPaginationResponse = z.object({
data: z.array(zConversationVariableResponse),
has_more: z.boolean(),
limit: z.int(),
})
/**
* ConversationVariableUpdatePayload
*/
export const zConversationVariableUpdatePayload = z.object({
value: z.unknown(),
})
/**
* ConversationVariablesQuery
*/
export const zConversationVariablesQuery = z.object({
last_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
variable_name: z.string().min(1).max(255).nullish(),
})
/**
* DatasetBoundTagResponse
*/
export const zDatasetBoundTagResponse = z.object({
id: z.string(),
name: z.string(),
})
/**
* DatasetBoundTagListResponse
*/
export const zDatasetBoundTagListResponse = z.object({
data: z.array(zDatasetBoundTagResponse),
total: z.int(),
})
/**
* DatasetDocMetadataResponse
*/
export const zDatasetDocMetadataResponse = z.object({
id: z.string(),
name: z.string(),
type: z.string(),
})
/**
* DatasetExternalKnowledgeInfoResponse
*/
export const zDatasetExternalKnowledgeInfoResponse = z.object({
external_knowledge_api_endpoint: z.string().nullish(),
external_knowledge_api_id: z.string().nullish(),
external_knowledge_api_name: z.string().nullish(),
external_knowledge_id: z.string().nullish(),
})
/**
* DatasetExternalRetrievalModelResponse
*/
export const zDatasetExternalRetrievalModelResponse = z.object({
score_threshold: z.number().nullish(),
score_threshold_enabled: z.boolean().nullish(),
top_k: z.int(),
})
/**
* DatasetIconInfoResponse
*/
export const zDatasetIconInfoResponse = z.object({
icon: z.string().nullish(),
icon_background: z.string().nullish(),
icon_type: z.string().nullish(),
icon_url: z.string().nullish(),
})
/**
* DatasetKeywordSettingResponse
*/
export const zDatasetKeywordSettingResponse = z.object({
keyword_weight: z.number().nullish(),
})
/**
* DatasetListQuery
*/
export const zDatasetListQuery = z.object({
include_all: z.boolean().optional().default(false),
keyword: z.string().nullish(),
limit: z.int().optional().default(20),
page: z.int().optional().default(1),
tag_ids: z.array(z.string()).optional(),
})
/**
* DatasetMetadataActionResponse
*/
export const zDatasetMetadataActionResponse = z.object({
result: z.string(),
})
/**
* DatasetMetadataBuiltInFieldResponse
*/
export const zDatasetMetadataBuiltInFieldResponse = z.object({
name: z.string(),
type: z.string(),
})
/**
* DatasetMetadataBuiltInFieldsResponse
*/
export const zDatasetMetadataBuiltInFieldsResponse = z.object({
fields: z.array(zDatasetMetadataBuiltInFieldResponse),
})
/**
* DatasetMetadataListItemResponse
*/
export const zDatasetMetadataListItemResponse = z.object({
count: z.int().optional().default(0),
id: z.string(),
name: z.string(),
type: z.string(),
})
/**
* DatasetMetadataListResponse
*/
export const zDatasetMetadataListResponse = z.object({
built_in_field_enabled: z.boolean(),
doc_metadata: z.array(zDatasetMetadataListItemResponse),
})
/**
* DatasetMetadataResponse
*/
export const zDatasetMetadataResponse = z.object({
id: z.string(),
name: z.string(),
type: z.string(),
})
/**
* DatasetPermissionEnum
*/
export const zDatasetPermissionEnum = z.enum(['all_team_members', 'only_me', 'partial_members'])
/**
* DatasetRerankingModelResponse
*/
export const zDatasetRerankingModelResponse = z.object({
reranking_model_name: z.string().nullish(),
reranking_provider_name: z.string().nullish(),
})
/**
* DatasetSummaryIndexSettingResponse
*/
export const zDatasetSummaryIndexSettingResponse = z.object({
enable: z.boolean().nullish(),
model_name: z.string().nullish(),
model_provider_name: z.string().nullish(),
summary_prompt: z.string().nullish(),
})
/**
* DatasetTagResponse
*/
export const zDatasetTagResponse = z.object({
id: z.string(),
name: z.string(),
type: z.string(),
})
/**
* DatasetVectorSettingResponse
*/
export const zDatasetVectorSettingResponse = z.object({
embedding_model_name: z.string().nullish(),
embedding_provider_name: z.string().nullish(),
vector_weight: z.number().nullish(),
})
/**
* DatasetWeightedScoreResponse
*/
export const zDatasetWeightedScoreResponse = z.object({
keyword_setting: zDatasetKeywordSettingResponse.optional(),
vector_setting: zDatasetVectorSettingResponse.optional(),
weight_type: z.string().nullish(),
})
/**
* DatasetRetrievalModelResponse
*/
export const zDatasetRetrievalModelResponse = z.object({
reranking_enable: z.boolean(),
reranking_mode: z.string().nullish(),
reranking_model: zDatasetRerankingModelResponse.optional(),
score_threshold: z.number().nullish(),
score_threshold_enabled: z.boolean(),
search_method: z.string(),
top_k: z.int(),
weights: zDatasetWeightedScoreResponse.optional(),
})
/**
* DatasetDetailResponse
*/
export const zDatasetDetailResponse = z.object({
app_count: z.int(),
author_name: z.string().nullable(),
built_in_field_enabled: z.boolean(),
chunk_structure: z.string().nullable(),
created_at: z.int(),
created_by: z.string(),
data_source_type: z.string().nullable(),
description: z.string().nullable(),
doc_form: z.string().nullable(),
doc_metadata: z.array(zDatasetDocMetadataResponse),
document_count: z.int(),
embedding_available: z.boolean().nullish(),
embedding_model: z.string().nullable(),
embedding_model_provider: z.string().nullable(),
enable_api: z.boolean(),
external_knowledge_info: zDatasetExternalKnowledgeInfoResponse.optional(),
external_retrieval_model: zDatasetExternalRetrievalModelResponse,
icon_info: zDatasetIconInfoResponse.optional(),
id: z.string(),
indexing_technique: z.string().nullable(),
is_multimodal: z.boolean(),
is_published: z.boolean(),
name: z.string(),
permission: z.string(),
pipeline_id: z.string().nullable(),
provider: z.string(),
retrieval_model_dict: zDatasetRetrievalModelResponse,
runtime_mode: z.string().nullable(),
summary_index_setting: zDatasetSummaryIndexSettingResponse.optional(),
tags: z.array(zDatasetTagResponse),
total_available_documents: z.int(),
total_documents: z.int(),
updated_at: z.int(),
updated_by: z.string().nullable(),
word_count: z.int(),
})
/**
* DatasetDetailWithPartialMembersResponse
*/
export const zDatasetDetailWithPartialMembersResponse = z.object({
app_count: z.int(),
author_name: z.string().nullable(),
built_in_field_enabled: z.boolean(),
chunk_structure: z.string().nullable(),
created_at: z.int(),
created_by: z.string(),
data_source_type: z.string().nullable(),
description: z.string().nullable(),
doc_form: z.string().nullable(),
doc_metadata: z.array(zDatasetDocMetadataResponse),
document_count: z.int(),
embedding_available: z.boolean().nullish(),
embedding_model: z.string().nullable(),
embedding_model_provider: z.string().nullable(),
enable_api: z.boolean(),
external_knowledge_info: zDatasetExternalKnowledgeInfoResponse.optional(),
external_retrieval_model: zDatasetExternalRetrievalModelResponse,
icon_info: zDatasetIconInfoResponse.optional(),
id: z.string(),
indexing_technique: z.string().nullable(),
is_multimodal: z.boolean(),
is_published: z.boolean(),
name: z.string(),
partial_member_list: z.array(z.string()).nullish(),
permission: z.string(),
pipeline_id: z.string().nullable(),
provider: z.string(),
retrieval_model_dict: zDatasetRetrievalModelResponse,
runtime_mode: z.string().nullable(),
summary_index_setting: zDatasetSummaryIndexSettingResponse.optional(),
tags: z.array(zDatasetTagResponse),
total_available_documents: z.int(),
total_documents: z.int(),
updated_at: z.int(),
updated_by: z.string().nullable(),
word_count: z.int(),
})
/**
* DatasetListResponse
*/
export const zDatasetListResponse = z.object({
data: z.array(zDatasetDetailResponse),
has_more: z.boolean(),
limit: z.int(),
page: z.int(),
total: z.int(),
})
/**
* DatasourceNodeRunPayload
*/
export const zDatasourceNodeRunPayload = z.object({
credential_id: z.string().nullish(),
datasource_type: z.string(),
inputs: z.record(z.string(), z.unknown()),
is_published: z.boolean(),
})
/**
* DocumentBatchDownloadZipPayload
*
* Request payload for bulk downloading documents as a zip archive.
*/
export const zDocumentBatchDownloadZipPayload = z.object({
document_ids: z.array(z.uuid()).min(1).max(100),
})
/**
* DocumentListQuery
*/
export const zDocumentListQuery = z.object({
keyword: z.string().nullish(),
limit: z.int().optional().default(20),
page: z.int().optional().default(1),
status: z.string().nullish(),
})
/**
* EndUserDetail
*
* Full EndUser record for API responses.
*
* Note: The SQLAlchemy model defines an `is_anonymous` property for Flask-Login semantics
* (always False). The database column is exposed as `_is_anonymous`, so this DTO maps
* `is_anonymous` from `_is_anonymous` to return the stored value.
*/
export const zEndUserDetail = z.object({
app_id: z.string().nullish(),
created_at: z.iso.datetime(),
external_user_id: z.string().nullish(),
id: z.string(),
is_anonymous: z.boolean(),
name: z.string().nullish(),
session_id: z.string(),
tenant_id: z.string(),
type: z.string(),
updated_at: z.iso.datetime(),
})
/**
* FeedbackListQuery
*/
export const zFeedbackListQuery = z.object({
limit: z.int().gte(1).lte(101).optional().default(20),
page: z.int().gte(1).optional().default(1),
})
/**
* FilePreviewQuery
*/
export const zFilePreviewQuery = z.object({
as_attachment: z.boolean().optional().default(false),
})
/**
* FileResponse
*/
export const zFileResponse = z.object({
conversation_id: z.string().nullish(),
created_at: z.int().nullish(),
created_by: z.string().nullish(),
extension: z.string().nullish(),
file_key: z.string().nullish(),
id: z.string(),
mime_type: z.string().nullish(),
name: z.string(),
original_url: z.string().nullish(),
preview_url: z.string().nullish(),
size: z.int(),
source_url: z.string().nullish(),
tenant_id: z.string().nullish(),
user_id: z.string().nullish(),
})
/**
* HitTestingChildChunk
*/
export const zHitTestingChildChunk = z.object({
content: z.string(),
id: z.string(),
position: z.int(),
score: z.number(),
})
/**
* HitTestingDocument
*/
export const zHitTestingDocument = z.object({
data_source_type: z.string(),
doc_metadata: z.unknown(),
doc_type: z.string().nullable(),
id: z.string(),
name: z.string(),
})
/**
* HitTestingFile
*/
export const zHitTestingFile = z.object({
extension: z.string(),
id: z.string(),
mime_type: z.string(),
name: z.string(),
size: z.int(),
source_url: z.string(),
})
/**
* HitTestingQuery
*/
export const zHitTestingQuery = z.object({
content: z.string(),
})
/**
* HitTestingSegment
*/
export const zHitTestingSegment = z.object({
answer: z.string().nullable(),
completed_at: z.int().nullable(),
content: z.string(),
created_at: z.int(),
created_by: z.string(),
disabled_at: z.int().nullable(),
disabled_by: z.string().nullable(),
document: zHitTestingDocument,
document_id: z.string(),
enabled: z.boolean(),
error: z.string().nullable(),
hit_count: z.int(),
id: z.string(),
index_node_hash: z.string().nullable(),
index_node_id: z.string().nullable(),
indexing_at: z.int().nullable(),
keywords: z.array(z.string()),
position: z.int(),
sign_content: z.string().nullable(),
status: z.string(),
stopped_at: z.int().nullable(),
tokens: z.int(),
word_count: z.int(),
})
/**
* HitTestingRecord
*/
export const zHitTestingRecord = z.object({
child_chunks: z.array(zHitTestingChildChunk),
files: z.array(zHitTestingFile),
score: z.number().nullable(),
segment: zHitTestingSegment,
summary: z.string().nullable(),
tsne_position: z.unknown(),
})
/**
* HitTestingResponse
*/
export const zHitTestingResponse = z.object({
query: zHitTestingQuery,
records: z.array(zHitTestingRecord),
})
/**
* IndexInfoResponse
*/
export const zIndexInfoResponse = z.object({
api_version: z.string(),
server_version: z.string(),
welcome: z.string(),
})
export const zJsonValue = z.unknown()
/**
* HumanInputFormSubmitPayload
*/
export const zHumanInputFormSubmitPayload = z.object({
action: z.string(),
inputs: z.record(z.string(), zJsonValue),
})
/**
* KnowledgeTagResponse
*/
export const zKnowledgeTagResponse = z.object({
binding_count: z.string().nullish(),
id: z.string(),
name: z.string(),
type: z.string(),
})
/**
* KnowledgeTagListResponse
*/
export const zKnowledgeTagListResponse = z.array(zKnowledgeTagResponse)
/**
* MessageFeedbackPayload
*/
export const zMessageFeedbackPayload = z.object({
content: z.string().nullish(),
rating: z.enum(['dislike', 'like']).nullish(),
})
/**
* MessageListQuery
*/
export const zMessageListQuery = z.object({
conversation_id: z.string(),
first_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
})
/**
* MetadataArgs
*/
export const zMetadataArgs = z.object({
name: z.string(),
type: z.enum(['number', 'string', 'time']),
})
/**
* MetadataDetail
*/
export const zMetadataDetail = z.object({
id: z.string(),
name: z.string(),
value: z.unknown().optional(),
})
/**
* DocumentMetadataOperation
*/
export const zDocumentMetadataOperation = z.object({
document_id: z.string(),
metadata_list: z.array(zMetadataDetail),
partial_update: z.boolean().optional().default(false),
})
/**
* MetadataFilteringCondition
*
* Metadata Filtering Condition.
*/
export const zMetadataFilteringCondition = z.object({
conditions: z.array(zCondition).nullish(),
logical_operator: z.enum(['and', 'or']).nullish().default('and'),
})
/**
* MetadataOperationData
*
* Metadata operation data
*/
export const zMetadataOperationData = z.object({
operation_data: z.array(zDocumentMetadataOperation),
})
/**
* MetadataUpdatePayload
*/
export const zMetadataUpdatePayload = z.object({
name: z.string(),
})
/**
* PipelineRunApiEntity
*/
export const zPipelineRunApiEntity = z.object({
datasource_info_list: z.array(z.record(z.string(), z.unknown())),
datasource_type: z.string(),
inputs: z.record(z.string(), z.unknown()),
is_published: z.boolean(),
response_mode: z.string(),
start_node_id: z.string(),
})
/**
* PreProcessingRule
*/
export const zPreProcessingRule = z.object({
enabled: z.boolean(),
id: z.string(),
})
/**
* RerankingModel
*/
export const zRerankingModel = z.object({
reranking_model_name: z.string().nullish(),
reranking_provider_name: z.string().nullish(),
})
/**
* ResultResponse
*/
export const zResultResponse = z.object({
result: z.string(),
})
/**
* RetrievalMethod
*/
export const zRetrievalMethod = z.enum([
'full_text_search',
'hybrid_search',
'keyword_search',
'semantic_search',
])
/**
* SegmentCreatePayload
*/
export const zSegmentCreatePayload = z.object({
segments: z.array(z.record(z.string(), z.unknown())).nullish(),
})
/**
* SegmentListQuery
*/
export const zSegmentListQuery = z.object({
keyword: z.string().nullish(),
status: z.array(z.string()).optional(),
})
/**
* SegmentUpdateArgs
*/
export const zSegmentUpdateArgs = z.object({
answer: z.string().nullish(),
attachment_ids: z.array(z.string()).nullish(),
content: z.string().nullish(),
enabled: z.boolean().nullish(),
keywords: z.array(z.string()).nullish(),
regenerate_child_chunks: z.boolean().optional().default(false),
summary: z.string().nullish(),
})
/**
* SegmentUpdatePayload
*/
export const zSegmentUpdatePayload = z.object({
segment: zSegmentUpdateArgs,
})
/**
* Segmentation
*/
export const zSegmentation = z.object({
chunk_overlap: z.int().optional().default(0),
max_tokens: z.int(),
separator: z.string().optional().default('\n'),
})
/**
* Rule
*/
export const zRule = z.object({
parent_mode: z.enum(['full-doc', 'paragraph']).nullish(),
pre_processing_rules: z.array(zPreProcessingRule).nullish(),
segmentation: zSegmentation.optional(),
subchunk_segmentation: zSegmentation.optional(),
})
/**
* ProcessRule
*/
export const zProcessRule = z.object({
mode: z.enum(['automatic', 'custom', 'hierarchical']),
rules: zRule.optional(),
})
/**
* SimpleAccount
*/
export const zSimpleAccount = z.object({
email: z.string(),
id: z.string(),
name: z.string(),
})
/**
* SimpleEndUser
*/
export const zSimpleEndUser = z.object({
id: z.string(),
is_anonymous: z.boolean(),
session_id: z.string().nullish(),
type: z.string(),
})
/**
* SimpleResultResponse
*/
export const zSimpleResultResponse = z.object({
result: z.string(),
})
/**
* SimpleResultStringListResponse
*/
export const zSimpleResultStringListResponse = z.object({
data: z.array(z.string()),
result: z.string(),
})
/**
* 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().readonly().nullable(),
privacy_policy: z.string().nullish(),
show_workflow_steps: z.boolean(),
title: z.string(),
use_icon_as_answer_icon: z.boolean(),
})
/**
* TagBindingPayload
*/
export const zTagBindingPayload = z.object({
tag_ids: z.array(z.string()),
target_id: z.string(),
})
/**
* TagCreatePayload
*/
export const zTagCreatePayload = z.object({
name: z.string().min(1).max(50),
})
/**
* TagDeletePayload
*/
export const zTagDeletePayload = z.object({
tag_id: z.string(),
})
/**
* TagUnbindingPayload
*
* Accept the legacy single-tag Service API payload while exposing a normalized tag_ids list internally.
*/
export const zTagUnbindingPayload = z.object({
tag_id: z.string().nullish(),
tag_ids: z.array(z.string()).optional(),
target_id: z.string(),
})
/**
* TagUpdatePayload
*/
export const zTagUpdatePayload = z.object({
name: z.string().min(1).max(50),
tag_id: z.string(),
})
/**
* TextToAudioPayload
*/
export const zTextToAudioPayload = z.object({
message_id: z.string().nullish(),
streaming: z.boolean().nullish(),
text: z.string().nullish(),
voice: z.string().nullish(),
})
/**
* UrlResponse
*/
export const zUrlResponse = z.object({
url: z.string(),
})
/**
* WeightKeywordSetting
*/
export const zWeightKeywordSetting = z.object({
keyword_weight: z.number(),
})
/**
* WeightVectorSetting
*/
export const zWeightVectorSetting = z.object({
embedding_model_name: z.string(),
embedding_provider_name: z.string(),
vector_weight: z.number(),
})
/**
* WeightModel
*/
export const zWeightModel = z.object({
keyword_setting: zWeightKeywordSetting.optional(),
vector_setting: zWeightVectorSetting.optional(),
weight_type: z.enum(['customized', 'keyword_first', 'semantic_first']).nullish(),
})
/**
* RetrievalModel
*/
export const zRetrievalModel = z.object({
metadata_filtering_conditions: zMetadataFilteringCondition.optional(),
reranking_enable: z.boolean(),
reranking_mode: z.string().nullish(),
reranking_model: zRerankingModel.optional(),
score_threshold: z.number().nullish(),
score_threshold_enabled: z.boolean(),
search_method: zRetrievalMethod,
top_k: z.int(),
weights: zWeightModel.optional(),
})
/**
* DatasetCreatePayload
*/
export const zDatasetCreatePayload = z.object({
description: z.string().max(400).optional().default(''),
embedding_model: z.string().nullish(),
embedding_model_provider: z.string().nullish(),
external_knowledge_api_id: z.string().nullish(),
external_knowledge_id: z.string().nullish(),
indexing_technique: z.enum(['economy', 'high_quality']).nullish(),
name: z.string().min(1).max(40),
permission: zDatasetPermissionEnum.optional(),
provider: z.string().optional().default('vendor'),
retrieval_model: zRetrievalModel.optional(),
summary_index_setting: z.record(z.string(), z.unknown()).nullish(),
})
/**
* DatasetUpdatePayload
*/
export const zDatasetUpdatePayload = z.object({
description: z.string().max(400).nullish(),
embedding_model: z.string().nullish(),
embedding_model_provider: z.string().nullish(),
external_knowledge_api_id: z.string().nullish(),
external_knowledge_id: z.string().nullish(),
external_retrieval_model: z.record(z.string(), z.unknown()).nullish(),
indexing_technique: z.enum(['economy', 'high_quality']).nullish(),
name: z.string().min(1).max(40).nullish(),
partial_member_list: z.array(z.record(z.string(), z.string())).nullish(),
permission: zDatasetPermissionEnum.optional(),
retrieval_model: zRetrievalModel.optional(),
})
/**
* DocumentTextCreatePayload
*/
export const zDocumentTextCreatePayload = z.object({
doc_form: z.string().optional().default('text_model'),
doc_language: z.string().optional().default('English'),
embedding_model: z.string().nullish(),
embedding_model_provider: z.string().nullish(),
indexing_technique: z.string().nullish(),
name: z.string(),
original_document_id: z.string().nullish(),
process_rule: zProcessRule.optional(),
retrieval_model: zRetrievalModel.optional(),
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.optional(),
retrieval_model: zRetrievalModel.optional(),
text: z.string().nullish(),
})
/**
* HitTestingPayload
*/
export const zHitTestingPayload = z.object({
attachment_ids: z.array(z.string()).nullish(),
external_retrieval_model: z.record(z.string(), z.unknown()).nullish(),
query: z.string().max(250),
retrieval_model: zRetrievalModel.optional(),
})
/**
* WorkflowLogQuery
*/
export const zWorkflowLogQuery = z.object({
created_at__after: z.string().nullish(),
created_at__before: z.string().nullish(),
created_by_account: z.string().nullish(),
created_by_end_user_session_id: z.string().nullish(),
keyword: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
page: z.int().gte(1).lte(99999).optional().default(1),
status: z.enum(['failed', 'stopped', 'succeeded']).nullish(),
})
/**
* WorkflowRunForLogResponse
*/
export const zWorkflowRunForLogResponse = z.object({
created_at: z.int().nullish(),
elapsed_time: z.unknown().optional(),
error: z.string().nullish(),
exceptions_count: z.int().nullish(),
finished_at: z.int().nullish(),
id: z.string(),
status: z.string().nullish(),
total_steps: z.int().nullish(),
total_tokens: z.int().nullish(),
triggered_from: z.string().nullish(),
version: z.string().nullish(),
})
/**
* WorkflowAppLogPartialResponse
*/
export const zWorkflowAppLogPartialResponse = z.object({
created_at: z.int().nullish(),
created_by_account: zSimpleAccount.optional(),
created_by_end_user: zSimpleEndUser.optional(),
created_by_role: z.string().nullish(),
created_from: z.string().nullish(),
details: z.unknown().optional(),
id: z.string(),
workflow_run: zWorkflowRunForLogResponse.optional(),
})
/**
* WorkflowAppLogPaginationResponse
*/
export const zWorkflowAppLogPaginationResponse = z.object({
data: z.array(zWorkflowAppLogPartialResponse),
has_more: z.boolean(),
limit: z.int(),
page: z.int(),
total: z.int(),
})
/**
* WorkflowRunPayload
*/
export const zWorkflowRunPayload = 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(),
})
/**
* WorkflowRunResponse
*/
export const zWorkflowRunResponse = z.object({
created_at: z.int().nullish(),
elapsed_time: z.unknown().optional(),
error: z.string().nullish(),
finished_at: z.int().nullish(),
id: z.string(),
inputs: z.unknown().optional(),
outputs: z.record(z.string(), z.unknown()).optional(),
status: z.string(),
total_steps: z.int().nullish(),
total_tokens: z.int().nullish(),
workflow_id: z.string(),
})
/**
* 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(),
privacy_policy: z.string().nullish(),
show_workflow_steps: z.boolean(),
title: z.string(),
use_icon_as_answer_icon: z.boolean(),
})
/**
* Success
*/
export const zGetRootResponse = zIndexInfoResponse
export const zGetAppFeedbacksQuery = z.object({
limit: z.int().gte(1).lte(101).optional().default(20),
page: z.int().gte(1).optional().default(1),
})
/**
* Feedbacks retrieved successfully
*/
export const zGetAppFeedbacksResponse = z.record(z.string(), z.unknown())
export const zPostAppsAnnotationReplyByActionBody = zAnnotationReplyActionPayload
export const zPostAppsAnnotationReplyByActionPath = z.object({
action: z.string(),
})
/**
* Action completed successfully
*/
export const zPostAppsAnnotationReplyByActionResponse = z.record(z.string(), z.unknown())
export const zGetAppsAnnotationReplyByActionStatusByJobIdPath = z.object({
action: z.string(),
job_id: z.string(),
})
/**
* Job status retrieved successfully
*/
export const zGetAppsAnnotationReplyByActionStatusByJobIdResponse = z.record(
z.string(),
z.unknown(),
)
/**
* Annotations retrieved successfully
*/
export const zGetAppsAnnotationsResponse = zAnnotationList
export const zPostAppsAnnotationsBody = zAnnotationCreatePayload
/**
* Annotation created successfully
*/
export const zPostAppsAnnotationsResponse = zAnnotation
export const zDeleteAppsAnnotationsByAnnotationIdPath = z.object({
annotation_id: z.string(),
})
/**
* Annotation deleted successfully
*/
export const zDeleteAppsAnnotationsByAnnotationIdResponse = z.record(z.string(), z.never())
export const zPutAppsAnnotationsByAnnotationIdBody = zAnnotationCreatePayload
export const zPutAppsAnnotationsByAnnotationIdPath = z.object({
annotation_id: z.string(),
})
/**
* Annotation updated successfully
*/
export const zPutAppsAnnotationsByAnnotationIdResponse = zAnnotation
/**
* Audio successfully transcribed
*/
export const zPostAudioToTextResponse = z.record(z.string(), z.unknown())
export const zPostChatMessagesBody = zChatRequestPayload
/**
* Message sent successfully
*/
export const zPostChatMessagesResponse = z.record(z.string(), z.unknown())
export const zPostChatMessagesByTaskIdStopPath = z.object({
task_id: z.string(),
})
/**
* Task stopped successfully
*/
export const zPostChatMessagesByTaskIdStopResponse = zSimpleResultResponse
export const zPostCompletionMessagesBody = zCompletionRequestPayload
/**
* Completion created successfully
*/
export const zPostCompletionMessagesResponse = z.record(z.string(), z.unknown())
export const zPostCompletionMessagesByTaskIdStopPath = z.object({
task_id: z.string(),
})
/**
* Task stopped successfully
*/
export const zPostCompletionMessagesByTaskIdStopResponse = zSimpleResultResponse
export const zGetConversationsQuery = z.object({
last_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
sort_by: z
.enum(['-created_at', '-updated_at', 'created_at', 'updated_at'])
.optional()
.default('-updated_at'),
})
/**
* Conversations retrieved successfully
*/
export const zGetConversationsResponse = z.record(z.string(), z.unknown())
export const zDeleteConversationsByCIdPath = z.object({
c_id: z.string(),
})
/**
* Conversation deleted successfully
*/
export const zDeleteConversationsByCIdResponse = z.record(z.string(), z.never())
export const zPostConversationsByCIdNameBody = zConversationRenamePayload
export const zPostConversationsByCIdNamePath = z.object({
c_id: z.string(),
})
/**
* Conversation renamed successfully
*/
export const zPostConversationsByCIdNameResponse = z.record(z.string(), z.unknown())
export const zGetConversationsByCIdVariablesPath = z.object({
c_id: z.string(),
})
export const zGetConversationsByCIdVariablesQuery = z.object({
last_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
variable_name: z.string().min(1).max(255).nullish(),
})
/**
* Variables retrieved successfully
*/
export const zGetConversationsByCIdVariablesResponse
= zConversationVariableInfiniteScrollPaginationResponse
export const zPutConversationsByCIdVariablesByVariableIdBody = zConversationVariableUpdatePayload
export const zPutConversationsByCIdVariablesByVariableIdPath = z.object({
c_id: z.string(),
variable_id: z.string(),
})
/**
* Variable updated successfully
*/
export const zPutConversationsByCIdVariablesByVariableIdResponse = zConversationVariableResponse
export const zGetDatasetsQuery = z.object({
include_all: z.boolean().optional().default(false),
keyword: z.string().optional(),
limit: z.int().optional().default(20),
page: z.int().optional().default(1),
tag_ids: z.array(z.string()).optional(),
})
/**
* Datasets retrieved successfully
*/
export const zGetDatasetsResponse = zDatasetListResponse
export const zPostDatasetsBody = zDatasetCreatePayload
/**
* Dataset created successfully
*/
export const zPostDatasetsResponse = zDatasetDetailResponse
/**
* File uploaded successfully
*/
export const zPostDatasetsPipelineFileUploadResponse = z.record(z.string(), z.unknown())
export const zDeleteDatasetsTagsBody = zTagDeletePayload
/**
* Tag deleted successfully
*/
export const zDeleteDatasetsTagsResponse = z.record(z.string(), z.never())
/**
* Tags retrieved successfully
*/
export const zGetDatasetsTagsResponse = zKnowledgeTagListResponse
export const zPatchDatasetsTagsBody = zTagUpdatePayload
/**
* Tag updated successfully
*/
export const zPatchDatasetsTagsResponse = zKnowledgeTagResponse
export const zPostDatasetsTagsBody = zTagCreatePayload
/**
* Tag created successfully
*/
export const zPostDatasetsTagsResponse = zKnowledgeTagResponse
export const zPostDatasetsTagsBindingBody = zTagBindingPayload
/**
* Tags bound successfully
*/
export const zPostDatasetsTagsBindingResponse = z.record(z.string(), z.never())
export const zPostDatasetsTagsUnbindingBody = zTagUnbindingPayload
/**
* Tags unbound successfully
*/
export const zPostDatasetsTagsUnbindingResponse = z.record(z.string(), z.never())
export const zDeleteDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset deleted successfully
*/
export const zDeleteDatasetsByDatasetIdResponse = z.record(z.string(), z.never())
export const zGetDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset retrieved successfully
*/
export const zGetDatasetsByDatasetIdResponse = zDatasetDetailWithPartialMembersResponse
export const zPatchDatasetsByDatasetIdBody = zDatasetUpdatePayload
export const zPatchDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset updated successfully
*/
export const zPatchDatasetsByDatasetIdResponse = zDatasetDetailWithPartialMembersResponse
export const zPostDatasetsByDatasetIdDocumentCreateByFilePath = z.object({
dataset_id: z.string(),
})
/**
* Document created successfully
*/
export const zPostDatasetsByDatasetIdDocumentCreateByFileResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentCreateByTextBody = zDocumentTextCreatePayload
export const zPostDatasetsByDatasetIdDocumentCreateByTextPath = z.object({
dataset_id: z.string(),
})
/**
* Document created successfully
*/
export const zPostDatasetsByDatasetIdDocumentCreateByTextResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentCreateByFile2Path = z.object({
dataset_id: z.string(),
})
/**
* Document created successfully
*/
export const zPostDatasetsByDatasetIdDocumentCreateByFile2Response = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentCreateByText2Body = zDocumentTextCreatePayload
export const zPostDatasetsByDatasetIdDocumentCreateByText2Path = z.object({
dataset_id: z.string(),
})
/**
* Document created successfully
*/
export const zPostDatasetsByDatasetIdDocumentCreateByText2Response = z.record(
z.string(),
z.unknown(),
)
export const zGetDatasetsByDatasetIdDocumentsPath = z.object({
dataset_id: z.string(),
})
/**
* Documents retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdDocumentsDownloadZipBody = zDocumentBatchDownloadZipPayload
export const zPostDatasetsByDatasetIdDocumentsDownloadZipPath = z.object({
dataset_id: z.string(),
})
/**
* ZIP archive generated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsDownloadZipResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsMetadataBody = zMetadataOperationData
export const zPostDatasetsByDatasetIdDocumentsMetadataPath = z.object({
dataset_id: z.string(),
})
/**
* Documents metadata updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsMetadataResponse = zDatasetMetadataActionResponse
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
})
/**
* Document status updated successfully
*/
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionResponse = zSimpleResultResponse
export const zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusPath = z.object({
batch: z.string(),
dataset_id: z.string(),
})
/**
* Indexing status retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusResponse = z.record(
z.string(),
z.unknown(),
)
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document deleted successfully
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.record(
z.string(),
z.never(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document updated successfully
*/
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Download URL generated successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse = zUrlResponse
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery = z.object({
keyword: z.string().nullish(),
status: z.array(z.string()).optional(),
})
/**
* Segments retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBody = zSegmentCreatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Segments created successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse = z.record(
z.string(),
z.unknown(),
)
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Segment deleted successfully
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse = z.record(
z.string(),
z.never(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Segment retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBody
= zSegmentUpdatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Segment updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery
= z.object({
keyword: z.string().nullish(),
limit: z.int().gte(1).optional().default(20),
page: z.int().gte(1).optional().default(1),
})
/**
* Child chunks retrieved successfully
*/
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse
= z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksBody
= zChildChunkCreatePayload
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Child chunk created successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse
= z.record(z.string(), z.unknown())
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Child chunk deleted successfully
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse
= z.record(z.string(), z.never())
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody
= zChildChunkUpdatePayload
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
child_chunk_id: z.string(),
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
})
/**
* Child chunk updated successfully
*/
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse
= z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFilePath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextBody = zDocumentTextUpdate
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextPath = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Path = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Response = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Body = zDocumentTextUpdate
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Path = z.object({
dataset_id: z.string(),
document_id: z.string(),
})
/**
* Document updated successfully
*/
export const zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Response = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdHitTestingBody = zHitTestingPayload
export const zPostDatasetsByDatasetIdHitTestingPath = z.object({
dataset_id: z.string(),
})
/**
* Hit testing results
*/
export const zPostDatasetsByDatasetIdHitTestingResponse = zHitTestingResponse
export const zGetDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
})
/**
* Metadata retrieved successfully
*/
export const zGetDatasetsByDatasetIdMetadataResponse = zDatasetMetadataListResponse
export const zPostDatasetsByDatasetIdMetadataBody = zMetadataArgs
export const zPostDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
})
/**
* Metadata created successfully
*/
export const zPostDatasetsByDatasetIdMetadataResponse = zDatasetMetadataResponse
export const zGetDatasetsByDatasetIdMetadataBuiltInPath = z.object({
dataset_id: z.string(),
})
/**
* Built-in fields retrieved successfully
*/
export const zGetDatasetsByDatasetIdMetadataBuiltInResponse = zDatasetMetadataBuiltInFieldsResponse
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionPath = z.object({
action: z.string(),
dataset_id: z.string(),
})
/**
* Action completed successfully
*/
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse
= zDatasetMetadataActionResponse
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
})
/**
* Metadata deleted successfully
*/
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse = z.record(
z.string(),
z.never(),
)
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdBody = zMetadataUpdatePayload
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
})
/**
* Metadata updated successfully
*/
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse = zDatasetMetadataResponse
export const zGetDatasetsByDatasetIdPipelineDatasourcePluginsPath = z.object({
dataset_id: z.string(),
})
export const zGetDatasetsByDatasetIdPipelineDatasourcePluginsQuery = z.object({
is_published: z.string().optional(),
})
/**
* Datasource plugins retrieved successfully
*/
export const zGetDatasetsByDatasetIdPipelineDatasourcePluginsResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunPath = z.object({
dataset_id: z.string(),
node_id: z.string(),
})
/**
* Datasource node run successfully
*/
export const zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunResponse = z.record(
z.string(),
z.unknown(),
)
export const zPostDatasetsByDatasetIdPipelineRunPath = z.object({
dataset_id: z.string(),
})
/**
* Pipeline run successfully
*/
export const zPostDatasetsByDatasetIdPipelineRunResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdRetrieveBody = zHitTestingPayload
export const zPostDatasetsByDatasetIdRetrievePath = z.object({
dataset_id: z.string(),
})
/**
* Hit testing results
*/
export const zPostDatasetsByDatasetIdRetrieveResponse = zHitTestingResponse
export const zGetDatasetsByDatasetIdTagsPath = z.object({
dataset_id: z.string(),
})
/**
* Tags retrieved successfully
*/
export const zGetDatasetsByDatasetIdTagsResponse = zDatasetBoundTagListResponse
export const zGetEndUsersByEndUserIdPath = z.object({
end_user_id: z.string(),
})
/**
* End user retrieved successfully
*/
export const zGetEndUsersByEndUserIdResponse = zEndUserDetail
/**
* File uploaded successfully
*/
export const zPostFilesUploadResponse = zFileResponse
export const zGetFilesByFileIdPreviewPath = z.object({
file_id: z.string(),
})
export const zGetFilesByFileIdPreviewQuery = z.object({
as_attachment: z.boolean().optional().default(false),
})
/**
* File retrieved successfully
*/
export const zGetFilesByFileIdPreviewResponse = z.record(z.string(), z.unknown())
export const zGetFormHumanInputByFormTokenPath = z.object({
form_token: z.string(),
})
/**
* Form retrieved successfully
*/
export const zGetFormHumanInputByFormTokenResponse = z.record(z.string(), z.unknown())
export const zPostFormHumanInputByFormTokenBody = zHumanInputFormSubmitPayload
export const zPostFormHumanInputByFormTokenPath = z.object({
form_token: z.string(),
})
/**
* Form submitted successfully
*/
export const zPostFormHumanInputByFormTokenResponse = z.record(z.string(), z.unknown())
/**
* Application info retrieved successfully
*/
export const zGetInfoResponse = zAppInfoResponse
export const zGetMessagesQuery = z.object({
conversation_id: z.string(),
first_id: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
})
/**
* Messages retrieved successfully
*/
export const zGetMessagesResponse = z.record(z.string(), z.unknown())
export const zPostMessagesByMessageIdFeedbacksBody = zMessageFeedbackPayload
export const zPostMessagesByMessageIdFeedbacksPath = z.object({
message_id: z.string(),
})
/**
* Feedback submitted successfully
*/
export const zPostMessagesByMessageIdFeedbacksResponse = zResultResponse
export const zGetMessagesByMessageIdSuggestedPath = z.object({
message_id: z.string(),
})
/**
* Suggested questions retrieved successfully
*/
export const zGetMessagesByMessageIdSuggestedResponse = zSimpleResultStringListResponse
/**
* Metadata retrieved successfully
*/
export const zGetMetaResponse = z.record(z.string(), z.unknown())
/**
* Parameters retrieved successfully
*/
export const zGetParametersResponse = z.record(z.string(), z.unknown())
/**
* Site configuration retrieved successfully
*/
export const zGetSiteResponse = zSite
export const zPostTextToAudioBody = zTextToAudioPayload
/**
* Text successfully converted to audio
*/
export const zPostTextToAudioResponse = z.record(z.string(), z.unknown())
export const zGetWorkflowByTaskIdEventsPath = z.object({
task_id: z.string(),
})
export const zGetWorkflowByTaskIdEventsQuery = z.object({
continue_on_pause: z.string().optional(),
include_state_snapshot: z.string().optional(),
user: z.string().optional(),
})
/**
* SSE event stream
*/
export const zGetWorkflowByTaskIdEventsResponse = z.record(z.string(), z.unknown())
export const zGetWorkflowsLogsQuery = z.object({
created_at__after: z.string().nullish(),
created_at__before: z.string().nullish(),
created_by_account: z.string().nullish(),
created_by_end_user_session_id: z.string().nullish(),
keyword: z.string().nullish(),
limit: z.int().gte(1).lte(100).optional().default(20),
page: z.int().gte(1).lte(99999).optional().default(1),
status: z.enum(['failed', 'stopped', 'succeeded']).nullish(),
})
/**
* Logs retrieved successfully
*/
export const zGetWorkflowsLogsResponse = zWorkflowAppLogPaginationResponse
export const zPostWorkflowsRunBody = zWorkflowRunPayload
/**
* Workflow executed successfully
*/
export const zPostWorkflowsRunResponse = z.record(z.string(), z.unknown())
export const zGetWorkflowsRunByWorkflowRunIdPath = z.object({
workflow_run_id: z.string(),
})
/**
* Workflow run details retrieved successfully
*/
export const zGetWorkflowsRunByWorkflowRunIdResponse = zWorkflowRunResponse
export const zPostWorkflowsTasksByTaskIdStopPath = z.object({
task_id: z.string(),
})
/**
* Task stopped successfully
*/
export const zPostWorkflowsTasksByTaskIdStopResponse = zSimpleResultResponse
export const zPostWorkflowsByWorkflowIdRunBody = zWorkflowRunPayload
export const zPostWorkflowsByWorkflowIdRunPath = z.object({
workflow_id: z.string(),
})
/**
* Workflow executed successfully
*/
export const zPostWorkflowsByWorkflowIdRunResponse = z.record(z.string(), z.unknown())
export const zGetWorkspacesCurrentModelsModelTypesByModelTypePath = z.object({
model_type: z.string(),
})
/**
* Models retrieved successfully
*/
export const zGetWorkspacesCurrentModelsModelTypesByModelTypeResponse = z.record(
z.string(),
z.unknown(),
)