dify/packages/contracts/generated/api/service/zod.gen.ts
Asuka Minato 8fd616d27f
refactor: add type to test (#30873)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-05-07 03:46:23 +00:00

1600 lines
39 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(),
})
/**
* 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'),
})
/**
* 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', '-created_at', 'updated_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(),
})
/**
* 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),
})
/**
* 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(),
})
/**
* MessageFeedbackPayload
*/
export const zMessageFeedbackPayload = z.object({
content: z.string().nullish(),
rating: z.enum(['like', 'dislike']).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(['string', 'number', 'time']),
})
/**
* MetadataUpdatePayload
*/
export const zMetadataUpdatePayload = z.object({
name: z.string(),
})
/**
* 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(),
})
/**
* 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
*/
export const zTagUnbindingPayload = z.object({
tag_id: z.string(),
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(),
})
/**
* 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(['succeeded', 'failed', 'stopped']).nullish(),
})
/**
* 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(),
})
/**
* Condition
*
* Condition detail
*/
export const zCondition = z.object({
comparison_operator: z.enum([
'contains',
'not contains',
'start with',
'end with',
'is',
'is not',
'empty',
'not empty',
'in',
'not in',
'=',
'≠',
'>',
'<',
'≥',
'≤',
'before',
'after',
]),
name: z.string(),
value: z.unknown().optional(),
})
/**
* DatasetPermissionEnum
*/
export const zDatasetPermissionEnum = z.enum(['only_me', 'all_team_members', 'partial_members'])
/**
* MetadataFilteringCondition
*
* Metadata Filtering Condition.
*/
export const zMetadataFilteringCondition = z.object({
conditions: z.array(zCondition).nullish(),
logical_operator: z.enum(['and', 'or']).nullish().default('and'),
})
/**
* RerankingModel
*/
export const zRerankingModel = z.object({
reranking_model_name: z.string().nullish(),
reranking_provider_name: z.string().nullish(),
})
/**
* RetrievalMethod
*/
export const zRetrievalMethod = z.enum([
'semantic_search',
'full_text_search',
'hybrid_search',
'keyword_search',
])
/**
* 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(['semantic_first', 'keyword_first', 'customized']).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(['high_quality', 'economy']).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(['high_quality', 'economy']).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(),
})
/**
* 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(),
})
/**
* PreProcessingRule
*/
export const zPreProcessingRule = z.object({
enabled: z.boolean(),
id: z.string(),
})
/**
* 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(),
})
/**
* 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(),
})
export const zJsonValue = z.unknown()
/**
* HumanInputFormSubmitPayload
*/
export const zHumanInputFormSubmitPayload = z.object({
action: z.string(),
inputs: z.record(z.string(), zJsonValue),
})
/**
* 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),
})
/**
* MetadataOperationData
*
* Metadata operation data
*/
export const zMetadataOperationData = z.object({
operation_data: z.array(zDocumentMetadataOperation),
})
/**
* 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,
})
/**
* 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(),
})
/**
* 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(),
})
/**
* Success
*/
export const zGetRootResponse = z.record(z.string(), z.unknown())
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.unknown())
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 = z.record(z.string(), z.unknown())
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 = z.record(z.string(), z.unknown())
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', '-created_at', 'updated_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.unknown())
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
/**
* Datasets retrieved successfully
*/
export const zGetDatasetsResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsBody = zDatasetCreatePayload
/**
* Dataset created successfully
*/
export const zPostDatasetsResponse = z.record(z.string(), z.unknown())
/**
* 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.unknown())
/**
* Tags retrieved successfully
*/
export const zGetDatasetsTagsResponse = z.record(z.string(), z.unknown())
export const zPatchDatasetsTagsBody = zTagUpdatePayload
/**
* Tag updated successfully
*/
export const zPatchDatasetsTagsResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsTagsBody = zTagCreatePayload
/**
* Tag created successfully
*/
export const zPostDatasetsTagsResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsTagsBindingBody = zTagBindingPayload
/**
* Tags bound successfully
*/
export const zPostDatasetsTagsBindingResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsTagsUnbindingBody = zTagUnbindingPayload
/**
* Tag unbound successfully
*/
export const zPostDatasetsTagsUnbindingResponse = z.record(z.string(), z.unknown())
export const zDeleteDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset deleted successfully
*/
export const zDeleteDatasetsByDatasetIdResponse = z.record(z.string(), z.unknown())
export const zGetDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset retrieved successfully
*/
export const zGetDatasetsByDatasetIdResponse = z.record(z.string(), z.unknown())
export const zPatchDatasetsByDatasetIdBody = zDatasetUpdatePayload
export const zPatchDatasetsByDatasetIdPath = z.object({
dataset_id: z.string(),
})
/**
* Dataset updated successfully
*/
export const zPatchDatasetsByDatasetIdResponse = z.record(z.string(), z.unknown())
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 = z.record(z.string(), z.unknown())
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionPath = z.object({
dataset_id: z.string(),
action: z.string(),
})
/**
* Document status updated successfully
*/
export const zPatchDatasetsByDatasetIdDocumentsStatusByActionResponse = z.record(
z.string(),
z.unknown(),
)
export const zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusPath = z.object({
dataset_id: z.string(),
batch: 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.unknown(),
)
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 = z.record(
z.string(),
z.unknown(),
)
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.unknown(),
)
export const zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath = z.object({
segment_id: z.string(),
document_id: z.string(),
dataset_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({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_id: z.string(),
})
/**
* Child chunk deleted successfully
*/
export const zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse
= z.record(z.string(), z.unknown())
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody
= zChildChunkUpdatePayload
export const zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath
= z.object({
dataset_id: z.string(),
document_id: z.string(),
segment_id: z.string(),
child_chunk_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 = z.record(z.string(), z.unknown())
export const zGetDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
})
/**
* Metadata retrieved successfully
*/
export const zGetDatasetsByDatasetIdMetadataResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdMetadataBody = zMetadataArgs
export const zPostDatasetsByDatasetIdMetadataPath = z.object({
dataset_id: z.string(),
})
/**
* Metadata created successfully
*/
export const zPostDatasetsByDatasetIdMetadataResponse = z.record(z.string(), z.unknown())
export const zGetDatasetsByDatasetIdMetadataBuiltInPath = z.object({
dataset_id: z.string(),
})
/**
* Built-in fields retrieved successfully
*/
export const zGetDatasetsByDatasetIdMetadataBuiltInResponse = z.record(z.string(), z.unknown())
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionPath = z.object({
dataset_id: z.string(),
action: z.string(),
})
/**
* Action completed successfully
*/
export const zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse = z.record(
z.string(),
z.unknown(),
)
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
})
/**
* Metadata deleted successfully
*/
export const zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse = z.record(
z.string(),
z.unknown(),
)
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdBody = zMetadataUpdatePayload
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdPath = z.object({
dataset_id: z.string(),
metadata_id: z.string(),
})
/**
* Metadata updated successfully
*/
export const zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse = z.record(
z.string(),
z.unknown(),
)
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 = z.record(z.string(), z.unknown())
export const zGetDatasetsByDatasetIdTagsPath = z.object({
dataset_id: z.string(),
})
/**
* Tags retrieved successfully
*/
export const zGetDatasetsByDatasetIdTagsResponse = z.record(z.string(), z.unknown())
export const zGetEndUsersByEndUserIdPath = z.object({
end_user_id: z.string(),
})
/**
* End user retrieved successfully
*/
export const zGetEndUsersByEndUserIdResponse = z.record(z.string(), z.unknown())
/**
* 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 = z.record(z.string(), z.unknown())
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 = z.record(z.string(), z.unknown())
export const zGetMessagesByMessageIdSuggestedPath = z.object({
message_id: z.string(),
})
/**
* Suggested questions retrieved successfully
*/
export const zGetMessagesByMessageIdSuggestedResponse = z.record(z.string(), z.unknown())
/**
* 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 = z.record(z.string(), z.unknown())
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({
user: z.string().optional(),
include_state_snapshot: z.string().optional(),
continue_on_pause: 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(['succeeded', 'failed', 'stopped']).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 = z.record(z.string(), z.unknown())
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(),
)