Skip to content

Commit e9c8d71

Browse files
committed
README - adding info about close, OpenAIMultiServiceAdapter and OpenAIRetryServiceAdapter
1 parent ba534c5 commit e9c8d71

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,58 @@ Examples:
194194
}
195195
```
196196

197+
**✔️ Important Note**: After you are done using the service, you should close it by calling (🔥 new) `service.close`. Otherwise, the underlying resources/threads won't be released.
198+
199+
**III. Using multiple services (🔥 new)**
200+
201+
- Load distribution with `OpenAIMultiServiceAdapter` - _rotation type_ aka "round robin"
202+
203+
```scala
204+
val service1 = OpenAIServiceFactory("your-api-key1")
205+
val service2 = OpenAIServiceFactory("your-api-key2")
206+
val service3 = OpenAIServiceFactory("your-api-key3")
207+
208+
val service = OpenAIMultiServiceAdapter.ofRotationType(service1, service2, service3)
209+
210+
service.listModels.map { models =>
211+
models.foreach(println)
212+
service.close
213+
}
214+
```
215+
216+
- Load distribution with `OpenAIMultiServiceAdapter` - _random order_ type
217+
218+
```scala
219+
val service1 = OpenAIServiceFactory("your-api-key1")
220+
val service2 = OpenAIServiceFactory("your-api-key2")
221+
val service3 = OpenAIServiceFactory("your-api-key3")
222+
223+
val service = OpenAIMultiServiceAdapter.ofRandomAccessType(service1, service2, service3)
224+
225+
service.listModels.map { models =>
226+
models.foreach(println)
227+
service.close
228+
}
229+
```
230+
231+
- Retries with `OpenAIRetryServiceAdapter`
232+
233+
```scala
234+
val serviceAux = ... // your service
235+
236+
// wrap it with the retry adapter
237+
val service = OpenAIRetryServiceAdapter(
238+
serviceAux,
239+
maxAttempts = 10,
240+
sleepOnFailureMs = Some(1000) // 1 second
241+
)
242+
243+
service.listModels.map { models =>
244+
models.foreach(println)
245+
service.close
246+
}
247+
```
248+
197249
## FAQ 🤔
198250

199251
1. _Wen Scala 3?_

0 commit comments

Comments
 (0)