Skip to content

Commit ba044f1

Browse files
committed
Bump version to 1.0.0
1 parent 1e6f1bd commit ba044f1

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# About
2+
23
**Mistral-java-client** is a Java client for the [Mistral AI](https://mistral.ai/) API. It allows you to easily interact
34
with the Mistral AI API from your Java application.
45
Currently supports all chat completion models. At the time of writing these are:
@@ -12,24 +13,28 @@ Currently supports all chat completion models. At the time of writing these are:
1213

1314
New models or models not listed here may be already supported without any updates to the library.
1415

15-
**NOTE:** It is currently NOT possible to use function calls. This will be added in the future. The currently supported
16-
APIs should be stable.
16+
**NOTE:** This library is currently in **alpha**. It is currently NOT possible to using streaming in message
17+
completions or function calls. This will be added in the future. The currently supported APIs should be stable
1718
however.
1819

1920
# Supported APIs
21+
2022
Mistral-java-client is built against version 0.0.1 of the [Mistral AI API](https://docs.mistral.ai/api/).
2123

2224
- [Create Chat Completions](https://docs.mistral.ai/api/#operation/createChatCompletion)
2325
- [List Available Models](https://docs.mistral.ai/api/#operation/listModels)
2426
- [Create Embeddings](https://docs.mistral.ai/guides/embeddings/)
2527

2628
# Requirements
29+
2730
- Java 17 or higher
2831
- A Mistral AI API Key (see the [Mistral documentation](https://docs.mistral.ai/#api-access) for more details on API
2932
access)
3033

3134
# Installation
35+
3236
## Gradle
37+
3338
```groovy
3439
repositories {
3540
maven { url 'https://jitpack.io' }
@@ -41,6 +46,7 @@ dependencies {
4146
```
4247

4348
## Maven
49+
4450
```xml
4551
<repositories>
4652
<repository>
@@ -57,10 +63,12 @@ dependencies {
5763
```
5864

5965
# Usage
66+
6067
The MistralClient class contains all the methods needed to interact with the Mistral AI API. The following examples show
6168
how to use the client to list available models and create chat completions.
6269

6370
## List Available Models
71+
6472
```java
6573
// You can also put the API key in an environment variable called MISTRAL_API_KEY and remove the apiKey parameter given to the MistralClient constructor
6674
String apiKey = "API_KEY_HERE";
@@ -92,7 +100,6 @@ mistral-embed
92100
```
93101

94102
## Chat Completions
95-
96103
The chat completion in this example code is blocking and will wait until the whole response is generated.
97104
See [Streaming Chat Completions](#streaming-chat-completions) for a way to stream chunks as they are being generated.
98105
```java
@@ -247,9 +254,8 @@ Example output:
247254
```
248255

249256
# Roadmap
250-
- [ ] Add support for streaming in message completions
251257
- [ ] Add support for Function Calls
252-
- [ ] Figure out how Mistral handles rate limiting and create a queue system to handle it
258+
- [ ] Handle rate limiting using some sort of queue system
253259
- [ ] Unit tests
254260

255261
# License

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
}
66

77
group = 'nl.dannyj'
8-
version = '0.3.0'
8+
version = '1.0.0'
99

1010
repositories {
1111
mavenCentral()

0 commit comments

Comments
 (0)