41 Commits

Author SHA1 Message Date
Marco Minerva e4700a4e28 Update README with screenshots and .NET 10 prerequisite
Added screenshots for the Web App and Web API to README for better visualization of the application. Updated the .NET SDK prerequisite from version 9 to version 10. Fixed a minor formatting issue in the description of Semantic Kernel and EFCore.SqlServer.VectorSearch.
2025-11-19 16:13:11 +01:00
Marco Minerva 4242bcc0c7 Update README: .NET 10 badge
Updated the README.md to replace the .NET 9 badge with a .NET 10 badge, reflecting compatibility with the newer version.
2025-11-19 14:51:54 +01:00
Marco Minerva edae0c35b9 Update ModelId guidance for gpt-4.1 and gpt-5
Updated README.md to specify that for gpt-4.1 and gpt-5 models,
the ModelId should be set to gpt-4o for proper token counting.
Aligned appsettings.json comments with this guidance to ensure
consistency and clarity for users configuring Azure OpenAI settings.
2025-10-07 10:13:36 +02:00
Marco Minerva 8788a013e6 Update README with ModelId and VECTOR size guidelines
Enhanced documentation to clarify the configuration of `ModelId` values for `ChatCompletion` and `Embedding` in `appsettings.json`, ensuring compatibility with `Microsoft.ML.Tokenizers`. Added guidance on setting `Dimensions` for embedding models and provided instructions for updating `ApplicationDbContext` and migrations when modifying VECTOR size.
2025-10-06 11:54:06 +02:00
Marco Minerva 476a7734ef Update README.md to add Minimal API badge
Added a badge for "Minimal API" availability to the README.md file, enhancing the visibility of project features. Existing badges for .NET 9 and Blazor remain unchanged.
2025-06-24 12:57:37 +02:00
Marco Minerva 02861a27c5 Update README.md for clarity and organization
Enhanced the README.md file with the following changes:
- Added badges for .NET 9 and Blazor.
- Rephrased the application overview.
- Structured the Table of Contents for easier navigation.
- Reformatted setup instructions for better readability.
- Provided additional details for configuring the database and OpenAI settings.
- Expanded the supported features section.
- Included examples of API requests and responses.
- Clarified limitations and FAQ sections.
- Added a note about using straight SQL.
2025-06-24 12:55:28 +02:00
Marco Minerva 4e01ec81be Improve README.md for clarity and consistency
Updated the README.md file to enhance readability and grammatical structure. Key changes include improved phrasing, added missing commas, consistent formatting of section headers and bullet points, and correction of typographical errors. The description of the response streaming feature was also clarified to provide a better understanding of the application's functionality.
2025-06-24 12:25:42 +02:00
Marco Minerva 30fba5cfe0 Add citations feature and update streaming responses
- Updated README.md to include a new **Citations** feature, detailing how users can access source information.
- Modified JSON response examples to include a `citations` field and updated token usage details.
- Enhanced streaming response section to clarify the end of the stream includes citations.
- Adjusted `VectorSearchService.cs` to return `StreamState.End` and improved citation handling in streaming.
- Updated `appsettings.json` with new model IDs for Azure OpenAI configuration.
2025-06-24 12:16:48 +02:00
Marco Minerva 3197637019 Update README.md 2025-05-07 17:50:34 +02:00
Marco Minerva 42bfac1648 Update documentation for supported features
Enhanced descriptions in `README.md` for features:
**Conversation History with Question Reformulation**,
**Information about Token Usage**, and
**Response Streaming**.

Reformatted feature list in `Home.razor` to include bold headings
and detailed explanations for improved clarity.
2025-05-07 17:25:14 +02:00
Marco Minerva bfdb96368f Update README.md for embedding model requirements
Clarified the `Dimensions` property requirements for embedding models that support shortening. Added information about the maximum supported size for the `VECTOR` type (1998) and the need to update database migrations accordingly.
2025-04-07 10:04:40 +02:00
Marco Minerva e7eba25bc4 Refactor token usage structure in API responses
Updated token count keys from `inputTokenCount`, `outputTokenCount`, and `totalTokenCount` to `promptTokens`, `completionTokens`, and `totalTokens` for improved clarity. Modified `question` and `answer` fields to align with the new structure, with some values set to `null` to indicate streaming state.
2025-03-24 18:01:38 +01:00
Marco Minerva 261caffb6d Update README.md 2025-03-10 16:50:07 +01:00
Marco Minerva 3683d16955 Update README.md 2025-02-28 11:59:26 +01:00
Marco Minerva 86b8e611ea Documentation update 2025-02-28 11:52:36 +01:00
Marco Minerva 9071e130de Enhance documentation and refactor request handling
Updated README.md to clarify functionality and added a link to OpenAPI documentation in MainLayout.razor. Removed unnecessary methods from RequestExtensions.cs for simplification. Streamlined docs.md by removing detailed JSON response examples while retaining key information about response streaming.
2025-02-25 15:17:06 +01:00
Marco Minerva eb368470e8 Update README and image assets for SQL Database Vector Search
- Enhanced README.md with new sections and images for the web app and API.
- Clarified setup instructions and reorganized content.
- Removed SqlDatabaseVectorSearch.png; modified favicon.png and SqlDatabaseVectorSearch_API.png.
- Added new image file: SqlDatabaseVectorSearch_WebApp.png.
2025-02-25 14:56:46 +01:00
Marco Minerva 402bf1e570 Merge branch 'master' into ui 2025-02-20 10:42:51 +01:00
Marco Minerva a9028929eb Update README.md 2025-02-19 17:37:17 +01:00
Marco Minerva a0c777c138 Update README.md 2025-02-17 12:45:41 +01:00
Marco Minerva b155f8eb2e Update README.md 2025-02-17 12:40:06 +01:00
Marco Minerva 09f15a9cb7 Enhance application structure and functionality
- Updated README.md for clarity on application features.
- Added using directives and improved service configuration in Program.cs.
- Enhanced error handling and status code management in Program.cs.
- Changed application URL port in launchSettings.json.
- Added package references for Blazor Bootstrap and other libraries.
- Created new HTML structure in App.razor and implemented routing in Routes.razor.
- Updated MainLayout.razor for Blazor Bootstrap layout and sidebar navigation.
- Developed new components: Counter.razor, Documents.razor, Error.razor, Home.razor, and Weather.razor.
- Added utility classes: RequestExtensions.cs and StreamExtensions.cs.
- Updated app.css for custom styles and added favicon.png.
- Created functions.js for local time conversion utility.
2025-02-14 16:58:51 +01:00
Marco Minerva 5a507e972c Add Markdown support and refactor text chunking
Updated README.md to include Markdown file support.
Introduced new endpoint for uploading Markdown documents with MIME type handling.
Removed TextChunkerService and created DefaultTextChunker and MarkdownTextChunker classes implementing ITextChunker.
Updated VectorSearchService to utilize the new chunking interface.
Added MimeMapping package reference in the project file.
2025-02-14 12:06:52 +01:00
Marco Minerva d0fce6ffd2 Simplify /api/ask-streaming response and update README
The response format for the `/api/ask-streaming` endpoint has been simplified by removing multiple individual elements that contained parts of the answer.

The README.md file was updated to correct the terminology from "tag" to "property" for the *streamState* attribute.
2025-02-07 12:08:03 +01:00
Marco Minerva 9312bf35cb Add new endpoints and update README with details
Updated README.md to document new `/api/documents`, `/api/ask`, and `/api/ask-streaming` endpoints, including features like conversation history, token usage, and response streaming. Enhanced Program.cs by adding new endpoints for asking questions and streaming responses, with additional metadata. Updated `documentsApiGroup` to include new document management endpoints.
2025-02-07 12:02:48 +01:00
Marco Minerva af9158873f Add support for DOCX and TXT files, update error handling
Updated README.md to reflect support for PDF, DOCX, and TXT files.
Removed commented-out code in DocxContentDecoder.cs.
Added TextContentDecoder service in Program.cs and updated exception handling middleware.
Updated document upload endpoint description in Program.cs.
Modified VectorSearchService to throw NotSupportedException for unsupported content types.
Added TextContentDecoder class in TextContentDecoder.cs.
2025-01-29 09:58:22 +01:00
Marco Minerva b9bcb5c9fd Update README and refine prompt logic in ChatService
Updated README.md to include a note on Vector support in Azure SQL Database and corrected "Dimension" to "Dimensions". Modified ChatService.cs to append separator "---" only once at the end of the prompt.
2024-11-07 09:40:20 +01:00
Marco Minerva bb3e794a29 Update README: clarify EFCore usage and SQL note
The README.md file has been updated to specify that Vectors are saved and retrieved using the `EFCore.SqlServer.VectorSearch` library with Entity Framework Core. Additionally, the note about using straight SQL has been moved to a separate section and rephrased for better clarity.
2024-11-05 11:25:45 +01:00
Marco Minerva 7e8d1245b1 Update README.md with vector handling details
Added information on using EFCore.SqlServer.VectorSearch for vector management with Entity Framework Core. Included a link to the `sql` branch for users preferring direct SQL usage.
2024-10-31 15:22:44 +01:00
Marco Minerva a0f3679262 Update README.md 2024-10-01 17:57:25 +02:00
Marco Minerva 8c6cc3c969 Improve README, add comments, and clean up VectorSearchService
Updated README.md for clarity and additional setup instructions:
- Refined repository description to highlight native Vector type.
- Rephrased note on Vector Support feature for readability.
- Removed mention of EFCore.SqlServer.VectorSearch library.
- Added instructions for updating VECTOR column size and setting Dimension property.

Added comment in Scripts.sql to guide vector size setting in Embedding column.

Cleaned up VectorSearchService.cs by removing unused and commented-out SQL command execution code.
2024-10-01 17:35:59 +02:00
Marco Minerva 468b6e7c5c Update README.md 2024-07-22 12:48:51 +02:00
Marco Minerva e59941cb0f Update documentation 2024-07-22 12:40:00 +02:00
Marco Minerva 6790850afe Update README.md 2024-06-14 17:56:07 +02:00
Marco Minerva 7848252fae Update README.md 2024-06-14 17:49:48 +02:00
Marco Minerva 7251e4c902 Update README.md 2024-06-14 17:47:17 +02:00
Marco Minerva dcccdf7365 Enhanced app with Vector Search support
- Updated README.md with details on Vector Support in Azure SQL Database, application functionalities, and setup instructions.
- Removed inheritance of `Question` class from `Search` class and deleted `Search` class.
- Minor adjustment in Program.cs for endpoint description consistency.
- Simplified appsettings.Development.json by removing the empty "ConnectionStrings" section.
- Enhanced Script.sql with SQL commands to create `DocumentChunks` and `Documents` tables, including schema for identifiers, content, embeddings, document names, creation dates, and established a foreign key relationship between the two tables.
2024-06-14 17:42:37 +02:00
Marco Minerva 9284ae5377 Initial commit 2024-06-14 11:47:00 +02:00
Marco Minerva 246bf56955 Update README.md 2024-06-14 11:44:31 +02:00
Marco Minerva 3fff089947 Update README.md 2024-06-14 11:38:12 +02:00
Marco Minerva 318f73455b Initial commit 2024-06-14 11:37:55 +02:00