Skip to content

Commit 19700a5

Browse files
committed
Tweak responses README
1 parent 08f752c commit 19700a5

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -472,9 +472,10 @@ You can stream it as well!
472472
```ruby
473473
response = client.responses.create(parameters: {
474474
model: "gpt-4o",
475-
input: "Hello!"
475+
input: "Hello! I'm Szymon!"
476476
})
477477
puts response.dig("output", 0, "content", 0, "text")
478+
# => Hello Szymon! How can I assist you today?
478479
```
479480

480481
#### Follow-up Messages
@@ -485,6 +486,7 @@ followup = client.responses.create(parameters: {
485486
previous_response_id: response["id"]
486487
})
487488
puts followup.dig("output", 0, "content", 0, "text")
489+
# => Your name is Szymon! How can I help you today?
488490
```
489491

490492
#### Tool Calls
@@ -510,29 +512,32 @@ response = client.responses.create(parameters: {
510512
}
511513
]
512514
})
513-
puts response.dig("output", 0, "name") # => "get_current_weather"
515+
puts response.dig("output", 0, "name")
516+
# => "get_current_weather"
514517
```
515518

516519
#### Streaming
517520
```ruby
518-
chunks = []
519-
streamer = proc { |chunk, _| chunks << chunk }
520-
client.responses.create(parameters: {
521-
model: "gpt-4o",
522-
input: "Hello!",
523-
stream: streamer
524-
})
525-
output = chunks
526-
.select { |c| c["type"] == "response.output_text.delta" }
527-
.map { |c| c["delta"] }
528-
.join
529-
puts output
521+
client.responses.create(
522+
parameters: {
523+
model: "gpt-4o", # Required.
524+
input: "Hello!", # Required.
525+
stream: proc do |chunk, _bytesize|
526+
if chunk["type"] == "response.output_text.delta"
527+
print chunk["delta"]
528+
$stdout.flush # Ensure output is displayed immediately
529+
end
530+
end
531+
}
532+
)
533+
# => "Hi there! How can I assist you today?..."
530534
```
531535

532536
#### Retrieve a Response
533537
```ruby
534538
retrieved_response = client.responses.retrieve(response_id: response["id"])
535-
puts retrieved_response["object"] # => "response"
539+
puts retrieved_response["object"]
540+
# => "response"
536541
```
537542

538543
#### Delete a Response

0 commit comments

Comments
 (0)