Skip to content

Commit 0096b9a

Browse files
committed
Docs review
1 parent 15239fb commit 0096b9a

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs-devsite/ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The Firebase AI Web SDK.
117117
| [SchemaRequest](./ai.schemarequest.md#schemarequest_interface) | Final format for [Schema](./ai.schema.md#schema_class) params passed to backend requests. |
118118
| [SchemaShared](./ai.schemashared.md#schemashared_interface) | Basic [Schema](./ai.schema.md#schema_class) properties shared across several Schema-related types. |
119119
| [Segment](./ai.segment.md#segment_interface) | |
120-
| [SingleRequestOptions](./ai.singlerequestoptions.md#singlerequestoptions_interface) | Options that can be provided per-request. Extends the base [RequestOptions](./ai.requestoptions.md#requestoptions_interface) (like <code>timeout</code> and <code>baseUrl</code>) with request-specific controls like cancellation via <code>AbortSignal</code>.<!-- -->Options specified here will override any default [RequestOptions](./ai.requestoptions.md#requestoptions_interface) configured on a model (e.g. [GenerativeModel](./ai.generativemodel.md#generativemodel_class)<!-- -->). |
120+
| [SingleRequestOptions](./ai.singlerequestoptions.md#singlerequestoptions_interface) | Options that can be provided per-request. Extends the base [RequestOptions](./ai.requestoptions.md#requestoptions_interface) (like <code>timeout</code> and <code>baseUrl</code>) with request-specific controls like cancellation via <code>AbortSignal</code>.<!-- -->Options specified here will override any default [RequestOptions](./ai.requestoptions.md#requestoptions_interface) configured on a model (for example, [GenerativeModel](./ai.generativemodel.md#generativemodel_class)<!-- -->). |
121121
| [StartChatParams](./ai.startchatparams.md#startchatparams_interface) | Params for [GenerativeModel.startChat()](./ai.generativemodel.md#generativemodelstartchat)<!-- -->. |
122122
| [TextPart](./ai.textpart.md#textpart_interface) | Content part interface if the part represents a text string. |
123123
| [ToolConfig](./ai.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. |

docs-devsite/ai.singlerequestoptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# SingleRequestOptions interface
1313
Options that can be provided per-request. Extends the base [RequestOptions](./ai.requestoptions.md#requestoptions_interface) (like `timeout` and `baseUrl`<!-- -->) with request-specific controls like cancellation via `AbortSignal`<!-- -->.
1414

15-
Options specified here will override any default [RequestOptions](./ai.requestoptions.md#requestoptions_interface) configured on a model (e.g. [GenerativeModel](./ai.generativemodel.md#generativemodel_class)<!-- -->).
15+
Options specified here will override any default [RequestOptions](./ai.requestoptions.md#requestoptions_interface) configured on a model (for example, [GenerativeModel](./ai.generativemodel.md#generativemodel_class)<!-- -->).
1616

1717
<b>Signature:</b>
1818

@@ -25,15 +25,15 @@ export interface SingleRequestOptions extends RequestOptions
2525
2626
| Property | Type | Description |
2727
| --- | --- | --- |
28-
| [signal](./ai.singlerequestoptions.md#singlerequestoptionssignal) | AbortSignal | An <code>AbortSignal</code> instance that allows cancelling ongoing requests (like <code>generateContent</code> or <code>generateImages</code>).<!-- -->If provided, calling <code>abort()</code> on the corresponding <code>AbortController</code> will attempt to cancel the underlying HTTP request. An <code>AbortError</code> will be thrown if cancellation is successful.<!-- -->Note that this will not cancel the request in the backend, so billing will still be applied despite cancellation. |
28+
| [signal](./ai.singlerequestoptions.md#singlerequestoptionssignal) | AbortSignal | An <code>AbortSignal</code> instance that allows cancelling ongoing requests (like <code>generateContent</code> or <code>generateImages</code>).<!-- -->If provided, calling <code>abort()</code> on the corresponding <code>AbortController</code> will attempt to cancel the underlying HTTP request. An <code>AbortError</code> will be thrown if cancellation is successful.<!-- -->Note that this will not cancel the request in the backend, so any applicable billing charges will still be applied despite cancellation. |
2929
3030
## SingleRequestOptions.signal
3131
3232
An `AbortSignal` instance that allows cancelling ongoing requests (like `generateContent` or `generateImages`<!-- -->).
3333
3434
If provided, calling `abort()` on the corresponding `AbortController` will attempt to cancel the underlying HTTP request. An `AbortError` will be thrown if cancellation is successful.
3535
36-
Note that this will not cancel the request in the backend, so billing will still be applied despite cancellation.
36+
Note that this will not cancel the request in the backend, so any applicable billing charges will still be applied despite cancellation.
3737
3838
<b>Signature:</b>
3939

packages/ai/src/types/requests.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ export interface RequestOptions {
167167
* with request-specific controls like cancellation via `AbortSignal`.
168168
*
169169
* Options specified here will override any default {@link RequestOptions}
170-
* configured on a model (e.g. {@link GenerativeModel}).
170+
* configured on a model (for example, {@link GenerativeModel}).
171171
*
172172
* @public
173173
*/
@@ -180,8 +180,8 @@ export interface SingleRequestOptions extends RequestOptions {
180180
* will attempt to cancel the underlying HTTP request. An `AbortError` will be thrown
181181
* if cancellation is successful.
182182
*
183-
* Note that this will not cancel the request in the backend, so billing will
184-
* still be applied despite cancellation.
183+
* Note that this will not cancel the request in the backend, so any applicable billing charges
184+
* will still be applied despite cancellation.
185185
*
186186
* @example
187187
* ```javascript

0 commit comments

Comments
 (0)