Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.
Python agentagentic-aiagentic-frameworkagentic-workflowaiautomationclaudedeepseekgenaigptllmlow-codemcpnextjsno-codeopenaipythonskillsworkflow
// This file is auto-generated by @hey-api/openapi-ts
import { oc } from '@orpc/contract'
import * as z from 'zod'
import {
zAgentNotPublishedError,
zAgentVersionNotFoundError,
zAppAbnormalStatusError,
zAppApiDisabledError,
zAppNotFoundError,
zAppSuggestedQuestionsAfterAnswerDisabledError,
zAppUnavailableError,
zArchivedDocumentImmutableError,
zAudioTooLargeError,
zCompletionRequestError,
zConversationCursorNotFoundError,
zConversationFirstMessageNotFoundError,
zConversationNotFoundError,
zConversationVariableNotFoundError,
zConversationVariableTypeMismatchError,
zDatasetNameDuplicateError,
zEndUserNotFoundError,
zFileAccessDeniedError,
zFileExtensionBlockedError,
zFileNotFoundError,
zFileTooLargeError,
zFilenameNotExistsError,
zForbiddenError,
zHumanInputFormExpiredError,
zHumanInputFormSubmittedError,
zInvalidActionError,
zInvalidFormDataError,
zInvalidMetadataError,
zKnowledgeFsAccessDeniedError,
zKnowledgeFsConflictError,
zKnowledgeFsInvalidCredentialError,
zKnowledgeFsInvalidRequestError,
zKnowledgeFsOperationUnavailableError,
zKnowledgeFsRateLimitExceededError,
zKnowledgeFsRequestRejectedError,
zKnowledgeFsRequestTooLargeError,
zKnowledgeFsResourceNotFoundError,
zKnowledgeFsUpstreamUnavailableError,
zMessageFeedbackRatingRequiredError,
zModelCurrentlyNotSupportError,
zNoAudioUploadedError,
zNoFileUploadedError,
zNotChatAppError,
zNotWorkflowAppError,
zPipelineRunError,
zProviderNotInitializeError,
zProviderNotSupportSpeechToTextError,
zProviderQuotaExceededError,
zRateLimitError,
zSpeechToTextDisabledError,
zTooManyFilesError,
zTriggerWorkflowServiceModeUnavailableError,
zUnsupportedAudioTypeError,
zUnsupportedFileTypeError,
zWorkflowVersionExecutionNotAllowedError,
zWorkspaceArchivedError,
zWorkspaceNotFoundError,
} from './zod.gen.ts'
import {
zDeleteAppsAnnotationsByAnnotationIdPath,
zDeleteAppsAnnotationsByAnnotationIdResponse,
zDeleteConversationsByConversationIdBody,
zDeleteConversationsByConversationIdPath,
zDeleteConversationsByConversationIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse,
zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath,
zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse,
zDeleteDatasetsByDatasetIdPath,
zDeleteDatasetsByDatasetIdResponse,
zDeleteDatasetsTagsBody,
zDeleteDatasetsTagsResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkBody,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkHeaders,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdBody,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdHeaders,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdJobsByJobIdPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdJobsByJobIdResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdBody,
zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdHeaders,
zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResponse,
zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdBody,
zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdHeaders,
zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath,
zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdQuery,
zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse,
zGetAppFeedbacksQuery,
zGetAppFeedbacksResponse,
zGetAppsAnnotationReplyByActionStatusByJobIdPath,
zGetAppsAnnotationReplyByActionStatusByJobIdResponse,
zGetAppsAnnotationsQuery,
zGetAppsAnnotationsResponse,
zGetConversationsByConversationIdVariablesPath,
zGetConversationsByConversationIdVariablesQuery,
zGetConversationsByConversationIdVariablesResponse,
zGetConversationsQuery,
zGetConversationsResponse,
zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusPath,
zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery,
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse,
zGetDatasetsByDatasetIdDocumentsPath,
zGetDatasetsByDatasetIdDocumentsQuery,
zGetDatasetsByDatasetIdDocumentsResponse,
zGetDatasetsByDatasetIdMetadataBuiltInPath,
zGetDatasetsByDatasetIdMetadataBuiltInResponse,
zGetDatasetsByDatasetIdMetadataPath,
zGetDatasetsByDatasetIdMetadataResponse,
zGetDatasetsByDatasetIdPath,
zGetDatasetsByDatasetIdPipelineDatasourcePluginsPath,
zGetDatasetsByDatasetIdPipelineDatasourcePluginsQuery,
zGetDatasetsByDatasetIdPipelineDatasourcePluginsResponse,
zGetDatasetsByDatasetIdResponse,
zGetDatasetsByDatasetIdTagsPath,
zGetDatasetsByDatasetIdTagsResponse,
zGetDatasetsQuery,
zGetDatasetsResponse,
zGetDatasetsTagsResponse,
zGetEndUsersByEndUserIdPath,
zGetEndUsersByEndUserIdResponse,
zGetFilesByFileIdPreviewPath,
zGetFilesByFileIdPreviewQuery,
zGetFilesByFileIdPreviewResponse,
zGetFormHumanInputByFormTokenPath,
zGetFormHumanInputByFormTokenResponse,
zGetInfoResponse,
zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksPath,
zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksQuery,
zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksResponse,
zGetKnowledgeFsSpacesByControlSpaceIdBulkJobsByJobIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdBulkJobsByJobIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDeletionBatchesByBatchIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdDeletionBatchesByBatchIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolvePath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolveQuery,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolveResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdOutlinePath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdOutlineResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksByChunkIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksByChunkIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksPath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksQuery,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsPath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsPath,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdJobsByJobIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdJobsByJobIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksByTaskIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksByTaskIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksPath,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksQuery,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksResponse,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsPath,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsPath,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksPath,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksQuery,
zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSettingsMigrationsByMigrationIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdSettingsMigrationsByMigrationIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSettingsPath,
zGetKnowledgeFsSpacesByControlSpaceIdSettingsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourceProvidersPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourceProvidersResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourcesResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsPath,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsPath,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsQuery,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsResponse,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidencePath,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidenceQuery,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidenceResponse,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingPath,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingQuery,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingResponse,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdPath,
zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdResponse,
zGetKnowledgeFsSpacesByControlSpaceIdTracesPath,
zGetKnowledgeFsSpacesByControlSpaceIdTracesQuery,
zGetKnowledgeFsSpacesByControlSpaceIdTracesResponse,
zGetMessagesByMessageIdSuggestedPath,
zGetMessagesByMessageIdSuggestedQuery,
zGetMessagesByMessageIdSuggestedResponse,
zGetMessagesQuery,
zGetMessagesResponse,
zGetMetaResponse,
zGetParametersResponse,
zGetRootResponse,
zGetSiteResponse,
zGetWorkflowByWorkflowRunIdEventsPath,
zGetWorkflowByWorkflowRunIdEventsQuery,
zGetWorkflowByWorkflowRunIdEventsResponse,
zGetWorkflowsLogsQuery,
zGetWorkflowsLogsResponse,
zGetWorkflowsRunByWorkflowRunIdPath,
zGetWorkflowsRunByWorkflowRunIdResponse,
zGetWorkspacesCurrentModelsModelTypesByModelTypePath,
zGetWorkspacesCurrentModelsModelTypesByModelTypeResponse,
zPatchDatasetsByDatasetIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdResponse,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
zPatchDatasetsByDatasetIdDocumentsStatusByActionBody,
zPatchDatasetsByDatasetIdDocumentsStatusByActionPath,
zPatchDatasetsByDatasetIdDocumentsStatusByActionResponse,
zPatchDatasetsByDatasetIdMetadataByMetadataIdBody,
zPatchDatasetsByDatasetIdMetadataByMetadataIdPath,
zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse,
zPatchDatasetsByDatasetIdPath,
zPatchDatasetsByDatasetIdResponse,
zPatchDatasetsTagsBody,
zPatchDatasetsTagsResponse,
zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdBody,
zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath,
zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse,
zPatchKnowledgeFsSpacesByControlSpaceIdSettingsBody,
zPatchKnowledgeFsSpacesByControlSpaceIdSettingsPath,
zPatchKnowledgeFsSpacesByControlSpaceIdSettingsResponse,
zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdBody,
zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath,
zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse,
zPostAppsAnnotationReplyByActionBody,
zPostAppsAnnotationReplyByActionPath,
zPostAppsAnnotationReplyByActionResponse,
zPostAppsAnnotationsBody,
zPostAppsAnnotationsResponse,
zPostAudioToTextBody,
zPostAudioToTextResponse,
zPostChatMessagesBody,
zPostChatMessagesByTaskIdStopBody,
zPostChatMessagesByTaskIdStopPath,
zPostChatMessagesByTaskIdStopResponse,
zPostChatMessagesResponse,
zPostCompletionMessagesBody,
zPostCompletionMessagesByTaskIdStopBody,
zPostCompletionMessagesByTaskIdStopPath,
zPostCompletionMessagesByTaskIdStopResponse,
zPostCompletionMessagesResponse,
zPostConversationsByConversationIdNameBody,
zPostConversationsByConversationIdNamePath,
zPostConversationsByConversationIdNameResponse,
zPostDatasetsBody,
zPostDatasetsByDatasetIdDocumentCreateByFile2Body,
zPostDatasetsByDatasetIdDocumentCreateByFile2Path,
zPostDatasetsByDatasetIdDocumentCreateByFile2Response,
zPostDatasetsByDatasetIdDocumentCreateByFileBody,
zPostDatasetsByDatasetIdDocumentCreateByFilePath,
zPostDatasetsByDatasetIdDocumentCreateByFileResponse,
zPostDatasetsByDatasetIdDocumentCreateByText2Body,
zPostDatasetsByDatasetIdDocumentCreateByText2Path,
zPostDatasetsByDatasetIdDocumentCreateByText2Response,
zPostDatasetsByDatasetIdDocumentCreateByTextBody,
zPostDatasetsByDatasetIdDocumentCreateByTextPath,
zPostDatasetsByDatasetIdDocumentCreateByTextResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Body,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Path,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Response,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFilePath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileResponse,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Body,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Path,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Response,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextBody,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextPath,
zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextResponse,
zPostDatasetsByDatasetIdDocumentsDownloadZipBody,
zPostDatasetsByDatasetIdDocumentsDownloadZipPath,
zPostDatasetsByDatasetIdDocumentsDownloadZipResponse,
zPostDatasetsByDatasetIdDocumentsMetadataBody,
zPostDatasetsByDatasetIdDocumentsMetadataPath,
zPostDatasetsByDatasetIdDocumentsMetadataResponse,
zPostDatasetsByDatasetIdHitTestingBody,
zPostDatasetsByDatasetIdHitTestingPath,
zPostDatasetsByDatasetIdHitTestingResponse,
zPostDatasetsByDatasetIdMetadataBody,
zPostDatasetsByDatasetIdMetadataBuiltInByActionPath,
zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse,
zPostDatasetsByDatasetIdMetadataPath,
zPostDatasetsByDatasetIdMetadataResponse,
zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunBody,
zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunPath,
zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunResponse,
zPostDatasetsByDatasetIdPipelineRunBody,
zPostDatasetsByDatasetIdPipelineRunPath,
zPostDatasetsByDatasetIdPipelineRunResponse,
zPostDatasetsByDatasetIdRetrieveBody,
zPostDatasetsByDatasetIdRetrievePath,
zPostDatasetsByDatasetIdRetrieveResponse,
zPostDatasetsPipelineFileUploadBody,
zPostDatasetsPipelineFileUploadResponse,
zPostDatasetsResponse,
zPostDatasetsTagsBindingBody,
zPostDatasetsTagsBindingResponse,
zPostDatasetsTagsBody,
zPostDatasetsTagsResponse,
zPostDatasetsTagsUnbindingBody,
zPostDatasetsTagsUnbindingResponse,
zPostFilesUploadBody,
zPostFilesUploadResponse,
zPostFormHumanInputByFormTokenBody,
zPostFormHumanInputByFormTokenPath,
zPostFormHumanInputByFormTokenResponse,
zPostKnowledgeFsQueryStreamBody,
zPostKnowledgeFsQueryStreamResponse,
zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryPath,
zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryResponse,
zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexBody,
zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexPath,
zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexResponse,
zPostKnowledgeFsSpacesByControlSpaceIdJobsByJobIdRetryPath,
zPostKnowledgeFsSpacesByControlSpaceIdJobsByJobIdRetryResponse,
zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionBody,
zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionPath,
zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionResponse,
zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesBody,
zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesPath,
zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesResponse,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksBody,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResumePath,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResumeResponse,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPath,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanBody,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanPath,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanResponse,
zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdTestPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdTestResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourcesResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdRetryPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdRetryResponse,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionBody,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionHeaders,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionPath,
zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionResponse,
zPostMessagesByMessageIdFeedbacksBody,
zPostMessagesByMessageIdFeedbacksPath,
zPostMessagesByMessageIdFeedbacksResponse,
zPostTextToAudioBody,
zPostTextToAudioResponse,
zPostWorkflowsByWorkflowIdRunBody,
zPostWorkflowsByWorkflowIdRunPath,
zPostWorkflowsByWorkflowIdRunResponse,
zPostWorkflowsRunBody,
zPostWorkflowsRunResponse,
zPostWorkflowsTasksByTaskIdStopBody,
zPostWorkflowsTasksByTaskIdStopPath,
zPostWorkflowsTasksByTaskIdStopResponse,
zPutAppsAnnotationsByAnnotationIdBody,
zPutAppsAnnotationsByAnnotationIdPath,
zPutAppsAnnotationsByAnnotationIdResponse,
zPutConversationsByConversationIdVariablesByVariableIdBody,
zPutConversationsByConversationIdVariablesByVariableIdPath,
zPutConversationsByConversationIdVariablesByVariableIdResponse,
zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyBody,
zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyPath,
zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyResponse,
} from './zod.gen.ts'
/**
* Return public Service API metadata without requiring an API key
*/
export const get = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getRoot',
path: '/',
summary: 'Return public Service API metadata without requiring an API key',
tags: ['service_api'],
})
.output(zGetRootResponse)
export const root = {
get,
}
/**
* List App Feedbacks
*
* Retrieve a paginated list of all feedback submitted for messages in this application, including both end-user and admin feedback.
*/
export const get2 = oc
.route({
description:
'Retrieve a paginated list of all feedback submitted for messages in this application, including both end-user and admin feedback.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAppFeedbacks',
path: '/app/feedbacks',
summary: 'List App Feedbacks',
tags: ['Feedback'],
})
.input(z.object({ query: zGetAppFeedbacksQuery.optional() }).optional())
.output(zGetAppFeedbacksResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
app_unavailable: { status: 400, data: zAppUnavailableError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const feedbacks = {
get: get2,
}
export const app = {
feedbacks,
}
/**
* Get Annotation Reply Job Status
*
* Retrieves the status of an asynchronous annotation reply configuration job started by [Configure Annotation Reply](/api-reference/annotations/configure-annotation-reply).
*/
export const get3 = oc
.route({
description:
'Retrieves the status of an asynchronous annotation reply configuration job started by [Configure Annotation Reply](/api-reference/annotations/configure-annotation-reply).',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAppsAnnotationReplyByActionStatusByJobId',
path: '/apps/annotation-reply/{action}/status/{job_id}',
summary: 'Get Annotation Reply Job Status',
tags: ['Annotations'],
})
.input(z.object({ params: zGetAppsAnnotationReplyByActionStatusByJobIdPath }))
.output(zGetAppsAnnotationReplyByActionStatusByJobIdResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const byJobId = {
get: get3,
}
export const status = {
byJobId,
}
/**
* Configure Annotation Reply
*
* Enables or disables the annotation reply feature. Requires embedding model configuration when enabling. Executes asynchronously — use [Get Annotation Reply Job Status](/api-reference/annotations/get-annotation-reply-job-status) to track progress.
*/
export const post = oc
.route({
description:
'Enables or disables the annotation reply feature. Requires embedding model configuration when enabling. Executes asynchronously — use [Get Annotation Reply Job Status](/api-reference/annotations/get-annotation-reply-job-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAppsAnnotationReplyByAction',
path: '/apps/annotation-reply/{action}',
summary: 'Configure Annotation Reply',
tags: ['Annotations'],
})
.input(
z.object({
body: zPostAppsAnnotationReplyByActionBody,
params: zPostAppsAnnotationReplyByActionPath,
}),
)
.output(zPostAppsAnnotationReplyByActionResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const byAction = {
post,
status,
}
export const annotationReply = {
byAction,
}
/**
* Delete Annotation
*
* Deletes an annotation and its associated hit history.
*/
export const delete_ = oc
.route({
description: 'Deletes an annotation and its associated hit history.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteAppsAnnotationsByAnnotationId',
path: '/apps/annotations/{annotation_id}',
successStatus: 204,
summary: 'Delete Annotation',
tags: ['Annotations'],
})
.input(z.object({ params: zDeleteAppsAnnotationsByAnnotationIdPath }))
.output(zDeleteAppsAnnotationsByAnnotationIdResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
/**
* Update Annotation
*
* Updates the question and answer of an existing annotation.
*/
export const put = oc
.route({
description: 'Updates the question and answer of an existing annotation.',
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putAppsAnnotationsByAnnotationId',
path: '/apps/annotations/{annotation_id}',
summary: 'Update Annotation',
tags: ['Annotations'],
})
.input(
z.object({
body: zPutAppsAnnotationsByAnnotationIdBody,
params: zPutAppsAnnotationsByAnnotationIdPath,
}),
)
.output(zPutAppsAnnotationsByAnnotationIdResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const byAnnotationId = {
delete: delete_,
put,
}
/**
* List Annotations
*
* Retrieves a paginated list of annotations for the application. Supports keyword search filtering.
*/
export const get4 = oc
.route({
description:
'Retrieves a paginated list of annotations for the application. Supports keyword search filtering.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getAppsAnnotations',
path: '/apps/annotations',
summary: 'List Annotations',
tags: ['Annotations'],
})
.input(z.object({ query: zGetAppsAnnotationsQuery.optional() }).optional())
.output(zGetAppsAnnotationsResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
/**
* Create Annotation
*
* Creates a new annotation. Annotations provide predefined question-answer pairs that the app can match and return directly instead of generating a response.
*/
export const post2 = oc
.route({
description:
'Creates a new annotation. Annotations provide predefined question-answer pairs that the app can match and return directly instead of generating a response.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAppsAnnotations',
path: '/apps/annotations',
successStatus: 201,
summary: 'Create Annotation',
tags: ['Annotations'],
})
.input(z.object({ body: zPostAppsAnnotationsBody }))
.output(zPostAppsAnnotationsResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const annotations = {
get: get4,
post: post2,
byAnnotationId,
}
export const apps = {
annotationReply,
annotations,
}
/**
* Convert Audio to Text
*
* Convert audio file to text. Supported MIME types: `audio/mp3`, `audio/mpga`, `audio/m4a`, `audio/x-m4a`, `audio/wav`, and `audio/amr`. File size limit is `30 MB`.
*/
export const post3 = oc
.route({
description:
'Convert audio file to text. Supported MIME types: `audio/mp3`, `audio/mpga`, `audio/m4a`, `audio/x-m4a`, `audio/wav`, and `audio/amr`. File size limit is `30 MB`.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postAudioToText',
path: '/audio-to-text',
summary: 'Convert Audio to Text',
tags: ['TTS'],
})
.input(z.object({ body: zPostAudioToTextBody }))
.output(zPostAudioToTextResponse)
.errors({
app_unavailable: { status: 400, data: zAppUnavailableError },
audio_too_large: { status: 413, data: zAudioTooLargeError },
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
no_audio_uploaded: { status: 400, data: zNoAudioUploadedError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_not_support_speech_to_text: {
status: 400,
data: zProviderNotSupportSpeechToTextError,
},
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
speech_to_text_disabled: { status: 400, data: zSpeechToTextDisabledError },
unsupported_audio_type: { status: 415, data: zUnsupportedAudioTypeError },
})
export const audioToText = {
post: post3,
}
/**
* Stop Chat Message Generation
*
* Stops a chat message generation task. Only supported in `streaming` mode.
*/
export const post4 = oc
.route({
description: 'Stops a chat message generation task. Only supported in `streaming` mode.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postChatMessagesByTaskIdStop',
path: '/chat-messages/{task_id}/stop',
summary: 'Stop Chat Message Generation',
tags: ['Chatflows', 'Chats'],
})
.input(
z.object({
body: zPostChatMessagesByTaskIdStopBody,
params: zPostChatMessagesByTaskIdStopPath,
}),
)
.output(zPostChatMessagesByTaskIdStopResponse)
.errors({ not_chat_app: { status: 400, data: zNotChatAppError } })
export const stop = {
post: post4,
}
export const byTaskId = {
stop,
}
/**
* Send Chat Message
*
* Send a request to the chat application.
*/
export const post5 = oc
.route({
description: 'Send a request to the chat application.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postChatMessages',
path: '/chat-messages',
summary: 'Send Chat Message',
tags: ['Chatflows', 'Chats'],
})
.input(z.object({ body: zPostChatMessagesBody }))
.output(zPostChatMessagesResponse)
.errors({
agent_not_published: { status: 400, data: zAgentNotPublishedError },
app_unavailable: { status: 400, data: zAppUnavailableError },
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
not_chat_app: { status: 400, data: zNotChatAppError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
rate_limit_error: { status: 429, data: zRateLimitError },
workflow_version_execution_not_allowed: {
status: 403,
data: zWorkflowVersionExecutionNotAllowedError,
},
})
export const chatMessages = {
post: post5,
byTaskId,
}
/**
* Stop Completion Message Generation
*
* Stops a completion message generation task. Only supported in `streaming` mode.
*/
export const post6 = oc
.route({
description: 'Stops a completion message generation task. Only supported in `streaming` mode.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postCompletionMessagesByTaskIdStop',
path: '/completion-messages/{task_id}/stop',
summary: 'Stop Completion Message Generation',
tags: ['Completions'],
})
.input(
z.object({
body: zPostCompletionMessagesByTaskIdStopBody,
params: zPostCompletionMessagesByTaskIdStopPath,
}),
)
.output(zPostCompletionMessagesByTaskIdStopResponse)
.errors({ app_unavailable: { status: 400, data: zAppUnavailableError } })
export const stop2 = {
post: post6,
}
export const byTaskId2 = {
stop: stop2,
}
/**
* Send Completion Message
*
* Send a request to the text generation application.
*/
export const post7 = oc
.route({
description: 'Send a request to the text generation application.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postCompletionMessages',
path: '/completion-messages',
summary: 'Send Completion Message',
tags: ['Completions'],
})
.input(z.object({ body: zPostCompletionMessagesBody }))
.output(zPostCompletionMessagesResponse)
.errors({
app_unavailable: { status: 400, data: zAppUnavailableError },
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
})
export const completionMessages = {
post: post7,
byTaskId: byTaskId2,
}
/**
* Rename Conversation
*
* Rename a conversation or auto-generate a name. The conversation name is used for display on clients that support multiple conversations.
*/
export const post8 = oc
.route({
description:
'Rename a conversation or auto-generate a name. The conversation name is used for display on clients that support multiple conversations.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postConversationsByConversationIdName',
path: '/conversations/{conversation_id}/name',
summary: 'Rename Conversation',
tags: ['Conversations'],
})
.input(
z.object({
body: zPostConversationsByConversationIdNameBody,
params: zPostConversationsByConversationIdNamePath,
}),
)
.output(zPostConversationsByConversationIdNameResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
conversation_first_message_not_found: {
status: 404,
data: zConversationFirstMessageNotFoundError,
},
conversation_not_found: { status: 404, data: zConversationNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const name = {
post: post8,
}
/**
* Update Conversation Variable
*
* Update the value of a specific conversation variable. The value must match the expected type.
*/
export const put2 = oc
.route({
description:
'Update the value of a specific conversation variable. The value must match the expected type.',
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putConversationsByConversationIdVariablesByVariableId',
path: '/conversations/{conversation_id}/variables/{variable_id}',
summary: 'Update Conversation Variable',
tags: ['Conversations'],
})
.input(
z.object({
body: zPutConversationsByConversationIdVariablesByVariableIdBody,
params: zPutConversationsByConversationIdVariablesByVariableIdPath,
}),
)
.output(zPutConversationsByConversationIdVariablesByVariableIdResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
conversation_not_found: { status: 404, data: zConversationNotFoundError },
conversation_variable_not_found: { status: 404, data: zConversationVariableNotFoundError },
conversation_variable_type_mismatch: {
status: 400,
data: zConversationVariableTypeMismatchError,
},
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const byVariableId = {
put: put2,
}
/**
* List Conversation Variables
*
* Retrieve variables from a specific conversation.
*/
export const get5 = oc
.route({
description: 'Retrieve variables from a specific conversation.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getConversationsByConversationIdVariables',
path: '/conversations/{conversation_id}/variables',
summary: 'List Conversation Variables',
tags: ['Conversations'],
})
.input(
z.object({
params: zGetConversationsByConversationIdVariablesPath,
query: zGetConversationsByConversationIdVariablesQuery.optional(),
}),
)
.output(zGetConversationsByConversationIdVariablesResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
conversation_not_found: { status: 404, data: zConversationNotFoundError },
conversation_variable_not_found: { status: 404, data: zConversationVariableNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const variables = {
get: get5,
byVariableId,
}
/**
* Delete Conversation
*
* Delete a conversation.
*/
export const delete2 = oc
.route({
description: 'Delete a conversation.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteConversationsByConversationId',
path: '/conversations/{conversation_id}',
successStatus: 204,
summary: 'Delete Conversation',
tags: ['Conversations'],
})
.input(
z.object({
body: zDeleteConversationsByConversationIdBody,
params: zDeleteConversationsByConversationIdPath,
}),
)
.output(zDeleteConversationsByConversationIdResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
conversation_not_found: { status: 404, data: zConversationNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const byConversationId = {
delete: delete2,
name,
variables,
}
/**
* List Conversations
*
* Retrieve the conversation list for the current user, ordered by most recently active.
*/
export const get6 = oc
.route({
description:
'Retrieve the conversation list for the current user, ordered by most recently active.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getConversations',
path: '/conversations',
summary: 'List Conversations',
tags: ['Conversations'],
})
.input(z.object({ query: zGetConversationsQuery.optional() }).optional())
.output(zGetConversationsResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
conversation_cursor_not_found: { status: 404, data: zConversationCursorNotFoundError },
conversation_not_found: { status: 404, data: zConversationNotFoundError },
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const conversations = {
get: get6,
byConversationId,
}
/**
* Upload Pipeline File
*
* Upload a file for use in a knowledge pipeline. Accepts a single file via `multipart/form-data`.
*/
export const post9 = oc
.route({
description:
'Upload a file for use in a knowledge pipeline. Accepts a single file via `multipart/form-data`.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsPipelineFileUpload',
path: '/datasets/pipeline/file-upload',
successStatus: 201,
summary: 'Upload Pipeline File',
tags: ['Knowledge Pipeline'],
})
.input(z.object({ body: zPostDatasetsPipelineFileUploadBody }))
.output(zPostDatasetsPipelineFileUploadResponse)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
no_file_uploaded: { status: 400, data: zNoFileUploadedError },
too_many_files: { status: 400, data: zTooManyFilesError },
unsupported_file_type: { status: 415, data: zUnsupportedFileTypeError },
})
export const fileUpload = {
post: post9,
}
export const pipeline = {
fileUpload,
}
/**
* Create Tag Binding
*
* Bind one or more tags to a knowledge base. A knowledge base can have multiple tags.
*/
export const post10 = oc
.route({
description:
'Bind one or more tags to a knowledge base. A knowledge base can have multiple tags.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsTagsBinding',
path: '/datasets/tags/binding',
successStatus: 204,
summary: 'Create Tag Binding',
tags: ['Tags'],
})
.input(z.object({ body: zPostDatasetsTagsBindingBody }))
.output(zPostDatasetsTagsBindingResponse)
export const binding = {
post: post10,
}
/**
* Delete Tag Binding
*
* Remove one or more tags from a knowledge base.
*/
export const post11 = oc
.route({
description: 'Remove one or more tags from a knowledge base.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsTagsUnbinding',
path: '/datasets/tags/unbinding',
successStatus: 204,
summary: 'Delete Tag Binding',
tags: ['Tags'],
})
.input(z.object({ body: zPostDatasetsTagsUnbindingBody }))
.output(zPostDatasetsTagsUnbindingResponse)
export const unbinding = {
post: post11,
}
/**
* Delete Knowledge Tag
*
* Permanently delete a knowledge base tag. Does not delete the knowledge bases that were tagged.
*/
export const delete3 = oc
.route({
description:
'Permanently delete a knowledge base tag. Does not delete the knowledge bases that were tagged.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsTags',
path: '/datasets/tags',
successStatus: 204,
summary: 'Delete Knowledge Tag',
tags: ['Tags'],
})
.input(z.object({ body: zDeleteDatasetsTagsBody }))
.output(zDeleteDatasetsTagsResponse)
/**
* List Knowledge Tags
*
* Returns the list of all knowledge base tags in the workspace.
*/
export const get7 = oc
.route({
description: 'Returns the list of all knowledge base tags in the workspace.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsTags',
path: '/datasets/tags',
summary: 'List Knowledge Tags',
tags: ['Tags'],
})
.output(zGetDatasetsTagsResponse)
/**
* Update Knowledge Tag
*
* Rename an existing knowledge base tag.
*/
export const patch = oc
.route({
description: 'Rename an existing knowledge base tag.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsTags',
path: '/datasets/tags',
summary: 'Update Knowledge Tag',
tags: ['Tags'],
})
.input(z.object({ body: zPatchDatasetsTagsBody }))
.output(zPatchDatasetsTagsResponse)
/**
* Create Knowledge Tag
*
* Create a new tag for organizing knowledge bases.
*/
export const post12 = oc
.route({
description: 'Create a new tag for organizing knowledge bases.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsTags',
path: '/datasets/tags',
summary: 'Create Knowledge Tag',
tags: ['Tags'],
})
.input(z.object({ body: zPostDatasetsTagsBody }))
.output(zPostDatasetsTagsResponse)
export const tags = {
delete: delete3,
get: get7,
patch,
post: post12,
binding,
unbinding,
}
/**
* Create Document by File
*
* Create a document by uploading a file. Supports common document formats (PDF, TXT, DOCX, etc.). Processing is asynchronous — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*/
export const post13 = oc
.route({
description:
'Create a document by uploading a file. Supports common document formats (PDF, TXT, DOCX, etc.). Processing is asynchronous — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentCreateByFile',
path: '/datasets/{dataset_id}/document/create-by-file',
summary: 'Create Document by File',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentCreateByFileBody,
params: zPostDatasetsByDatasetIdDocumentCreateByFilePath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentCreateByFileResponse)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
no_file_uploaded: { status: 400, data: zNoFileUploadedError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
too_many_files: { status: 400, data: zTooManyFilesError },
})
/**
* Create Document by File
*
* Create a document by uploading a file. Supports common document formats (PDF, TXT, DOCX, etc.). Processing is asynchronous — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*
* @deprecated
*/
export const post14 = oc
.route({
deprecated: true,
description:
'Create a document by uploading a file. Supports common document formats (PDF, TXT, DOCX, etc.). Processing is asynchronous — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentCreateByFile',
path: '/datasets/{dataset_id}/document/create_by_file',
summary: 'Create Document by File',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentCreateByFile2Body,
params: zPostDatasetsByDatasetIdDocumentCreateByFile2Path,
}),
)
.output(zPostDatasetsByDatasetIdDocumentCreateByFile2Response)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
no_file_uploaded: { status: 400, data: zNoFileUploadedError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
too_many_files: { status: 400, data: zTooManyFilesError },
})
export const createByFile = {
post: post14,
}
/**
* Create Document by Text
*
* Create a document from raw text content. The document is processed asynchronously — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*/
export const post15 = oc
.route({
description:
'Create a document from raw text content. The document is processed asynchronously — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentCreateByText',
path: '/datasets/{dataset_id}/document/create-by-text',
summary: 'Create Document by Text',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentCreateByTextBody,
params: zPostDatasetsByDatasetIdDocumentCreateByTextPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentCreateByTextResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
/**
* Create document by text through the deprecated underscore alias
*
* Deprecated legacy alias for creating a new document by providing text content. Use /datasets/{dataset_id}/document/create-by-text instead.
*
* @deprecated
*/
export const post16 = oc
.route({
deprecated: true,
description:
'Deprecated legacy alias for creating a new document by providing text content. Use /datasets/{dataset_id}/document/create-by-text instead.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentCreateByText',
path: '/datasets/{dataset_id}/document/create_by_text',
summary: 'Create document by text through the deprecated underscore alias',
tags: ['service_api'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentCreateByText2Body,
params: zPostDatasetsByDatasetIdDocumentCreateByText2Path,
}),
)
.output(zPostDatasetsByDatasetIdDocumentCreateByText2Response)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
export const createByText = {
post: post16,
}
export const document_ = {
createByFile,
createByText,
}
/**
* Download Documents as ZIP
*
* Download multiple uploaded-file documents as a single ZIP archive. Accepts up to `100` document IDs.
*/
export const post17 = oc
.route({
description:
'Download multiple uploaded-file documents as a single ZIP archive. Accepts up to `100` document IDs.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsDownloadZip',
path: '/datasets/{dataset_id}/documents/download-zip',
summary: 'Download Documents as ZIP',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsDownloadZipBody,
params: zPostDatasetsByDatasetIdDocumentsDownloadZipPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsDownloadZipResponse)
export const downloadZip = {
post: post17,
}
/**
* Update Document Metadata in Batch
*
* Update metadata values for multiple documents at once. Each document in the request receives the specified metadata key-value pairs.
*/
export const post18 = oc
.route({
description:
'Update metadata values for multiple documents at once. Each document in the request receives the specified metadata key-value pairs.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsMetadata',
path: '/datasets/{dataset_id}/documents/metadata',
summary: 'Update Document Metadata in Batch',
tags: ['Metadata'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsMetadataBody,
params: zPostDatasetsByDatasetIdDocumentsMetadataPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsMetadataResponse)
export const metadata = {
post: post18,
}
/**
* Update Document Status in Batch
*
* Enable, disable, archive, or unarchive multiple documents at once.
*/
export const patch2 = oc
.route({
description: 'Enable, disable, archive, or unarchive multiple documents at once.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsStatusByAction',
path: '/datasets/{dataset_id}/documents/status/{action}',
summary: 'Update Document Status in Batch',
tags: ['Documents'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdDocumentsStatusByActionBody,
params: zPatchDatasetsByDatasetIdDocumentsStatusByActionPath,
}),
)
.output(zPatchDatasetsByDatasetIdDocumentsStatusByActionResponse)
.errors({ invalid_action: { status: 400, data: zInvalidActionError } })
export const byAction2 = {
patch: patch2,
}
export const status2 = {
byAction: byAction2,
}
/**
* Get Document Indexing Status
*
* Check the indexing progress of documents in a batch. Returns the current processing stage and chunk completion counts for each document. Poll this endpoint until `indexing_status` reaches `completed` or `error`. The status progresses through: `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.
*/
export const get8 = oc
.route({
description:
'Check the indexing progress of documents in a batch. Returns the current processing stage and chunk completion counts for each document. Poll this endpoint until `indexing_status` reaches `completed` or `error`. The status progresses through: `waiting` → `parsing` → `cleaning` → `splitting` → `indexing` → `completed`.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByBatchIndexingStatus',
path: '/datasets/{dataset_id}/documents/{batch}/indexing-status',
summary: 'Get Document Indexing Status',
tags: ['Documents'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusPath }))
.output(zGetDatasetsByDatasetIdDocumentsByBatchIndexingStatusResponse)
export const indexingStatus = {
get: get8,
}
export const byBatch = {
indexingStatus,
}
/**
* Download Document
*
* Get a signed download URL for a document's original uploaded file.
*/
export const get9 = oc
.route({
description: "Get a signed download URL for a document's original uploaded file.",
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdDownload',
path: '/datasets/{dataset_id}/documents/{document_id}/download',
summary: 'Download Document',
tags: ['Documents'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdDownloadResponse)
export const download = {
get: get9,
}
/**
* Delete Child Chunk
*
* Permanently delete a child chunk from its parent chunk.
*/
export const delete4 = oc
.route({
description: 'Permanently delete a child chunk from its parent chunk.',
inputStructure: 'detailed',
method: 'DELETE',
operationId:
'deleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}',
successStatus: 204,
summary: 'Delete Child Chunk',
tags: ['Chunks'],
})
.input(
z.object({
params:
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
}),
)
.output(
zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
)
/**
* Update Child Chunk
*
* Update the content of an existing child chunk.
*/
export const patch3 = oc
.route({
description: 'Update the content of an existing child chunk.',
inputStructure: 'detailed',
method: 'PATCH',
operationId:
'patchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks/{child_chunk_id}',
summary: 'Update Child Chunk',
tags: ['Chunks'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdBody,
params:
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdPath,
}),
)
.output(
zPatchDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksByChildChunkIdResponse,
)
export const byChildChunkId = {
delete: delete4,
patch: patch3,
}
/**
* List Child Chunks
*
* Returns a paginated list of child chunks under a specific parent chunk.
*/
export const get10 = oc
.route({
description: 'Returns a paginated list of child chunks under a specific parent chunk.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunks',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks',
summary: 'List Child Chunks',
tags: ['Chunks'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
query:
zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
/**
* Create Child Chunk
*
* Create a child chunk under the specified segment.
*/
export const post19 = oc
.route({
description: 'Create a child chunk under the specified segment.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunks',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}/child_chunks',
summary: 'Create Child Chunk',
tags: ['Chunks'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdChildChunksResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
export const childChunks = {
get: get10,
post: post19,
byChildChunkId,
}
/**
* Delete Chunk
*
* Permanently delete a chunk from the document.
*/
export const delete5 = oc
.route({
description: 'Permanently delete a chunk from the document.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}',
successStatus: 204,
summary: 'Delete Chunk',
tags: ['Chunks'],
})
.input(
z.object({ params: zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath }),
)
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse)
/**
* Get Chunk
*
* Retrieve detailed information about a specific chunk, including its content, keywords, and indexing status.
*/
export const get11 = oc
.route({
description:
'Retrieve detailed information about a specific chunk, including its content, keywords, and indexing status.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}',
summary: 'Get Chunk',
tags: ['Chunks'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath }))
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse)
/**
* Update Chunk
*
* Update a chunk's content, keywords, or answer. Re-triggers indexing for the modified chunk.
*/
export const post20 = oc
.route({
description:
"Update a chunk's content, keywords, or answer. Re-triggers indexing for the modified chunk.",
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentId',
path: '/datasets/{dataset_id}/documents/{document_id}/segments/{segment_id}',
summary: 'Update Chunk',
tags: ['Chunks'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBySegmentIdResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
export const bySegmentId = {
delete: delete5,
get: get11,
post: post20,
childChunks,
}
/**
* List Chunks
*
* Returns a paginated list of chunks within a document. Supports filtering by keyword and status.
*/
export const get12 = oc
.route({
description:
'Returns a paginated list of chunks within a document. Supports filtering by keyword and status.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentIdSegments',
path: '/datasets/{dataset_id}/documents/{document_id}/segments',
summary: 'List Chunks',
tags: ['Chunks'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
query: zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
/**
* Create Chunks
*
* Create one or more chunks within a document. Each chunk can include optional keywords and an answer field (for QA-mode documents).
*/
export const post21 = oc
.route({
description:
'Create one or more chunks within a document. Each chunk can include optional keywords and an answer field (for QA-mode documents).',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdSegments',
path: '/datasets/{dataset_id}/documents/{document_id}/segments',
summary: 'Create Chunks',
tags: ['Chunks'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdSegmentsResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
export const segments = {
get: get12,
post: post21,
bySegmentId,
}
/**
* Update Document by File
*
* Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*
* @deprecated
*/
export const post22 = oc
.route({
deprecated: true,
description:
'Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile',
path: '/datasets/{dataset_id}/documents/{document_id}/update-by-file',
summary: 'Update Document by File',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileBody.optional(),
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFilePath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFileResponse)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
too_many_files: { status: 400, data: zTooManyFilesError },
unsupported_file_type: { status: 415, data: zUnsupportedFileTypeError },
})
/**
* Update Document by File
*
* Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*
* @deprecated
*/
export const post23 = oc
.route({
deprecated: true,
description:
'Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile',
path: '/datasets/{dataset_id}/documents/{document_id}/update_by_file',
summary: 'Update Document by File',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Body.optional(),
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Path,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByFile2Response)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
too_many_files: { status: 400, data: zTooManyFilesError },
unsupported_file_type: { status: 415, data: zUnsupportedFileTypeError },
})
export const updateByFile = {
post: post23,
}
/**
* Update Document by Text
*
* Update an existing document's text content, name, or processing configuration. Re-triggers indexing if content changes — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*/
export const post24 = oc
.route({
description:
"Update an existing document's text content, name, or processing configuration. Re-triggers indexing if content changes — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.",
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText',
path: '/datasets/{dataset_id}/documents/{document_id}/update-by-text',
summary: 'Update Document by Text',
tags: ['Documents'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextBody,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextPath,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByTextResponse)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
/**
* Update document by text through the deprecated underscore alias
*
* Deprecated legacy alias for updating an existing document by providing text content. Use /datasets/{dataset_id}/documents/{document_id}/update-by-text instead.
*
* @deprecated
*/
export const post25 = oc
.route({
deprecated: true,
description:
'Deprecated legacy alias for updating an existing document by providing text content. Use /datasets/{dataset_id}/documents/{document_id}/update-by-text instead.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText',
path: '/datasets/{dataset_id}/documents/{document_id}/update_by_text',
summary: 'Update document by text through the deprecated underscore alias',
tags: ['service_api'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Body,
params: zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Path,
}),
)
.output(zPostDatasetsByDatasetIdDocumentsByDocumentIdUpdateByText2Response)
.errors({ provider_not_initialize: { status: 400, data: zProviderNotInitializeError } })
export const updateByText = {
post: post25,
}
/**
* Delete Document
*
* Permanently delete a document and all its chunks from the knowledge base.
*/
export const delete6 = oc
.route({
description: 'Permanently delete a document and all its chunks from the knowledge base.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdDocumentsByDocumentId',
path: '/datasets/{dataset_id}/documents/{document_id}',
successStatus: 204,
summary: 'Delete Document',
tags: ['Documents'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdDocumentsByDocumentIdPath }))
.output(zDeleteDatasetsByDatasetIdDocumentsByDocumentIdResponse)
.errors({ archived_document_immutable: { status: 403, data: zArchivedDocumentImmutableError } })
/**
* Get Document
*
* Retrieve detailed information about a specific document, including its indexing status, metadata, and processing statistics.
*/
export const get13 = oc
.route({
description:
'Retrieve detailed information about a specific document, including its indexing status, metadata, and processing statistics.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocumentsByDocumentId',
path: '/datasets/{dataset_id}/documents/{document_id}',
summary: 'Get Document',
tags: ['Documents'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsByDocumentIdPath,
query: zGetDatasetsByDatasetIdDocumentsByDocumentIdQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsByDocumentIdResponse)
.errors({ invalid_metadata: { status: 400, data: zInvalidMetadataError } })
/**
* Update Document by File
*
* Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.
*/
export const patch4 = oc
.route({
description:
'Update an existing document by uploading a new file. Re-triggers indexing — use the returned `batch` ID with [Get Document Indexing Status](/api-reference/documents/get-document-indexing-status) to track progress.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdDocumentsByDocumentId',
path: '/datasets/{dataset_id}/documents/{document_id}',
summary: 'Update Document by File',
tags: ['Documents'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdDocumentsByDocumentIdBody.optional(),
params: zPatchDatasetsByDatasetIdDocumentsByDocumentIdPath,
}),
)
.output(zPatchDatasetsByDatasetIdDocumentsByDocumentIdResponse)
.errors({
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
too_many_files: { status: 400, data: zTooManyFilesError },
unsupported_file_type: { status: 415, data: zUnsupportedFileTypeError },
})
export const byDocumentId = {
delete: delete6,
get: get13,
patch: patch4,
download,
segments,
updateByFile,
updateByText,
}
/**
* List Documents
*
* Returns a paginated list of documents in the knowledge base. Supports filtering by keyword and indexing status.
*/
export const get14 = oc
.route({
description:
'Returns a paginated list of documents in the knowledge base. Supports filtering by keyword and indexing status.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdDocuments',
path: '/datasets/{dataset_id}/documents',
summary: 'List Documents',
tags: ['Documents'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdDocumentsPath,
query: zGetDatasetsByDatasetIdDocumentsQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdDocumentsResponse)
export const documents = {
get: get14,
downloadZip,
metadata,
status: status2,
byBatch,
byDocumentId,
}
/**
* Retrieve Chunks from a Knowledge Base / Test Retrieval
*
* Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.
*
* @deprecated
*/
export const post26 = oc
.route({
deprecated: true,
description:
'Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdHitTesting',
path: '/datasets/{dataset_id}/hit-testing',
summary: 'Retrieve Chunks from a Knowledge Base / Test Retrieval',
tags: ['Knowledge Bases'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdHitTestingBody,
params: zPostDatasetsByDatasetIdHitTestingPath,
}),
)
.output(zPostDatasetsByDatasetIdHitTestingResponse)
.errors({
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
})
export const hitTesting = {
post: post26,
}
/**
* Update Built-in Metadata Field
*
* Enable or disable built-in metadata fields for the knowledge base.
*/
export const post27 = oc
.route({
description: 'Enable or disable built-in metadata fields for the knowledge base.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdMetadataBuiltInByAction',
path: '/datasets/{dataset_id}/metadata/built-in/{action}',
summary: 'Update Built-in Metadata Field',
tags: ['Metadata'],
})
.input(z.object({ params: zPostDatasetsByDatasetIdMetadataBuiltInByActionPath }))
.output(zPostDatasetsByDatasetIdMetadataBuiltInByActionResponse)
export const byAction3 = {
post: post27,
}
/**
* Get Built-in Metadata Fields
*
* Returns the list of built-in metadata fields provided by the system (e.g., document type, source URL).
*/
export const get15 = oc
.route({
description:
'Returns the list of built-in metadata fields provided by the system (e.g., document type, source URL).',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdMetadataBuiltIn',
path: '/datasets/{dataset_id}/metadata/built-in',
summary: 'Get Built-in Metadata Fields',
tags: ['Metadata'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdMetadataBuiltInPath }))
.output(zGetDatasetsByDatasetIdMetadataBuiltInResponse)
export const builtIn = {
get: get15,
byAction: byAction3,
}
/**
* Delete Metadata Field
*
* Permanently delete a custom metadata field. Documents using this field will lose their metadata values for it.
*/
export const delete7 = oc
.route({
description:
'Permanently delete a custom metadata field. Documents using this field will lose their metadata values for it.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetIdMetadataByMetadataId',
path: '/datasets/{dataset_id}/metadata/{metadata_id}',
successStatus: 204,
summary: 'Delete Metadata Field',
tags: ['Metadata'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdMetadataByMetadataIdPath }))
.output(zDeleteDatasetsByDatasetIdMetadataByMetadataIdResponse)
/**
* Update Metadata Field
*
* Rename a custom metadata field.
*/
export const patch5 = oc
.route({
description: 'Rename a custom metadata field.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetIdMetadataByMetadataId',
path: '/datasets/{dataset_id}/metadata/{metadata_id}',
summary: 'Update Metadata Field',
tags: ['Metadata'],
})
.input(
z.object({
body: zPatchDatasetsByDatasetIdMetadataByMetadataIdBody,
params: zPatchDatasetsByDatasetIdMetadataByMetadataIdPath,
}),
)
.output(zPatchDatasetsByDatasetIdMetadataByMetadataIdResponse)
export const byMetadataId = {
delete: delete7,
patch: patch5,
}
/**
* List Metadata Fields
*
* Returns the list of all metadata fields (both custom and built-in) for the knowledge base, along with the count of documents using each field.
*/
export const get16 = oc
.route({
description:
'Returns the list of all metadata fields (both custom and built-in) for the knowledge base, along with the count of documents using each field.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdMetadata',
path: '/datasets/{dataset_id}/metadata',
summary: 'List Metadata Fields',
tags: ['Metadata'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdMetadataPath }))
.output(zGetDatasetsByDatasetIdMetadataResponse)
/**
* Create Metadata Field
*
* Create a custom metadata field for the knowledge base. Metadata fields can be used to annotate documents with structured information.
*/
export const post28 = oc
.route({
description:
'Create a custom metadata field for the knowledge base. Metadata fields can be used to annotate documents with structured information.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdMetadata',
path: '/datasets/{dataset_id}/metadata',
successStatus: 201,
summary: 'Create Metadata Field',
tags: ['Metadata'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdMetadataBody,
params: zPostDatasetsByDatasetIdMetadataPath,
}),
)
.output(zPostDatasetsByDatasetIdMetadataResponse)
export const metadata2 = {
get: get16,
post: post28,
builtIn,
byMetadataId,
}
/**
* List Datasource Plugins
*
* List the datasource nodes configured in the knowledge pipeline. Each node includes the plugin it uses plus the metadata needed to run it.
*/
export const get17 = oc
.route({
description:
'List the datasource nodes configured in the knowledge pipeline. Each node includes the plugin it uses plus the metadata needed to run it.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdPipelineDatasourcePlugins',
path: '/datasets/{dataset_id}/pipeline/datasource-plugins',
summary: 'List Datasource Plugins',
tags: ['Knowledge Pipeline'],
})
.input(
z.object({
params: zGetDatasetsByDatasetIdPipelineDatasourcePluginsPath,
query: zGetDatasetsByDatasetIdPipelineDatasourcePluginsQuery.optional(),
}),
)
.output(zGetDatasetsByDatasetIdPipelineDatasourcePluginsResponse)
export const datasourcePlugins = {
get: get17,
}
/**
* Run Datasource Node
*
* Execute a single datasource node within the knowledge pipeline. Returns a streaming response with the node execution results.
*/
export const post29 = oc
.route({
description:
'Execute a single datasource node within the knowledge pipeline. Returns a streaming response with the node execution results.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRun',
path: '/datasets/{dataset_id}/pipeline/datasource/nodes/{node_id}/run',
summary: 'Run Datasource Node',
tags: ['Knowledge Pipeline'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunBody,
params: zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunPath,
}),
)
.output(zPostDatasetsByDatasetIdPipelineDatasourceNodesByNodeIdRunResponse)
export const run = {
post: post29,
}
export const byNodeId = {
run,
}
export const nodes = {
byNodeId,
}
export const datasource = {
nodes,
}
/**
* Run Pipeline
*
* Execute the full knowledge pipeline for a knowledge base. Published runs are queued and return batch metadata as JSON. Draft runs support blocking JSON and streaming Server-Sent Events.
*/
export const post30 = oc
.route({
description:
'Execute the full knowledge pipeline for a knowledge base. Published runs are queued and return batch metadata as JSON. Draft runs support blocking JSON and streaming Server-Sent Events.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdPipelineRun',
path: '/datasets/{dataset_id}/pipeline/run',
summary: 'Run Pipeline',
tags: ['Knowledge Pipeline'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdPipelineRunBody,
params: zPostDatasetsByDatasetIdPipelineRunPath,
}),
)
.output(zPostDatasetsByDatasetIdPipelineRunResponse)
.errors({ pipeline_run_error: { status: 500, data: zPipelineRunError } })
export const run2 = {
post: post30,
}
export const pipeline2 = {
datasourcePlugins,
datasource,
run: run2,
}
/**
* Retrieve Chunks from a Knowledge Base / Test Retrieval
*
* Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.
*/
export const post31 = oc
.route({
description:
'Performs a search query against a knowledge base to retrieve the most relevant chunks. This endpoint can be used for both production retrieval and test retrieval.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasetsByDatasetIdRetrieve',
path: '/datasets/{dataset_id}/retrieve',
summary: 'Retrieve Chunks from a Knowledge Base / Test Retrieval',
tags: ['Knowledge Bases'],
})
.input(
z.object({
body: zPostDatasetsByDatasetIdRetrieveBody,
params: zPostDatasetsByDatasetIdRetrievePath,
}),
)
.output(zPostDatasetsByDatasetIdRetrieveResponse)
.errors({
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
})
export const retrieve = {
post: post31,
}
/**
* Get Knowledge Base Tags
*
* Returns the list of tags bound to a specific knowledge base.
*/
export const get18 = oc
.route({
description: 'Returns the list of tags bound to a specific knowledge base.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetIdTags',
path: '/datasets/{dataset_id}/tags',
summary: 'Get Knowledge Base Tags',
tags: ['Tags'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdTagsPath }))
.output(zGetDatasetsByDatasetIdTagsResponse)
export const tags2 = {
get: get18,
}
/**
* Delete Knowledge Base
*
* Permanently delete a knowledge base and all its documents.
*/
export const delete8 = oc
.route({
description: 'Permanently delete a knowledge base and all its documents.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
successStatus: 204,
summary: 'Delete Knowledge Base',
tags: ['Knowledge Bases'],
})
.input(z.object({ params: zDeleteDatasetsByDatasetIdPath }))
.output(zDeleteDatasetsByDatasetIdResponse)
/**
* Get Knowledge Base
*
* Retrieve detailed information about a specific knowledge base, including its embedding model, retrieval configuration, and document statistics.
*/
export const get19 = oc
.route({
description:
'Retrieve detailed information about a specific knowledge base, including its embedding model, retrieval configuration, and document statistics.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
summary: 'Get Knowledge Base',
tags: ['Knowledge Bases'],
})
.input(z.object({ params: zGetDatasetsByDatasetIdPath }))
.output(zGetDatasetsByDatasetIdResponse)
/**
* Update Knowledge Base
*
* Update the name, description, permissions, or retrieval settings of an existing knowledge base. Only the fields provided in the request body are updated.
*/
export const patch6 = oc
.route({
description:
'Update the name, description, permissions, or retrieval settings of an existing knowledge base. Only the fields provided in the request body are updated.',
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchDatasetsByDatasetId',
path: '/datasets/{dataset_id}',
summary: 'Update Knowledge Base',
tags: ['Knowledge Bases'],
})
.input(z.object({ body: zPatchDatasetsByDatasetIdBody, params: zPatchDatasetsByDatasetIdPath }))
.output(zPatchDatasetsByDatasetIdResponse)
export const byDatasetId = {
delete: delete8,
get: get19,
patch: patch6,
document: document_,
documents,
hitTesting,
metadata: metadata2,
pipeline: pipeline2,
retrieve,
tags: tags2,
}
/**
* List Knowledge Bases
*
* Returns a paginated list of knowledge bases. Supports filtering by keyword and tags.
*/
export const get20 = oc
.route({
description:
'Returns a paginated list of knowledge bases. Supports filtering by keyword and tags.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getDatasets',
path: '/datasets',
summary: 'List Knowledge Bases',
tags: ['Knowledge Bases'],
})
.input(z.object({ query: zGetDatasetsQuery.optional() }).optional())
.output(zGetDatasetsResponse)
/**
* Create an Empty Knowledge Base
*
* Create a new empty knowledge base. After creation, use [Create Document by Text](/api-reference/documents/create-document-by-text) or [Create Document by File](/api-reference/documents/create-document-by-file) to add documents.
*/
export const post32 = oc
.route({
description:
'Create a new empty knowledge base. After creation, use [Create Document by Text](/api-reference/documents/create-document-by-text) or [Create Document by File](/api-reference/documents/create-document-by-file) to add documents.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postDatasets',
path: '/datasets',
summary: 'Create an Empty Knowledge Base',
tags: ['Knowledge Bases'],
})
.input(z.object({ body: zPostDatasetsBody }))
.output(zPostDatasetsResponse)
.errors({ dataset_name_duplicate: { status: 409, data: zDatasetNameDuplicateError } })
export const datasets = {
get: get20,
post: post32,
pipeline,
tags,
byDatasetId,
}
/**
* Get End User Info
*
* Retrieve an end user by ID. Useful when other APIs return an end-user ID (e.g., `created_by` from [Upload File](/api-reference/files/upload-file)).
*/
export const get21 = oc
.route({
description:
'Retrieve an end user by ID. Useful when other APIs return an end-user ID (e.g., `created_by` from [Upload File](/api-reference/files/upload-file)).',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getEndUsersByEndUserId',
path: '/end-users/{end_user_id}',
summary: 'Get End User Info',
tags: ['End Users'],
})
.input(z.object({ params: zGetEndUsersByEndUserIdPath }))
.output(zGetEndUsersByEndUserIdResponse)
.errors({ end_user_not_found: { status: 404, data: zEndUserNotFoundError } })
export const byEndUserId = {
get: get21,
}
export const endUsers = {
byEndUserId,
}
/**
* Upload File
*
* Upload a file for use when sending messages, enabling multimodal understanding of images, documents, audio, and video. Uploaded files are for use by the current end-user only.
*/
export const post33 = oc
.route({
description:
'Upload a file for use when sending messages, enabling multimodal understanding of images, documents, audio, and video. Uploaded files are for use by the current end-user only.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postFilesUpload',
path: '/files/upload',
successStatus: 201,
summary: 'Upload File',
tags: ['Files'],
})
.input(z.object({ body: zPostFilesUploadBody }))
.output(zPostFilesUploadResponse)
.errors({
file_extension_blocked: { status: 400, data: zFileExtensionBlockedError },
file_too_large: { status: 413, data: zFileTooLargeError },
filename_not_exists_error: { status: 400, data: zFilenameNotExistsError },
no_file_uploaded: { status: 400, data: zNoFileUploadedError },
too_many_files: { status: 400, data: zTooManyFilesError },
unsupported_file_type: { status: 415, data: zUnsupportedFileTypeError },
})
export const upload = {
post: post33,
}
/**
* Download File
*
* Preview or download uploaded files previously uploaded via the [Upload File](/api-reference/files/upload-file) API. Files can only be accessed if they belong to messages within the requesting application.
*/
export const get22 = oc
.route({
description:
'Preview or download uploaded files previously uploaded via the [Upload File](/api-reference/files/upload-file) API. Files can only be accessed if they belong to messages within the requesting application.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFilesByFileIdPreview',
path: '/files/{file_id}/preview',
summary: 'Download File',
tags: ['Files'],
})
.input(
z.object({
params: zGetFilesByFileIdPreviewPath,
query: zGetFilesByFileIdPreviewQuery.optional(),
}),
)
.output(zGetFilesByFileIdPreviewResponse)
.errors({
file_access_denied: { status: 403, data: zFileAccessDeniedError },
file_not_found: { status: 404, data: zFileNotFoundError },
})
export const preview = {
get: get22,
}
export const byFileId = {
preview,
}
export const files = {
upload,
byFileId,
}
/**
* Get Human Input Form
*
* Retrieve a paused Human Input form's contents using the `form_token` from a `human_input_required` event. Requires **WebApp** delivery.
*/
export const get23 = oc
.route({
description:
"Retrieve a paused Human Input form's contents using the `form_token` from a `human_input_required` event. Requires **WebApp** delivery.",
inputStructure: 'detailed',
method: 'GET',
operationId: 'getFormHumanInputByFormToken',
path: '/form/human_input/{form_token}',
summary: 'Get Human Input Form',
tags: ['Human Input'],
})
.input(z.object({ params: zGetFormHumanInputByFormTokenPath }))
.output(zGetFormHumanInputByFormTokenResponse)
.errors({
human_input_form_expired: { status: 412, data: zHumanInputFormExpiredError },
human_input_form_submitted: { status: 412, data: zHumanInputFormSubmittedError },
})
/**
* Submit Human Input Form
*
* Submit the recipient's response to a paused Human Input form. The workflow resumes on acceptance; use [Stream Workflow Events](/api-reference/chatflows/stream-workflow-events) to follow subsequent events. Requires **WebApp** delivery.
*/
export const post34 = oc
.route({
description:
"Submit the recipient's response to a paused Human Input form. The workflow resumes on acceptance; use [Stream Workflow Events](/api-reference/chatflows/stream-workflow-events) to follow subsequent events. Requires **WebApp** delivery.",
inputStructure: 'detailed',
method: 'POST',
operationId: 'postFormHumanInputByFormToken',
path: '/form/human_input/{form_token}',
summary: 'Submit Human Input Form',
tags: ['Human Input'],
})
.input(
z.object({
body: zPostFormHumanInputByFormTokenBody,
params: zPostFormHumanInputByFormTokenPath,
}),
)
.output(zPostFormHumanInputByFormTokenResponse)
.errors({
human_input_form_expired: { status: 412, data: zHumanInputFormExpiredError },
human_input_form_submitted: { status: 412, data: zHumanInputFormSubmittedError },
invalid_form_data: { status: 400, data: zInvalidFormDataError },
})
export const byFormToken = {
get: get23,
post: post34,
}
export const humanInput = {
byFormToken,
}
export const form = {
humanInput,
}
/**
* Get App Info
*
* Retrieve basic information about this application, including name, description, tags, and mode.
*/
export const get24 = oc
.route({
description:
'Retrieve basic information about this application, including name, description, tags, and mode.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getInfo',
path: '/info',
summary: 'Get App Info',
tags: ['Applications'],
})
.output(zGetInfoResponse)
.errors({ app_unavailable: { status: 400, data: zAppUnavailableError } })
export const info = {
get: get24,
}
export const post35 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsQueryStream',
path: '/knowledge-fs/query-stream',
tags: ['service_api'],
})
.input(z.object({ body: zPostKnowledgeFsQueryStreamBody }))
.output(zPostKnowledgeFsQueryStreamResponse)
.errors({
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const queryStream = {
post: post35,
}
export const get25 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdBackgroundTasks',
path: '/knowledge-fs/spaces/{control_space_id}/background-tasks',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdBackgroundTasksResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const backgroundTasks = {
get: get25,
}
export const get26 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdBulkJobsByJobId',
path: '/knowledge-fs/spaces/{control_space_id}/bulk-jobs/{job_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdBulkJobsByJobIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdBulkJobsByJobIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byJobId2 = {
get: get26,
}
export const bulkJobs = {
byJobId: byJobId2,
}
export const get27 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDeletionBatchesByBatchId',
path: '/knowledge-fs/spaces/{control_space_id}/deletion-batches/{batch_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdDeletionBatchesByBatchIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdDeletionBatchesByBatchIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byBatchId = {
get: get27,
}
export const deletionBatches = {
byBatchId,
}
export const post36 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetry',
path: '/knowledge-fs/spaces/{control_space_id}/deletion-jobs/{job_id}/retry',
tags: ['service_api'],
})
.input(
z.object({
headers: zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdRetryResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const retry = {
post: post36,
}
export const get28 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobId',
path: '/knowledge-fs/spaces/{control_space_id}/deletion-jobs/{job_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdDeletionJobsByJobIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byJobId3 = {
get: get28,
retry,
}
export const deletionJobs = {
byJobId: byJobId3,
}
export const get29 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolve',
path: '/knowledge-fs/spaces/{control_space_id}/document-references/resolve',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolvePath,
query: zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolveQuery,
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdDocumentReferencesResolveResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const resolve = {
get: get29,
}
export const documentReferences = {
resolve,
}
export const delete9 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulk',
path: '/knowledge-fs/spaces/{control_space_id}/documents/bulk',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkBody,
headers: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkHeaders,
params: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkPath,
}),
)
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsBulkResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const bulk = {
delete: delete9,
}
export const post37 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdDocumentsReindex',
path: '/knowledge-fs/spaces/{control_space_id}/documents/reindex',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexHeaders.optional(),
params: zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdDocumentsReindexResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_too_large: { status: 413, data: zKnowledgeFsRequestTooLargeError },
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const reindex = {
post: post37,
}
export const get30 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdOutline',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}/outline',
tags: ['service_api'],
})
.input(
z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdOutlinePath }),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdOutlineResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const outline = {
get: get30,
}
export const get31 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId:
'getKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksByChunkId',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}',
tags: ['service_api'],
})
.input(
z.object({
params:
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksByChunkIdPath,
}),
)
.output(
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksByChunkIdResponse,
)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byChunkId = {
get: get31,
}
export const get32 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId:
'getKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunks',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions/{revision}/chunks',
tags: ['service_api'],
})
.input(
z.object({
params:
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksPath,
query:
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksQuery.optional(),
}),
)
.output(
zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsByRevisionChunksResponse,
)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const chunks = {
get: get32,
byChunkId,
}
export const byRevision = {
chunks,
}
export const get33 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisions',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}/revisions',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdRevisionsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const revisions = {
get: get33,
byRevision,
}
export const delete10 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentId',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdBody,
headers: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdHeaders,
params: zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath,
}),
)
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const get34 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentId',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const patch7 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentId',
path: '/knowledge-fs/spaces/{control_space_id}/documents/{document_id}',
tags: ['service_api'],
})
.input(
z.object({
body: zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdBody,
params: zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdPath,
}),
)
.output(zPatchKnowledgeFsSpacesByControlSpaceIdDocumentsByDocumentIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byDocumentId2 = {
delete: delete10,
get: get34,
patch: patch7,
outline,
revisions,
}
export const get35 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdDocuments',
path: '/knowledge-fs/spaces/{control_space_id}/documents',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdDocumentsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdDocumentsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const documents2 = {
get: get35,
bulk,
reindex,
byDocumentId: byDocumentId2,
}
export const post38 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdJobsByJobIdRetry',
path: '/knowledge-fs/spaces/{control_space_id}/jobs/{job_id}/retry',
tags: ['service_api'],
})
.input(z.object({ params: zPostKnowledgeFsSpacesByControlSpaceIdJobsByJobIdRetryPath }))
.output(zPostKnowledgeFsSpacesByControlSpaceIdJobsByJobIdRetryResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const retry2 = {
post: post38,
}
export const delete11 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdJobsByJobId',
path: '/knowledge-fs/spaces/{control_space_id}/jobs/{job_id}',
tags: ['service_api'],
})
.input(z.object({ params: zDeleteKnowledgeFsSpacesByControlSpaceIdJobsByJobIdPath }))
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdJobsByJobIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const get36 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdJobsByJobId',
path: '/knowledge-fs/spaces/{control_space_id}/jobs/{job_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdJobsByJobIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdJobsByJobIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byJobId4 = {
delete: delete11,
get: get36,
retry: retry2,
}
export const jobs = {
byJobId: byJobId4,
}
export const get37 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId:
'getKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksByTaskId',
path: '/knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}/processing-tasks/{task_id}',
tags: ['service_api'],
})
.input(
z.object({
params:
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksByTaskIdPath,
}),
)
.output(
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksByTaskIdResponse,
)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byTaskId3 = {
get: get37,
}
export const get38 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasks',
path: '/knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}/processing-tasks',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksPath,
query:
zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdProcessingTasksResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const processingTasks = {
get: get38,
byTaskId: byTaskId3,
}
/**
* Delete a logical document and its historical revisions. Use the logical document ID and its rowVersion as expectedRevision; the accepted deletion job runs asynchronously.
*/
export const delete12 = oc
.route({
description:
'Delete a logical document and its historical revisions. Use the logical document ID and its rowVersion as expectedRevision; the accepted deletion job runs asynchronously.',
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentId',
path: '/knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdBody,
headers: zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdHeaders,
params: zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdPath,
}),
)
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const get39 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentId',
path: '/knowledge-fs/spaces/{control_space_id}/logical-documents/{document_id}',
tags: ['service_api'],
})
.input(
z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdPath }),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsByDocumentIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byDocumentId3 = {
delete: delete12,
get: get39,
processingTasks,
}
export const get40 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdLogicalDocuments',
path: '/knowledge-fs/spaces/{control_space_id}/logical-documents',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdLogicalDocumentsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const logicalDocuments = {
get: get40,
byDocumentId: byDocumentId3,
}
export const post39 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdQueriesAdmission',
path: '/knowledge-fs/spaces/{control_space_id}/queries/admission',
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdQueriesAdmissionResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_rejected: { status: 422, data: zKnowledgeFsRequestRejectedError },
knowledge_fs_request_too_large: { status: 413, data: zKnowledgeFsRequestTooLargeError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const admission = {
post: post39,
}
export const queries = {
admission,
}
export const post40 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdQueryImages',
path: '/knowledge-fs/spaces/{control_space_id}/query-images',
successStatus: 201,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdQueryImagesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_rejected: { status: 422, data: zKnowledgeFsRequestRejectedError },
knowledge_fs_request_too_large: { status: 413, data: zKnowledgeFsRequestTooLargeError },
})
export const queryImages = {
post: post40,
}
export const post41 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdResearchTasksPlan',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks/plan',
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPlanResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_rejected: { status: 422, data: zKnowledgeFsRequestRejectedError },
knowledge_fs_request_too_large: { status: 413, data: zKnowledgeFsRequestTooLargeError },
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const plan = {
post: post41,
}
export const get41 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartials',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}/partials',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPartialsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const partials = {
get: get41,
}
export const post42 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResume',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}/resume',
tags: ['service_api'],
})
.input(
z.object({ params: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResumePath }),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResumeResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const resume = {
post: post42,
}
export const delete13 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskId',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}',
tags: ['service_api'],
})
.input(z.object({ params: zDeleteKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPath }))
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const get42 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskId',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks/{task_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksByTaskIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byTaskId4 = {
delete: delete13,
get: get42,
partials,
resume,
}
export const get43 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdResearchTasks',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdResearchTasksResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const post43 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdResearchTasks',
path: '/knowledge-fs/spaces/{control_space_id}/research-tasks',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksHeaders.optional(),
params: zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdResearchTasksResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_rejected: { status: 422, data: zKnowledgeFsRequestRejectedError },
knowledge_fs_request_too_large: { status: 413, data: zKnowledgeFsRequestTooLargeError },
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const researchTasks = {
get: get43,
post: post43,
plan,
byTaskId: byTaskId4,
}
export const get44 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSettingsMigrationsByMigrationId',
path: '/knowledge-fs/spaces/{control_space_id}/settings/migrations/{migration_id}',
tags: ['service_api'],
})
.input(
z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSettingsMigrationsByMigrationIdPath }),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSettingsMigrationsByMigrationIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byMigrationId = {
get: get44,
}
export const migrations = {
byMigrationId,
}
export const get45 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSettings',
path: '/knowledge-fs/spaces/{control_space_id}/settings',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSettingsPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdSettingsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const patch8 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchKnowledgeFsSpacesByControlSpaceIdSettings',
path: '/knowledge-fs/spaces/{control_space_id}/settings',
tags: ['service_api'],
})
.input(
z.object({
body: zPatchKnowledgeFsSpacesByControlSpaceIdSettingsBody,
params: zPatchKnowledgeFsSpacesByControlSpaceIdSettingsPath,
}),
)
.output(zPatchKnowledgeFsSpacesByControlSpaceIdSettingsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_request_rejected: { status: 422, data: zKnowledgeFsRequestRejectedError },
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const settings = {
get: get45,
patch: patch8,
migrations,
}
export const post44 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefresh',
path: '/knowledge-fs/spaces/{control_space_id}/source-connections/{connection_id}/refresh',
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsByConnectionIdRefreshResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const refresh = {
post: post44,
}
export const byConnectionId = {
refresh,
}
export const get46 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourceConnections',
path: '/knowledge-fs/spaces/{control_space_id}/source-connections',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourceConnectionsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const post45 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourceConnections',
path: '/knowledge-fs/spaces/{control_space_id}/source-connections',
successStatus: 201,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourceConnectionsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const sourceConnections = {
get: get46,
post: post45,
byConnectionId,
}
export const get47 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourceProviders',
path: '/knowledge-fs/spaces/{control_space_id}/source-providers',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSourceProvidersPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourceProvidersResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const sourceProviders = {
get: get47,
}
export const post46 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancel',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/cancel',
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdCancelResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const cancel = {
post: post46,
}
export const get48 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPages',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/pages',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPagesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const pages = {
get: get48,
}
export const post47 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdRetry',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/retry',
tags: ['service_api'],
})
.input(
z.object({ params: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdRetryPath }),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdRetryResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const retry3 = {
post: post47,
}
export const post48 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelection',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}/selection',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdSelectionResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const selection = {
post: post48,
}
export const get49 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunId',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows/{run_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsByRunIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byRunId = {
get: get49,
cancel,
pages,
retry: retry3,
selection,
}
export const get50 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourceWorkflows',
path: '/knowledge-fs/spaces/{control_space_id}/source-workflows',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourceWorkflowsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const sourceWorkflows = {
get: get50,
byRunId,
}
/**
* @deprecated
*/
export const post49 = oc
.route({
deprecated: true,
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawl',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const crawl = {
post: post49,
}
export const post50 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImport',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-import',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlImportResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const crawlImport = {
post: post50,
}
export const post51 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreview',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/crawl-preview',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdCrawlPreviewResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const crawlPreview = {
post: post51,
}
export const get51 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFiles',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/files',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdFilesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const files2 = {
get: get51,
}
/**
* @deprecated
*/
export const post52 = oc
.route({
deprecated: true,
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImport',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const import_ = {
post: post52,
}
/**
* @deprecated
*/
export const post53 = oc
.route({
deprecated: true,
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFiles',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/import-files',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdImportFilesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const importFiles = {
post: post53,
}
export const get52 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPages',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/pages',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPagesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const pages2 = {
get: get52,
}
export const post54 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSync',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const sync = {
post: post54,
}
export const get53 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicy',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const put3 = oc
.route({
inputStructure: 'detailed',
method: 'PUT',
operationId: 'putKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicy',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/sync-policy',
tags: ['service_api'],
})
.input(
z.object({
body: zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyBody,
params: zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyPath,
}),
)
.output(zPutKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdSyncPolicyResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const syncPolicy = {
get: get53,
put: put3,
}
export const post55 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdTest',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/test',
tags: ['service_api'],
})
.input(z.object({ params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdTestPath }))
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdTestResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const test = {
post: post55,
}
export const post56 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImports',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}/workflow-imports',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsBody,
headers: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsHeaders,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdWorkflowImportsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const workflowImports = {
post: post56,
}
export const delete14 = oc
.route({
inputStructure: 'detailed',
method: 'DELETE',
operationId: 'deleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceId',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}',
successStatus: 202,
tags: ['service_api'],
})
.input(
z.object({
body: zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdBody,
headers: zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdHeaders,
params: zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath,
query: zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdQuery.optional(),
}),
)
.output(zDeleteKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const get54 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSourcesBySourceId',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const patch9 = oc
.route({
inputStructure: 'detailed',
method: 'PATCH',
operationId: 'patchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceId',
path: '/knowledge-fs/spaces/{control_space_id}/sources/{source_id}',
tags: ['service_api'],
})
.input(
z.object({
body: zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdBody,
params: zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdPath,
}),
)
.output(zPatchKnowledgeFsSpacesByControlSpaceIdSourcesBySourceIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const bySourceId = {
delete: delete14,
get: get54,
patch: patch9,
crawl,
crawlImport,
crawlPreview,
files: files2,
import: import_,
importFiles,
pages: pages2,
sync,
syncPolicy,
test,
workflowImports,
}
export const get55 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdSources',
path: '/knowledge-fs/spaces/{control_space_id}/sources',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdSourcesPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdSourcesQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdSourcesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const post57 = oc
.route({
inputStructure: 'detailed',
method: 'POST',
operationId: 'postKnowledgeFsSpacesByControlSpaceIdSources',
path: '/knowledge-fs/spaces/{control_space_id}/sources',
successStatus: 201,
tags: ['service_api'],
})
.input(
z.object({
body: zPostKnowledgeFsSpacesByControlSpaceIdSourcesBody,
params: zPostKnowledgeFsSpacesByControlSpaceIdSourcesPath,
}),
)
.output(zPostKnowledgeFsSpacesByControlSpaceIdSourcesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_rate_limit_exceeded: { status: 429, data: zKnowledgeFsRateLimitExceededError },
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const sources = {
get: get55,
post: post57,
bySourceId,
}
export const get56 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflicts',
path: '/knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/conflicts',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdConflictsResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const conflicts = {
get: get56,
}
export const get57 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidence',
path: '/knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/evidence',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidencePath,
query: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidenceQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdEvidenceResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const evidence = {
get: get57,
}
export const get58 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissing',
path: '/knowledge-fs/spaces/{control_space_id}/traces/{trace_id}/missing',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdMissingResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const missing = {
get: get58,
}
export const get59 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdTracesByTraceId',
path: '/knowledge-fs/spaces/{control_space_id}/traces/{trace_id}',
tags: ['service_api'],
})
.input(z.object({ params: zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdPath }))
.output(zGetKnowledgeFsSpacesByControlSpaceIdTracesByTraceIdResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const byTraceId = {
get: get59,
conflicts,
evidence,
missing,
}
export const get60 = oc
.route({
inputStructure: 'detailed',
method: 'GET',
operationId: 'getKnowledgeFsSpacesByControlSpaceIdTraces',
path: '/knowledge-fs/spaces/{control_space_id}/traces',
tags: ['service_api'],
})
.input(
z.object({
params: zGetKnowledgeFsSpacesByControlSpaceIdTracesPath,
query: zGetKnowledgeFsSpacesByControlSpaceIdTracesQuery.optional(),
}),
)
.output(zGetKnowledgeFsSpacesByControlSpaceIdTracesResponse)
.errors({
knowledge_fs_access_denied: { status: 403, data: zKnowledgeFsAccessDeniedError },
knowledge_fs_conflict: { status: 409, data: zKnowledgeFsConflictError },
knowledge_fs_invalid_credential: { status: 401, data: zKnowledgeFsInvalidCredentialError },
knowledge_fs_invalid_request: { status: 400, data: zKnowledgeFsInvalidRequestError },
knowledge_fs_operation_unavailable: {
status: 503,
data: zKnowledgeFsOperationUnavailableError,
},
knowledge_fs_resource_not_found: { status: 404, data: zKnowledgeFsResourceNotFoundError },
knowledge_fs_upstream_unavailable: { status: 502, data: zKnowledgeFsUpstreamUnavailableError },
})
export const traces = {
get: get60,
byTraceId,
}
export const byControlSpaceId = {
backgroundTasks,
bulkJobs,
deletionBatches,
deletionJobs,
documentReferences,
documents: documents2,
jobs,
logicalDocuments,
queries,
queryImages,
researchTasks,
settings,
sourceConnections,
sourceProviders,
sourceWorkflows,
sources,
traces,
}
export const spaces = {
byControlSpaceId,
}
export const knowledgeFs = {
queryStream,
spaces,
}
/**
* Submit Message Feedback
*
* Submit feedback for a message. End users can rate messages as `like` or `dislike`, and optionally provide text feedback. Pass `null` for `rating` to revoke previously submitted feedback.
*/
export const post58 = oc
.route({
description:
'Submit feedback for a message. End users can rate messages as `like` or `dislike`, and optionally provide text feedback. Pass `null` for `rating` to revoke previously submitted feedback.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postMessagesByMessageIdFeedbacks',
path: '/messages/{message_id}/feedbacks',
summary: 'Submit Message Feedback',
tags: ['Feedback'],
})
.input(
z.object({
body: zPostMessagesByMessageIdFeedbacksBody,
params: zPostMessagesByMessageIdFeedbacksPath,
}),
)
.output(zPostMessagesByMessageIdFeedbacksResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
app_unavailable: { status: 400, data: zAppUnavailableError },
forbidden: { status: 403, data: zForbiddenError },
message_feedback_rating_required: { status: 400, data: zMessageFeedbackRatingRequiredError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const feedbacks2 = {
post: post58,
}
/**
* Get Next Suggested Questions
*
* Get next question suggestions for the current message. If no usable model can be resolved or the model call to generate questions fails, the response is HTTP 200 with an empty data list. Model invocation failures during history token counting instead return HTTP 400 with `completion_request_error`.
*/
export const get61 = oc
.route({
description:
'Get next question suggestions for the current message. If no usable model can be resolved or the model call to generate questions fails, the response is HTTP 200 with an empty data list. Model invocation failures during history token counting instead return HTTP 400 with `completion_request_error`.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMessagesByMessageIdSuggested',
path: '/messages/{message_id}/suggested',
summary: 'Get Next Suggested Questions',
tags: ['Chatflows', 'Chats'],
})
.input(
z.object({
params: zGetMessagesByMessageIdSuggestedPath,
query: zGetMessagesByMessageIdSuggestedQuery,
}),
)
.output(zGetMessagesByMessageIdSuggestedResponse)
.errors({
agent_version_not_found_error: { status: 404, data: zAgentVersionNotFoundError },
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
app_suggested_questions_after_answer_disabled: {
status: 403,
data: zAppSuggestedQuestionsAfterAnswerDisabledError,
},
app_unavailable: { status: 400, data: zAppUnavailableError },
completion_request_error: { status: 400, data: zCompletionRequestError },
forbidden: { status: 403, data: zForbiddenError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
not_chat_app: { status: 400, data: zNotChatAppError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const suggested = {
get: get61,
}
export const byMessageId = {
feedbacks: feedbacks2,
suggested,
}
/**
* List Conversation Messages
*
* Returns historical chat records in a scrolling load format, with the first page returning the latest `limit` messages, i.e., in reverse order.
*/
export const get62 = oc
.route({
description:
'Returns historical chat records in a scrolling load format, with the first page returning the latest `limit` messages, i.e., in reverse order.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMessages',
path: '/messages',
summary: 'List Conversation Messages',
tags: ['Conversations'],
})
.input(z.object({ query: zGetMessagesQuery }))
.output(zGetMessagesResponse)
.errors({
app_abnormal_status: { status: 403, data: zAppAbnormalStatusError },
app_api_disabled: { status: 403, data: zAppApiDisabledError },
app_not_found: { status: 403, data: zAppNotFoundError },
app_unavailable: { status: 400, data: zAppUnavailableError },
forbidden: { status: 403, data: zForbiddenError },
not_chat_app: { status: 400, data: zNotChatAppError },
workspace_archived: { status: 403, data: zWorkspaceArchivedError },
workspace_not_found: { status: 403, data: zWorkspaceNotFoundError },
})
export const messages = {
get: get62,
byMessageId,
}
/**
* Get App Meta
*
* Retrieve metadata about this application, including tool icons and other configuration details.
*/
export const get63 = oc
.route({
description:
'Retrieve metadata about this application, including tool icons and other configuration details.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getMeta',
path: '/meta',
summary: 'Get App Meta',
tags: ['Applications'],
})
.output(zGetMetaResponse)
.errors({ app_unavailable: { status: 400, data: zAppUnavailableError } })
export const meta = {
get: get63,
}
/**
* Get App Parameters
*
* Retrieve the application's input form configuration, including feature switches, input parameter names, types, and default values.
*/
export const get64 = oc
.route({
description:
"Retrieve the application's input form configuration, including feature switches, input parameter names, types, and default values.",
inputStructure: 'detailed',
method: 'GET',
operationId: 'getParameters',
path: '/parameters',
summary: 'Get App Parameters',
tags: ['Applications'],
})
.output(zGetParametersResponse)
.errors({
agent_not_published: { status: 400, data: zAgentNotPublishedError },
app_unavailable: { status: 400, data: zAppUnavailableError },
})
export const parameters = {
get: get64,
}
/**
* Get App WebApp Settings
*
* Retrieve the WebApp settings of this application, including site configuration, theme, and customization options.
*/
export const get65 = oc
.route({
description:
'Retrieve the WebApp settings of this application, including site configuration, theme, and customization options.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getSite',
path: '/site',
summary: 'Get App WebApp Settings',
tags: ['Applications'],
})
.output(zGetSiteResponse)
export const site = {
get: get65,
}
/**
* Convert Text to Audio
*
* Convert text to speech.
*/
export const post59 = oc
.route({
description: 'Convert text to speech.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postTextToAudio',
path: '/text-to-audio',
summary: 'Convert Text to Audio',
tags: ['TTS'],
})
.input(z.object({ body: zPostTextToAudioBody }))
.output(zPostTextToAudioResponse)
.errors({
app_unavailable: { status: 400, data: zAppUnavailableError },
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
})
export const textToAudio = {
post: post59,
}
/**
* Stream Workflow Events
*
* Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection. For runs that have already finished, the stream emits a single `workflow_finished` event and closes.
*/
export const get66 = oc
.route({
description:
'Resume the Server-Sent Events stream for a workflow run after a pause or a dropped SSE connection. For runs that have already finished, the stream emits a single `workflow_finished` event and closes.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkflowByWorkflowRunIdEvents',
path: '/workflow/{workflow_run_id}/events',
summary: 'Stream Workflow Events',
tags: ['Chatflows', 'Workflows'],
})
.input(
z.object({
params: zGetWorkflowByWorkflowRunIdEventsPath,
query: zGetWorkflowByWorkflowRunIdEventsQuery,
}),
)
.output(zGetWorkflowByWorkflowRunIdEventsResponse)
.errors({ not_workflow_app: { status: 400, data: zNotWorkflowAppError } })
export const events = {
get: get66,
}
export const byWorkflowRunId = {
events,
}
export const workflow = {
byWorkflowRunId,
}
/**
* List Workflow Logs
*
* Retrieve paginated workflow execution logs with filtering options.
*/
export const get67 = oc
.route({
description: 'Retrieve paginated workflow execution logs with filtering options.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkflowsLogs',
path: '/workflows/logs',
summary: 'List Workflow Logs',
tags: ['Chatflows', 'Workflows'],
})
.input(z.object({ query: zGetWorkflowsLogsQuery.optional() }).optional())
.output(zGetWorkflowsLogsResponse)
export const logs = {
get: get67,
}
/**
* Get Workflow Run Detail
*
* Retrieve the current execution results of a workflow task based on the workflow execution ID.
*/
export const get68 = oc
.route({
description:
'Retrieve the current execution results of a workflow task based on the workflow execution ID.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkflowsRunByWorkflowRunId',
path: '/workflows/run/{workflow_run_id}',
summary: 'Get Workflow Run Detail',
tags: ['Chatflows', 'Workflows'],
})
.input(z.object({ params: zGetWorkflowsRunByWorkflowRunIdPath }))
.output(zGetWorkflowsRunByWorkflowRunIdResponse)
.errors({ not_workflow_app: { status: 400, data: zNotWorkflowAppError } })
export const byWorkflowRunId2 = {
get: get68,
}
/**
* Run Workflow
*
* Execute a workflow. Cannot be executed without a published workflow.
*/
export const post60 = oc
.route({
description: 'Execute a workflow. Cannot be executed without a published workflow.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWorkflowsRun',
path: '/workflows/run',
summary: 'Run Workflow',
tags: ['Workflows'],
})
.input(z.object({ body: zPostWorkflowsRunBody }))
.output(zPostWorkflowsRunResponse)
.errors({
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
not_workflow_app: { status: 400, data: zNotWorkflowAppError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
rate_limit_error: { status: 429, data: zRateLimitError },
trigger_workflow_service_mode_unavailable: {
status: 403,
data: zTriggerWorkflowServiceModeUnavailableError,
},
})
export const run3 = {
post: post60,
byWorkflowRunId: byWorkflowRunId2,
}
/**
* Stop Workflow Task
*
* Stop a running workflow task. Only supported in `streaming` mode.
*/
export const post61 = oc
.route({
description: 'Stop a running workflow task. Only supported in `streaming` mode.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWorkflowsTasksByTaskIdStop',
path: '/workflows/tasks/{task_id}/stop',
summary: 'Stop Workflow Task',
tags: ['Workflows'],
})
.input(
z.object({
body: zPostWorkflowsTasksByTaskIdStopBody,
params: zPostWorkflowsTasksByTaskIdStopPath,
}),
)
.output(zPostWorkflowsTasksByTaskIdStopResponse)
.errors({ not_workflow_app: { status: 400, data: zNotWorkflowAppError } })
export const stop3 = {
post: post61,
}
export const byTaskId5 = {
stop: stop3,
}
export const tasks = {
byTaskId: byTaskId5,
}
/**
* Run Workflow by ID
*
* Execute a specific workflow version identified by its ID. Useful for running a particular published version of the workflow.
*/
export const post62 = oc
.route({
description:
'Execute a specific workflow version identified by its ID. Useful for running a particular published version of the workflow.',
inputStructure: 'detailed',
method: 'POST',
operationId: 'postWorkflowsByWorkflowIdRun',
path: '/workflows/{workflow_id}/run',
summary: 'Run Workflow by ID',
tags: ['Workflows'],
})
.input(
z.object({
body: zPostWorkflowsByWorkflowIdRunBody,
params: zPostWorkflowsByWorkflowIdRunPath,
}),
)
.output(zPostWorkflowsByWorkflowIdRunResponse)
.errors({
completion_request_error: { status: 400, data: zCompletionRequestError },
model_currently_not_support: { status: 400, data: zModelCurrentlyNotSupportError },
not_workflow_app: { status: 400, data: zNotWorkflowAppError },
provider_not_initialize: { status: 400, data: zProviderNotInitializeError },
provider_quota_exceeded: { status: 400, data: zProviderQuotaExceededError },
rate_limit_error: { status: 429, data: zRateLimitError },
trigger_workflow_service_mode_unavailable: {
status: 403,
data: zTriggerWorkflowServiceModeUnavailableError,
},
workflow_version_execution_not_allowed: {
status: 403,
data: zWorkflowVersionExecutionNotAllowedError,
},
})
export const run4 = {
post: post62,
}
export const byWorkflowId = {
run: run4,
}
export const workflows = {
logs,
run: run3,
tasks,
byWorkflowId,
}
/**
* Get Available Models
*
* Retrieve the list of available models by type. Primarily used to query `text-embedding` and `rerank` models for knowledge base configuration.
*/
export const get69 = oc
.route({
description:
'Retrieve the list of available models by type. Primarily used to query `text-embedding` and `rerank` models for knowledge base configuration.',
inputStructure: 'detailed',
method: 'GET',
operationId: 'getWorkspacesCurrentModelsModelTypesByModelType',
path: '/workspaces/current/models/model-types/{model_type}',
summary: 'Get Available Models',
tags: ['Models'],
})
.input(z.object({ params: zGetWorkspacesCurrentModelsModelTypesByModelTypePath }))
.output(zGetWorkspacesCurrentModelsModelTypesByModelTypeResponse)
export const byModelType = {
get: get69,
}
export const modelTypes = {
byModelType,
}
export const models = {
modelTypes,
}
export const current = {
models,
}
export const workspaces = {
current,
}
export const contract = {
root,
app,
apps,
audioToText,
chatMessages,
completionMessages,
conversations,
datasets,
endUsers,
files,
form,
info,
knowledgeFs,
messages,
meta,
parameters,
site,
textToAudio,
workflow,
workflows,
workspaces,
}