Примеры
Практические примеры и случаи использования для SmartRAG
Базовые примеры
Простые примеры для начала работы с SmartRAG.
Загрузка и поиск документов
[ApiController]
[Route("api/[controller]")]
public class DocumentController : ControllerBase
{
private readonly IDocumentService _documentService;
private readonly ILogger<DocumentController> _logger;
public DocumentController(IDocumentService documentService, ILogger<DocumentController> logger)
{
_documentService = documentService;
_logger = logger;
}
[HttpPost("upload")]
public async Task<ActionResult<Document>> UploadDocument(IFormFile file)
{
try
{
if (file == null || file.Length == 0)
return BadRequest("Файл не выбран");
var document = await _documentService.UploadDocumentAsync(file);
_logger.LogInformation("Документ {FileName} успешно загружен", file.FileName);
return Ok(document);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при загрузке документа");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
[HttpGet("search")]
public async Task<ActionResult<IEnumerable<DocumentChunk>>> SearchDocuments(
[FromQuery] string query,
[FromQuery] int maxResults = 10)
{
try
{
if (string.IsNullOrWhiteSpace(query))
return BadRequest("Поисковый запрос не может быть пустым");
var results = await _documentService.SearchDocumentsAsync(query, maxResults);
_logger.LogInformation("Поиск по '{Query}' дал {Count} результатов", query, results.Count());
return Ok(results);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при поиске документов");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
}
Генерация RAG ответа
[HttpPost("ask")]
public async Task<ActionResult<RagResponse>> AskQuestion([FromBody] AskQuestionRequest request)
{
try
{
if (string.IsNullOrWhiteSpace(request.Question))
return BadRequest("Вопрос не может быть пустым");
var response = await _documentService.GenerateRagAnswerAsync(request.Question, request.MaxResults ?? 5);
_logger.LogInformation("RAG ответ на вопрос '{Question}' сгенерирован", request.Question);
return Ok(response);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при генерации RAG ответа");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
public class AskQuestionRequest
{
public string Question { get; set; }
public int? MaxResults { get; set; }
}
Расширенные примеры
Более сложные случаи использования и расширенные функции.
Пакетная обработка документов
[HttpPost("upload-batch")]
public async Task<ActionResult<BatchUploadResult>> UploadBatchDocuments(IFormFileCollection files)
{
try
{
var results = new List<Document>();
var errors = new List<string>();
foreach (var file in files)
{
try
{
var document = await _documentService.UploadDocumentAsync(file);
results.Add(document);
_logger.LogInformation("Документ {FileName} успешно обработан", file.FileName);
}
catch (Exception ex)
{
var error = $"Ошибка при обработке {file.FileName}: {ex.Message}";
errors.Add(error);
_logger.LogWarning(ex, "Ошибка при обработке {FileName}", file.FileName);
}
}
return Ok(new BatchUploadResult
{
SuccessfulUploads = results,
Errors = errors,
TotalFiles = files.Count,
SuccessCount = results.Count,
ErrorCount = errors.Count
});
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при пакетной обработке");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
public class BatchUploadResult
{
public List<Document> SuccessfulUploads { get; set; }
public List<string> Errors { get; set; }
public int TotalFiles { get; set; }
public int SuccessCount { get; set; }
public int ErrorCount { get; set; }
}
Расширенный поиск с фильтрами
[HttpPost("advanced-search")]
public async Task<ActionResult<AdvancedSearchResult>> AdvancedSearch([FromBody] AdvancedSearchRequest request)
{
try
{
var searchResults = await _documentService.SearchDocumentsAsync(request.Query, request.MaxResults);
// Применение дополнительных фильтров
var filteredResults = searchResults
.Where(r => request.MinSimilarityScore == null || r.SimilarityScore >= request.MinSimilarityScore)
.Where(r => request.ContentTypes == null || !request.ContentTypes.Any() ||
request.ContentTypes.Contains(r.Document.ContentType))
.OrderByDescending(r => r.SimilarityScore)
.ToList();
var result = new AdvancedSearchResult
{
Query = request.Query,
Results = filteredResults,
TotalResults = filteredResults.Count,
SearchTime = DateTime.UtcNow,
AppliedFilters = new
{
MinSimilarityScore = request.MinSimilarityScore,
ContentTypes = request.ContentTypes
}
};
_logger.LogInformation("Расширенный поиск по '{Query}' дал {Count} отфильтрованных результатов",
request.Query, filteredResults.Count);
return Ok(result);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при расширенном поиске");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
public class AdvancedSearchRequest
{
public string Query { get; set; }
public int MaxResults { get; set; } = 10;
public float? MinSimilarityScore { get; set; }
public List<string> ContentTypes { get; set; }
}
public class AdvancedSearchResult
{
public string Query { get; set; }
public List<DocumentChunk> Results { get; set; }
public int TotalResults { get; set; }
public DateTime SearchTime { get; set; }
public object AppliedFilters { get; set; }
}
Примеры Web API
Полные Web API контроллеры со всеми функциями SmartRAG.
Полный Document Controller
[ApiController]
[Route("api/[controller]")]
[Produces("application/json")]
public class DocumentController : ControllerBase
{
private readonly IDocumentService _documentService;
private readonly ILogger<DocumentController> _logger;
public DocumentController(IDocumentService documentService, ILogger<DocumentController> logger)
{
_documentService = documentService;
_logger = logger;
}
///
/// Загружает документ
///
[HttpPost("upload")]
[ProducesResponseType(typeof(Document), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(500)]
public async Task<ActionResult<Document>> UploadDocument(IFormFile file)
{
// Реализация см. выше
}
///
/// Получает документ по ID
///
[HttpGet("{id}")]
[ProducesResponseType(typeof(Document), 200)]
[ProducesResponseType(404)]
public async Task<ActionResult<Document>> GetDocument(string id)
{
try
{
var document = await _documentService.GetDocumentByIdAsync(id);
if (document == null)
return NotFound($"Документ с ID {id} не найден");
return Ok(document);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при получении документа {Id}", id);
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
///
/// Получает все документы
///
[HttpGet]
[ProducesResponseType(typeof(IEnumerable<Document>), 200)]
public async Task<ActionResult<IEnumerable<Document>>> GetAllDocuments()
{
try
{
var documents = await _documentService.GetAllDocumentsAsync();
return Ok(documents);
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при получении всех документов");
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
///
/// Удаляет документ
///
[HttpDelete("{id}")]
[ProducesResponseType(200)]
[ProducesResponseType(404)]
public async Task<ActionResult> DeleteDocument(string id)
{
try
{
var success = await _documentService.DeleteDocumentAsync(id);
if (!success)
return NotFound($"Документ с ID {id} не найден");
_logger.LogInformation("Документ {Id} успешно удален", id);
return Ok();
}
catch (Exception ex)
{
_logger.LogError(ex, "Ошибка при удалении документа {Id}", id);
return StatusCode(500, "Внутренняя ошибка сервера");
}
}
///
/// Ищет в документах
///
[HttpGet("search")]
[ProducesResponseType(typeof(IEnumerable<DocumentChunk>), 200)]
public async Task<ActionResult<IEnumerable<DocumentChunk>>> SearchDocuments(
[FromQuery] string query,
[FromQuery] int maxResults = 10)
{
// Реализация см. выше
}
///
/// Генерирует RAG ответ
///
[HttpPost("ask")]
[ProducesResponseType(typeof(RagResponse), 200)]
public async Task<ActionResult<RagResponse>> AskQuestion([FromBody] AskQuestionRequest request)
{
// Реализация см. выше
}
}
Пример консольного приложения
Простое консольное приложение с интеграцией SmartRAG.
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using SmartRAG.Interfaces;
namespace SmartRAG.ConsoleApp
{
class Program
{
static async Task Main(string[] args)
{
var host = CreateHostBuilder(args).Build();
using var scope = host.Services.CreateScope();
var documentService = scope.ServiceProvider.GetRequiredService<IDocumentService>();
var logger = scope.ServiceProvider.GetRequiredService<ILogger<Program>>();
logger.LogInformation("Консольное приложение SmartRAG запущено");
while (true)
{
Console.WriteLine("\n=== Консольное приложение SmartRAG ===");
Console.WriteLine("1. Загрузить документ");
Console.WriteLine("2. Поиск документов");
Console.WriteLine("3. Задать вопрос");
Console.WriteLine("4. Выход");
Console.Write("Выберите опцию (1-4): ");
var choice = Console.ReadLine();
try
{
switch (choice)
{
case "1":
await UploadDocument(documentService, logger);
break;
case "2":
await SearchDocuments(documentService, logger);
break;
case "3":
await AskQuestion(documentService, logger);
break;
case "4":
logger.LogInformation("Приложение завершается");
return;
default:
Console.WriteLine("Неверная опция. Пожалуйста, выберите 1-4.");
break;
}
}
catch (Exception ex)
{
logger.LogError(ex, "Ошибка при выполнении");
Console.WriteLine($"Ошибка: {ex.Message}");
}
}
}
static async Task UploadDocument(IDocumentService documentService, ILogger logger)
{
Console.Write("Введите путь к файлу: ");
var filePath = Console.ReadLine();
if (!File.Exists(filePath))
{
Console.WriteLine("Файл не найден!");
return;
}
var fileInfo = new FileInfo(filePath);
var fileBytes = await File.ReadAllBytesAsync(filePath);
var fileStream = new MemoryStream(fileBytes);
var formFile = new FormFile(fileStream, 0, fileBytes.Length, "file", fileInfo.Name);
var document = await documentService.UploadDocumentAsync(formFile);
Console.WriteLine($"Документ успешно загружен: {document.Id}");
}
static async Task SearchDocuments(IDocumentService documentService, ILogger logger)
{
Console.Write("Введите поисковый запрос: ");
var query = Console.ReadLine();
var results = await documentService.SearchDocumentsAsync(query, 5);
Console.WriteLine($"\nНайденные результаты ({results.Count()}):");
foreach (var result in results)
{
Console.WriteLine($"- {result.Document.FileName} (Сходство: {result.SimilarityScore:P2})");
Console.WriteLine($" {result.Content.Substring(0, Math.Min(100, result.Content.Length))}...");
}
}
static async Task AskQuestion(IDocumentService documentService, ILogger logger)
{
Console.Write("Задайте ваш вопрос: ");
var question = Console.ReadLine();
var response = await documentService.GenerateRagAnswerAsync(question, 5);
Console.WriteLine($"\nОтвет: {response.Answer}");
Console.WriteLine($"\nИсточники ({response.Sources.Count}):");
foreach (var source in response.Sources)
{
Console.WriteLine($"- {source.DocumentName} (Сходство: {source.SimilarityScore:P2})");
}
}
static IHostBuilder CreateHostBuilder(string[] args) =>
Host.CreateDefaultBuilder(args)
.ConfigureServices((context, services) =>
{
services.AddSmartRAG(context.Configuration, options =>
{
options.AIProvider = AIProvider.Anthropic;
options.StorageProvider = StorageProvider.Qdrant;
});
});
}
}
Нужна помощь?
Для дополнительных примеров и поддержки: