Add beta Documentation

This commit is contained in:
2026-05-22 09:04:42 +02:00
parent 37bec89484
commit 29bd42e52e
255 changed files with 704332 additions and 0 deletions
@@ -0,0 +1 @@
{"path":"NexusReader.Application/DTOs/AI/GroundedResponseDto.cs","purpose":"Defines simple DTOs used to return a grounded AI response (answer plus provenance/citations) from application services.","classification":{"role":"dto","layer":"application","confidence":0.9,"evidence":["DTO/view-model naming pattern","Namespace NexusReader.Application.DTOs.AI","File only contains plain data-holder classes (GroundedResponseDto, CitationDto) with auto-properties"]},"className":"GroundedResponseDto","methods":[],"types":[{"name":"GroundedResponseDto","kind":"dto","line":5,"purpose":"Carries an AI-generated answer and a list of provenance citations back to callers.","fields":[{"name":"Answer","type":"string","required":true,"line":7,"description":"The generated answer text"},{"name":"Citations","type":"List<CitationDto>","required":true,"line":8,"description":"List of contextual citations supporting the answer"}]},{"name":"CitationDto","kind":"dto","line":11,"purpose":"Represents a single provenance item (chunk id, snippet, and source) used to justify the answer.","fields":[{"name":"CitationId","type":"string","required":true,"line":13,"description":"Identifier for the cited chunk (e.g., chunk hash/ID)"},{"name":"Snippet","type":"string","required":true,"line":14,"description":"Verified text snippet extracted from context"},{"name":"SourceBook","type":"string","required":true,"line":15,"description":"Book title or human-readable source description"}]}],"serviceRegistrations":[],"startupActions":[],"dependencies":[],"patterns":["DTO"],"domainConcepts":["GroundedResponse","Citation","AI/Knowledge","Answering","Provenance"],"keyDetails":"Small, self-contained DTOs with default non-null initializers (string.Empty, new List) intended for safe transport over app/service boundaries.","orchestrationMethods":[],"typedContracts":[{"name":"GroundedResponseDto","kind":"dto","line":5,"fieldCount":2,"evidencePaths":["NexusReader.Application/DTOs/AI/GroundedResponseDto.cs"]},{"name":"CitationDto","kind":"dto","line":11,"fieldCount":3,"evidencePaths":["NexusReader.Application/DTOs/AI/GroundedResponseDto.cs"]}],"persistenceInteractions":[],"externalInteractions":[],"evidenceAnchors":[{"kind":"typed-contract","label":"GroundedResponseDto","line":5,"summary":"dto with 2 fields.","confidence":0.8,"evidencePaths":["NexusReader.Application/DTOs/AI/GroundedResponseDto.cs"]},{"kind":"typed-contract","label":"CitationDto","line":11,"summary":"dto with 3 fields.","confidence":0.8,"evidencePaths":["NexusReader.Application/DTOs/AI/GroundedResponseDto.cs"]}]}