Skip to content

Commit 3a08c58

Browse files
committed
LLM: docs(ResponseStream): add detailed comments to ResponseStreamByIdParams fields
1 parent 68ec86e commit 3a08c58

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/lib/responses/ResponseStream.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ export type ResponseCreateAndStreamParams = Omit<ResponseCreateParamsBase, 'stre
2121
};
2222

2323
export type ResponseStreamByIdParams = {
24+
/**
25+
* The ID of the response to stream.
26+
*/
2427
response_id: string;
28+
/**
29+
* If provided, the stream will start after the event with the given sequence number.
30+
*/
2531
starting_after?: number;
2632
/**
2733
* Configuration options for a text response from the model. Can be plain text or
@@ -31,6 +37,11 @@ export type ResponseStreamByIdParams = {
3137
* - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
3238
*/
3339
text?: ResponseTextConfig;
40+
41+
/**
42+
* An array of tools the model may call while generating a response. When continuing a stream, provide
43+
* the same tools as the original request.
44+
*/
3445
tools?: ParseableToolsParams;
3546
};
3647

0 commit comments

Comments
 (0)