ainsoft-rag-spring-boot-autoconfigure/com.ainsoft.rag.spring/RagAdminApiController

RagAdminApiController

@RestController

@RequestMapping(value = ["${rag.admin.api-base-path:/api/rag/admin}"])

class RagAdminApiController(engine: RagEngine, properties: RagProperties, ragConfig: RagConfig, embeddingProvider: EmbeddingProvider, adminService: RagAdminService, securityService: RagAdminSecurityService)

Constructors

constructor(engine: RagEngine, properties: RagProperties, ragConfig: RagConfig, embeddingProvider: EmbeddingProvider, adminService: RagAdminService, securityService: RagAdminSecurityService)

Functions

accessSecurity

@GetMapping(value = ["/access-security"])

fun accessSecurity(requestContext: HttpServletRequest): RagAdminAccessSecurityResponse

bulkDelete

@PostMapping(value = ["/bulk/delete"])

fun bulkDelete(requestContext: HttpServletRequest, @RequestBody request: RagAdminBulkDeleteRequest): RagAdminBulkOperationResponse

bulkMetadataPatch

@PostMapping(value = ["/bulk/metadata-patch"])

fun bulkMetadataPatch(requestContext: HttpServletRequest, @RequestBody request: RagAdminBulkMetadataPatchRequest): RagAdminBulkOperationResponse

bulkTextIngest

@PostMapping(value = ["/bulk/text-ingest"])

fun bulkTextIngest(requestContext: HttpServletRequest, @RequestBody request: RagAdminBulkTextIngestRequest): RagAdminBulkOperationResponse

config

@GetMapping(value = ["/config"])

fun config(requestContext: HttpServletRequest): RagAdminConfigInspectorResponse

deleteDocument

@DeleteMapping(value = ["/documents/{tenantId}/{docId}"])

fun deleteDocument(requestContext: HttpServletRequest, @PathVariable tenantId: String, @PathVariable docId: String): RagAdminOperationResponse

deleteTenant

@DeleteMapping(value = ["/tenants/{tenantId}"])

fun deleteTenant(requestContext: HttpServletRequest, @PathVariable tenantId: String): RagAdminOperationResponse

diagnoseSearch

@PostMapping(value = ["/diagnose-search"])

fun diagnoseSearch(requestContext: HttpServletRequest, @RequestBody request: RagAdminSearchRequest): RagAdminSearchDiagnosticsResponse

documentDetail

@GetMapping(value = ["/documents/{tenantId}/{docId}"])

fun documentDetail(requestContext: HttpServletRequest, @PathVariable tenantId: String, @PathVariable docId: String): RagAdminDocumentDetail

documents

@GetMapping(value = ["/documents"])

fun documents(requestContext: HttpServletRequest, @RequestParam(required = false) tenantId: String?, @RequestParam(required = false) query: String?, @RequestParam(required = false, defaultValue = "100") limit: Int): RagAdminDocumentListResponse

ingest

@PostMapping(value = ["/ingest"])

fun ingest(requestContext: HttpServletRequest, @RequestBody request: RagAdminIngestRequest): RagAdminIngestResponse

ingestFile

@PostMapping(value = ["/ingest-file"], consumes = ["multipart/form-data"])

fun ingestFile(requestContext: HttpServletRequest, @RequestParam tenantId: String, @RequestParam docId: String, @RequestParam acl: List<String>, @RequestParam file: MultipartFile, @RequestParam(required = false) sourceUri: String?, @RequestParam(required = false) page: Int?, @RequestParam(required = false, defaultValue = "UTF-8") charset: String, @RequestParam(required = false) metadata: String?): RagAdminIngestResponse

jobHistory

@GetMapping(value = ["/job-history"])

fun jobHistory(requestContext: HttpServletRequest, @RequestParam(required = false, defaultValue = "100") limit: Int): List<RagAdminJobHistoryEntry>

optimize

@PostMapping(value = ["/operations/optimize"])

fun optimize(requestContext: HttpServletRequest): RagAdminOperationResponse

providerHealth

@GetMapping(value = ["/provider-health"])

fun providerHealth(requestContext: HttpServletRequest, @RequestParam(required = false) recentProviderWindowMillis: Long?, @RequestParam(required = false, defaultValue = "true") detailed: Boolean): RagAdminProviderHealthResponse

providerHistory

@GetMapping(value = ["/provider-history"])

fun providerHistory(requestContext: HttpServletRequest, @RequestParam(required = false, defaultValue = "120") limit: Int): RagAdminProviderHistoryResponse

rebuildMetadata

@PostMapping(value = ["/operations/rebuild-metadata"])

fun rebuildMetadata(requestContext: HttpServletRequest, @RequestParam(required = false) tenantId: String?): RagAdminOperationResponse

reindexDocument

@PostMapping(value = ["/documents/{tenantId}/{docId}/reindex"])

fun reindexDocument(requestContext: HttpServletRequest, @PathVariable tenantId: String, @PathVariable docId: String, @RequestBody(required = false) request: RagAdminDocumentReindexRequest?): RagAdminOperationResponse

restore

@PostMapping(value = ["/operations/restore"])

fun restore(requestContext: HttpServletRequest, @RequestParam tag: String): RagAdminOperationResponse

retryJob

@PostMapping(value = ["/job-history/{jobId}/retry"])

fun retryJob(requestContext: HttpServletRequest, @PathVariable jobId: String): RagAdminOperationResponse

@PostMapping(value = ["/search"])

fun search(requestContext: HttpServletRequest, @RequestBody request: RagAdminSearchRequest): RagAdminSearchResponse

searchAudit

@GetMapping(value = ["/search-audit"])

fun searchAudit(requestContext: HttpServletRequest, @RequestParam(required = false, defaultValue = "100") limit: Int): List<RagAdminSearchAuditEntry>

snapshot

@PostMapping(value = ["/operations/snapshot"])

fun snapshot(requestContext: HttpServletRequest, @RequestParam tag: String): RagAdminOperationResponse

sourcePreview

@GetMapping(value = ["/documents/{tenantId}/{docId}/source-preview"])

fun sourcePreview(requestContext: HttpServletRequest, @PathVariable tenantId: String, @PathVariable docId: String, @RequestParam(required = false) chunkId: String?, @RequestParam(required = false, defaultValue = "160") contextChars: Int, @RequestParam(required = false, defaultValue = "UTF-8") charset: String, @RequestParam(required = false) profileName: String?): RagAdminSourcePreviewResponse

stats

@GetMapping(value = ["/stats"])

fun stats(requestContext: HttpServletRequest, @RequestParam tenantId: String?, @RequestParam(required = false) recentProviderWindowMillis: Long?): RagAdminStatsResponse

tenantDetail

@GetMapping(value = ["/tenants/{tenantId}"])

fun tenantDetail(requestContext: HttpServletRequest, @PathVariable tenantId: String): RagAdminTenantDetail

tenants

@GetMapping(value = ["/tenants"])

fun tenants(requestContext: HttpServletRequest): RagAdminTenantListResponse