@vfarcic/dot-ai
Version:
AI-powered development productivity platform that enhances software development workflows through intelligent automation and AI-driven assistance
201 lines • 6.67 kB
TypeScript
/**
* Knowledge Base REST API Response Schemas
*
* PRD #356: Knowledge Base System
* Schemas for HTTP-only endpoints (not exposed via MCP)
*/
import { z } from 'zod';
/**
* Delete by source response data
*/
export declare const DeleteBySourceDataSchema: z.ZodObject<{
sourceIdentifier: z.ZodString;
chunksDeleted: z.ZodNumber;
}, z.core.$strip>;
export type DeleteBySourceData = z.infer<typeof DeleteBySourceDataSchema>;
/**
* Delete by source success response
*/
export declare const DeleteBySourceResponseSchema: z.ZodObject<{
success: z.ZodLiteral<true>;
data: z.ZodObject<{
sourceIdentifier: z.ZodString;
chunksDeleted: z.ZodNumber;
}, z.core.$strip>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>;
export type DeleteBySourceResponse = z.infer<typeof DeleteBySourceResponseSchema>;
/**
* Delete by source error responses
*/
export declare const DeleteBySourceBadRequestErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"BAD_REQUEST">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const DeleteBySourcePluginUnavailableErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"PLUGIN_UNAVAILABLE">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const DeleteBySourceErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"DELETE_SOURCE_ERROR">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
/**
* Knowledge Ask request body
*/
export declare const KnowledgeAskRequestSchema: z.ZodObject<{
query: z.ZodString;
limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
uriFilter: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type KnowledgeAskRequest = z.infer<typeof KnowledgeAskRequestSchema>;
/**
* Source reference in knowledge ask response
*/
export declare const KnowledgeAskSourceSchema: z.ZodObject<{
uri: z.ZodString;
title: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type KnowledgeAskSource = z.infer<typeof KnowledgeAskSourceSchema>;
/**
* Chunk in knowledge ask response
*/
export declare const KnowledgeAskChunkSchema: z.ZodObject<{
content: z.ZodString;
uri: z.ZodString;
score: z.ZodNumber;
chunkIndex: z.ZodNumber;
}, z.core.$strip>;
export type KnowledgeAskChunk = z.infer<typeof KnowledgeAskChunkSchema>;
/**
* Knowledge Ask response data
*/
export declare const KnowledgeAskDataSchema: z.ZodObject<{
answer: z.ZodString;
sources: z.ZodArray<z.ZodObject<{
uri: z.ZodString;
title: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
chunks: z.ZodArray<z.ZodObject<{
content: z.ZodString;
uri: z.ZodString;
score: z.ZodNumber;
chunkIndex: z.ZodNumber;
}, z.core.$strip>>;
}, z.core.$strip>;
export type KnowledgeAskData = z.infer<typeof KnowledgeAskDataSchema>;
/**
* Knowledge Ask success response
*/
export declare const KnowledgeAskResponseSchema: z.ZodObject<{
success: z.ZodLiteral<true>;
data: z.ZodObject<{
answer: z.ZodString;
sources: z.ZodArray<z.ZodObject<{
uri: z.ZodString;
title: z.ZodOptional<z.ZodString>;
}, z.core.$strip>>;
chunks: z.ZodArray<z.ZodObject<{
content: z.ZodString;
uri: z.ZodString;
score: z.ZodNumber;
chunkIndex: z.ZodNumber;
}, z.core.$strip>>;
}, z.core.$strip>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
}, z.core.$strip>;
export type KnowledgeAskResponse = z.infer<typeof KnowledgeAskResponseSchema>;
/**
* Knowledge Ask error responses
*/
export declare const KnowledgeAskBadRequestErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"BAD_REQUEST">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const KnowledgeAskAIUnavailableErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"AI_UNAVAILABLE">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const KnowledgeAskPluginUnavailableErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodLiteral<"PLUGIN_UNAVAILABLE">;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
export declare const KnowledgeAskErrorSchema: z.ZodObject<{
success: z.ZodLiteral<false>;
meta: z.ZodOptional<z.ZodObject<{
timestamp: z.ZodString;
requestId: z.ZodOptional<z.ZodString>;
version: z.ZodString;
}, z.core.$strip>>;
error: z.ZodObject<{
code: z.ZodEnum<{
SEARCH_ERROR: "SEARCH_ERROR";
SYNTHESIS_ERROR: "SYNTHESIS_ERROR";
}>;
message: z.ZodString;
details: z.ZodOptional<z.ZodUnknown>;
}, z.core.$strip>;
}, z.core.$strip>;
//# sourceMappingURL=knowledge.d.ts.map