gpt5 0.2.3

A Rust client library for OpenAI's GPT-5 API with support for function calling, reasoning, and streaming
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# GPT-5 Examples

This directory contains simple, practical examples showing how to use the GPT-5 Rust client library.

## Prerequisites

1. Set your OpenAI API key as an environment variable:
   ```bash
   export OPENAI_API_KEY="your-api-key-here"
   ```

2. Make sure you have the required dependencies in your `Cargo.toml`:
   ```toml
   [dependencies]
   gpt5 = "0.1.0"
   tokio = { version = "1.0", features = ["rt-multi-thread", "macros"] }
   serde_json = "1.0"
   ```

## Examples

### 1. Basic Usage (`basic_usage.rs`)
The simplest way to get started with GPT-5. Shows how to:
- Initialize the client
- Make simple requests
- Use different models (Nano, Mini, Main)

```bash
cargo run --example basic_usage
```

### 2. Simple Chat (`simple_chat.rs`)
A basic interactive chat loop. Perfect for:
- Testing the API
- Building simple chatbots
- Understanding basic request/response flow

```bash
cargo run --example simple_chat
```

### 3. Function Calling (`function_calling.rs`)
Demonstrates advanced features like:
- Defining custom tools/functions
- Function calling capabilities
- Tool choice configuration
- Verbosity and reasoning controls

```bash
cargo run --example function_calling
```

### 4. Error Handling (`error_handling.rs`)
Shows proper error handling patterns:
- Invalid API keys
- Network errors
- Input validation
- Error type checking

```bash
cargo run --example error_handling
```

### 5. Web Search Assistance (`web_search.rs`)
Learn how to:
- Enable OpenAI's web search assistance tool entry
- Provide a suggested query to steer the model's search focus
- Communicate soft limits on the number of search results to return
- Combine instructions and inputs for richer answers

```bash
cargo run --example web_search
```

## Running Examples

All examples can be run with:

```bash
# From the gpt5 directory
cargo run --example <example_name>

# Or from the project root
cargo run --example <example_name> --manifest-path gpt5/Cargo.toml
```

## Tips

- Start with `basic_usage.rs` to understand the fundamentals
- Use `simple_chat.rs` for interactive testing
- Check `error_handling.rs` for production-ready error handling
- Explore `function_calling.rs` for advanced features

## Need Help?

- Check the main [README](../README.md) for detailed documentation
- Look at the [integration tests](../tests/integration_tests.rs) for more complex examples
- Review the source code in the `src/` directory for implementation details