Skip to content

Commit 5f852bc

Browse files
committed
2 parents 14d62c5 + cfb0874 commit 5f852bc

File tree

5 files changed

+114
-13
lines changed

5 files changed

+114
-13
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Guidelines for Contributing
2+
3+
> This package is distributed under a permissive [Apache License](LICENSE).
4+
> We accept third-party contributions.
5+
6+
## Ways to Contribute
7+
8+
You can contribute by:
9+
10+
- Submitting bug fixes.
11+
- Proposing changes in documentation or updates to existing code.
12+
- Adding features or missing functionalities.
13+
14+
## Steps to Contribute
15+
16+
1. Branch out from `main`.
17+
2. Add your contribution.
18+
3. Ensure all tests pass: `dotnet test`
19+
4. Submit a [Pull Request](https://github.com/telerik/nuclia-dotnet-sdk/pulls).
20+
21+
## Code Style
22+
23+
- Follow the conventions defined in `.editorconfig`.
24+
- Include XML documentation comments on all public APIs.
25+
26+
## Support-Related Issues
27+
28+
Use [GitHub Issues](https://github.com/telerik/nuclia-dotnet-sdk/issues) to report bugs or request features.

LICENSE

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
Progress Nuclia SDK LICENSE AGREEMENT
2+
3+
Last updated: 24 February 2026
4+
5+
6+
IMPORTANT - READ CAREFULLY.
7+
8+
This Progress Nuclia SDK License Agreement ("Agreement") is a legal agreement between you (either an individual or a legal entity) and Progress Software Corporation ("Progress", "we", "us", or "our") governing your use of the Progress Nuclia Software Development Kit ("SDK"). YOU AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT BY DOWNLOADING, INSTALLING (IF APPLICABLE), ACCESSING, COPYING OR OTHERWISE USING THE SDK, DOCUMENTATION AND/OR PROGRAM MATERIALS. IF YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL (IF APPLICABLE), ACCESS, COPY OR USE THE SDK AND/OR PROGRAM MATERIALS.
9+
10+
1. DEFINITIONS
11+
12+
"SDK" means the software libraries, APIs, tools, sample code, and related documentation made available by Progress for the purpose of enabling applications to interoperate with Progress products.
13+
14+
"Documentation" means written or electronic materials provided by Progress describing the SDK.
15+
16+
“Program Materials” means all information and materials, including Documentation, training materials, technical information and presentation materials related to the SDK.
17+
18+
2. LICENSE GRANT
19+
20+
Subject to your compliance with this Agreement, Progress grants you a non-exclusive, worldwide, royalty-free, and perpetual license to use, reproduce, and modify the SDK solely to develop, test, and operate software applications that interoperate with Progress products.
21+
22+
You may permit your employees and contractors to exercise the rights granted to you under this Agreement, provided that you remain responsible for their compliance with this Agreement.
23+
24+
Any other products you purchase or license from Progress are subject to the applicable End User License Agreements (EULA) available at https://www.telerik.com/purchase/license-agreements.
25+
26+
3. RESTRICTIONS
27+
28+
You may not:
29+
(a) sell, rent, lease, sublicense, or distribute the SDK on a standalone basis;
30+
(b) remove or alter any copyright, trademark, or proprietary notices included in the SDK;
31+
(c) reverse engineer, decompile, or disassemble any binary components of the SDK except to the extent expressly permitted by applicable law.
32+
33+
4. THIRD-PARTY COMPONENTS
34+
35+
The SDK may include third-party software components subject to separate license terms. Such terms will be provided with the SDK, and you agree to comply with them.
36+
37+
5. OWNERSHIP
38+
39+
The SDK, the Documentation and/or any Program Materials are owned by Progress or its licensors and are protected by intellectual property laws. This Agreement does not transfer any ownership rights to you.
40+
41+
6. TERM AND TERMINATION
42+
43+
This Agreement is effective until terminated. Progress may terminate this Agreement if you materially breach its terms. Upon termination, you must cease all use of the SDK and destroy all copies of the SDK, the Documentation and/or of the Program Materials in your possession or control.
44+
45+
7. MAINTENANCE AND SUPPORT SERVICES
46+
47+
We may, at our sole discretion, decide whether to offer any maintenance and support for the SDK during the evaluation period, and to include any conditions or limits on such maintenance and support.
48+
49+
8. WARRANTY EXCLUSION
50+
51+
THE SDK AND ITS FEATURES ARE LICENSED “AS IS”. YOU BEAR THE RISK OF USING THE SDK. PROGRESS GIVES NO EXPRESS WARRANTIES, GUARANTEES OR CONDITIONS. YOU MAY HAVE ADDITIONAL RIGHTS UNDER YOUR LOCAL LAWS WHICH THIS AGREEMENT CANNOT CHANGE. TO THE EXTENT PERMITTED UNDER YOUR LOCAL LAWS, PROGRESS EXCLUDES THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
52+
53+
9. LIABILITY EXCLUSION
54+
55+
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL PROGRESS BE LIABLE FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT WITH RESPECT TO THE SDK AND/OR ITS FEATURES, INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF THE LEGAL OR EQUITABLE THEORY (CONTRACT, TORT OR OTHERWISE) UPON WHICH THE CLAIM IS BASED. IN ANY CASE, PROGRESS’S ENTIRE LIABILITY WITH RESPECT THE SDK AND/OR ITS FEATURES UNDER ANY PROVISION OF THIS AGREEMENT SHALL NOT EXCEED $5, NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY LIMITED REMEDY. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT BE APPLICABLE.
56+
57+
10. EXPORT CONTROL
58+
59+
You agree to comply with all applicable export control and economic sanctions laws and regulations relating to your use of the SDK.
60+
61+
11. GENERAL
62+
63+
This Agreement constitutes the entire agreement between you and Progress relating to the SDK and supersedes any prior agreements or understandings. This Agreement is governed by the laws of the Commonwealth of Massachusetts, USA, excluding its conflict of laws principles.
64+
65+
You acknowledge that the SDK, Documentation and/or Program Materials provided to you, or which you download from relevant sources, are valuable proprietary and trade secret information of Progress or its licensors. If you are an entity, unless otherwise expressly permitted hereunder, you agree to limit use and disclosure of the SDK, Documentation and/or Program Materials to your employees and authorized contractors who are permitted to use such items pursuant to the terms and conditions of this Agreement and who agree to be bound by the terms and conditions contained herein. Further, except as otherwise expressly permitted herein, you agree: (i) not to provide or disclose any of the SDK, Documentation and/or Program Materials, or any portion of the foregoing, to another individual or entity; and (ii) to take all reasonable precautions to maintain the confidentiality of said items.
66+
67+
You agree not to disclose any benchmark results relating to your use of any of the Software without the prior written consent of PSC.
68+
69+
You may have access from time to time during your license term to certain information about Progress’ future product development plans and/or business development strategies. Such information shall be considered confidential information of Progress and your use of, or access to, such information shall be subject to the same nondisclosure terms and conditions specified in this Section applicable for the SDK, Documentation and/or Program Materials. Further, you acknowledge that Progress reserves the right, in its sole discretion, to modify or abandon, without notice to you, any such future product plans and/or business development strategies.
70+

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,7 @@ A comprehensive .NET SDK for Progress Agentic RAG's NucliaDb, providing RAG (Ret
44

55
## 📚 Documentation
66

7-
- **[Full SDK Documentation](docs/index.md)** - Complete API reference, configuration options, and advanced features
8-
- **[Getting Started Examples](samples/GettingStarted/Basics/)** - Step-by-step tutorials covering:
9-
- Basic connectivity
10-
- Dependency injection integration
11-
- Streaming responses
12-
- Citations and source attribution
13-
- Structured outputs
14-
- **[Blazor Sample App](samples/GettingStarted/Blazor/SDK_Blazor_Ask/)** - Complete Blazor Web App demonstrating SDK integration
7+
- **[Full SDK Documentation](https://docs.rag.progress.cloud/docs/develop/dotnet-sdk/)** - Complete API reference, configuration options, and advanced features
158

169
## Installation
1710

@@ -39,10 +32,17 @@ using Progress.Nuclia.Extensions;
3932
// Create configuration
4033
var config = new NucliaDbConfig(
4134
ZoneId: "aws-us-east-2-1",
42-
KnowledgeBoxId: "your-knowledge-box-id",
35+
KnowledgeBoxId: "your-knowledge-box-id",
4336
ApiKey: "your-api-key"
4437
);
4538

46-
// Register with logging
47-
builder.Services.AddNucliaDb(config).UseLogging();
48-
```
39+
// Create a client instance
40+
using var nucliaDbClient = new NucliaDbClient(config);
41+
42+
// Or Register with DI and inject as nucliaDbClient
43+
// builder.Services.AddNucliaDb(config).UseLogging();
44+
45+
// ask a question
46+
var response = await nucliaDbClient.Search.AskAsync(new AskRequest("What is Nuclia?"));
47+
Console.WriteLine(response.Data.Answer);
48+
```

src/Progress.Nuclia/Progress.Nuclia.csproj

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,14 @@
1717
<RepositoryUrl>https://github.com/telerik/nuclia-dotnet-sdk</RepositoryUrl>
1818
<RepositoryType>git</RepositoryType>
1919
<PackageReadmeFile>README.md</PackageReadmeFile>
20-
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
20+
<PackageLicenseFile>LICENSE</PackageLicenseFile>
21+
<PackageIcon>progress-64x64.png</PackageIcon>
2122
</PropertyGroup>
2223

2324
<ItemGroup>
2425
<None Include="../../README.md" Pack="true" PackagePath="" />
26+
<None Include="../../LICENSE" Pack="true" PackagePath="" />
27+
<None Include="images\progress-64x64.png" Pack="true" PackagePath="" />
2528
</ItemGroup>
2629

2730
<ItemGroup>
1.57 KB
Loading

0 commit comments

Comments
 (0)