https://github.com/SpongeEngine/LMStudioSharp
C# client for interacting with LM Studio through its native and OpenAI-compatible endpoints.
https://github.com/SpongeEngine/LMStudioSharp
ai ai-client csharp dotnet language-models llm llm-client lm-studio lmstudio local-llm local-llm-integration local-llms offline-ai openai-compatible-api self-hosted-ai
Last synced: 4 months ago
JSON representation
C# client for interacting with LM Studio through its native and OpenAI-compatible endpoints.
- Host: GitHub
- URL: https://github.com/SpongeEngine/LMStudioSharp
- Owner: SpongeEngine
- License: mit
- Created: 2024-12-29T22:16:56.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-18T17:02:42.000Z (4 months ago)
- Last Synced: 2025-01-20T21:06:34.281Z (4 months ago)
- Topics: ai, ai-client, csharp, dotnet, language-models, llm, llm-client, lm-studio, lmstudio, local-llm, local-llm-integration, local-llms, offline-ai, openai-compatible-api, self-hosted-ai
- Language: C#
- Homepage: https://www.nuget.org/packages/SpongeEngine.LMStudioSharp
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# LMStudioSharp
[](https://www.nuget.org/packages/SpongeEngine.LMStudioSharp)
[](https://www.nuget.org/packages/SpongeEngine.LMStudioSharp)
[](LICENSE)
[](https://dotnet.microsoft.com/download)
C# client for interacting with LM Studio's native API.
## Features
- Complete support for LM Studio's native API
- Text completion and chat completion
- Streaming support for both completion types
- Text embeddings generation
- Model information retrieval
- Comprehensive configuration options
- Built-in error handling and logging
- Cross-platform compatibility
- Full async/await support
📦 [View Package on NuGet](https://www.nuget.org/packages/SpongeEngine.LMStudioSharp)
## Installation
Install via NuGet:
```bash
dotnet add package SpongeEngine.LMStudioSharp
```
## Quick Start
```csharp
using SpongeEngine.LMStudioSharp;
using SpongeEngine.LMStudioSharp.Models.Completion;
using SpongeEngine.LMStudioSharp.Models.Chat;
// Configure the client
var options = new LmStudioClientOptions
{
HttpClient = new HttpClient
{
BaseAddress = new Uri("http://localhost:1234")
}
};
// Create client instance
using var client = new LmStudioSharpClient(options);
// List available models
var models = await client.ListModelsAsync();
var modelId = models.Data[0].Id;
// Text completion
var completionRequest = new CompletionRequest
{
Model = modelId,
Prompt = "Write a short story about a robot:",
MaxTokens = 200,
Temperature = 0.7f,
TopP = 0.9f
};
var completionResponse = await client.CompleteAsync(completionRequest);
Console.WriteLine(completionResponse.Choices[0].GetText());
// Chat completion
var chatRequest = new ChatRequest
{
Model = modelId,
Messages = new List
{
new() { Role = "system", Content = "You are a helpful assistant." },
new() { Role = "user", Content = "Tell me a joke about programming." }
},
Temperature = 0.7f
};
var chatResponse = await client.ChatCompleteAsync(chatRequest);
Console.WriteLine(chatResponse.Choices[0].GetText());
// Stream completion
await foreach (var token in client.StreamCompletionAsync(completionRequest))
{
Console.Write(token);
}
```
## Configuration Options
### Client Options
```csharp
var options = new LmStudioClientOptions
{
HttpClient = new HttpClient
{
BaseAddress = new Uri("http://localhost:1234")
}, // Configure HttpClient with base address
JsonSerializerOptions = new JsonSerializerOptions(), // Optional JSON options
Logger = loggerInstance // Optional ILogger instance
};
```
### Completion Request Parameters
```csharp
var request = new CompletionRequest
{
Model = "model-id",
Prompt = "Your prompt here",
MaxTokens = 200, // Maximum tokens to generate
Temperature = 0.7f, // Randomness (0.0-1.0)
TopP = 0.9f, // Nucleus sampling threshold
Stop = new[] { "\n" }, // Stop sequences
Stream = false // Enable streaming
};
```
## Error Handling
```csharp
try
{
var response = await client.CompleteAsync(request);
}
catch (LlmSharpException ex)
{
Console.WriteLine($"LM Studio error: {ex.Message}");
if (ex.StatusCode.HasValue)
{
Console.WriteLine($"Status code: {ex.StatusCode}");
}
Console.WriteLine($"Response content: {ex.ResponseContent}");
}
catch (Exception ex)
{
Console.WriteLine($"General error: {ex.Message}");
}
```
## Logging
The client supports Microsoft.Extensions.Logging:
```csharp
var logger = LoggerFactory
.Create(builder => builder
.AddConsole()
.SetMinimumLevel(LogLevel.Debug))
.CreateLogger();
var options = new LmStudioClientOptions
{
HttpClient = new HttpClient
{
BaseAddress = new Uri("http://localhost:1234")
},
Logger = logger
};
var client = new LmStudioSharpClient(options);
```
## JSON Serialization
Custom JSON options can be provided:
```csharp
var jsonOptions = new JsonSerializerOptions
{
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull
};
var options = new LmStudioClientOptions
{
HttpClient = new HttpClient
{
BaseAddress = new Uri("http://localhost:1234")
},
JsonSerializerOptions = jsonOptions
};
var client = new LmStudioSharpClient(options);
```
## Testing
The library includes both unit and integration tests. Integration tests require a running LM Studio server.
To run the tests:
```bash
dotnet test
```
To configure the test environment:
```bash
# Set environment variables for testing
export LMSTUDIO_BASE_URL="http://localhost:1234"
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## Support
For issues and feature requests, please use the [GitHub issues page](https://github.com/SpongeEngine/LMStudioSharp/issues).