Skip to content

Commit b6aba41

Browse files
committed
docs: Update README to include InferenceGatewayAPI in import statements for clarity
Signed-off-by: Eden Reich <eden.reich@gmail.com>
1 parent 6b7e6d4 commit b6aba41

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@ Run `cargo add inference-gateway-sdk`.
2222
### Creating a Client
2323

2424
```rust
25-
use inference_gateway_sdk::{InferenceGatewayClient, Message, Provider, MessageRole};
25+
use inference_gateway_sdk::{
26+
InferenceGatewayAPI,
27+
InferenceGatewayClient,
28+
Message,
29+
Provider,
30+
MessageRole
31+
};
2632
use log::info;
2733
use std::error::Error;
2834

@@ -59,7 +65,13 @@ fn main() -> Result<(), Box<dyn Error>> {
5965
To list all available models from all configured providers, use the `list_models` method:
6066

6167
```rust
62-
use inference_gateway_sdk::{InferenceGatewayClient, Message, Provider, MessageRole};
68+
use inference_gateway_sdk::{
69+
InferenceGatewayAPI,
70+
InferenceGatewayClient,
71+
Message,
72+
Provider,
73+
MessageRole
74+
};
6375
use log::info;
6476

6577
fn main() -> Result<(), Box<dyn Error>> {
@@ -89,8 +101,10 @@ fn main() -> Result<(), Box<dyn Error>> {
89101
To list all available models from a specific provider, use the `list_models_by_provider` method:
90102

91103
```rust
104+
// ...rest of the imports
92105
use log::info;
93106

107+
// ...main function
94108
let resp = client.list_models_by_provider(Provider::Ollama)?;
95109
let models = resp.models;
96110
info!("Provider: {:?}", resp.provider);
@@ -104,8 +118,10 @@ for model in models {
104118
To generate content using a model, use the `generate_content` method:
105119

106120
```rust
121+
// ...rest of the imports
107122
use log::info;
108123

124+
// ...main function
109125
let response = client.generate_content(
110126
Provider::Ollama,
111127
"llama2",
@@ -124,8 +140,10 @@ info!("Response: {:?}", response.response);
124140
To check if the Inference Gateway is running, use the `health_check` method:
125141

126142
```rust
143+
// ...rest of the imports
127144
use log::info;
128145

146+
// ...main function
129147
let is_healthy = client.health_check()?;
130148
info!("API is healthy: {}", is_healthy);
131149
```

0 commit comments

Comments
 (0)