Skip to content

Commit a6ae129

Browse files
stainless-app[bot]RobertCraigie
stainless-app[bot]
authored and
RobertCraigie
committed
chore(internal): codegen related update
1 parent ffbb2da commit a6ae129

File tree

6 files changed

+171
-0
lines changed

6 files changed

+171
-0
lines changed

‎src/resources/beta/messages/batches.ts‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,25 @@ export class Batches extends APIResource {
2121
*
2222
* Learn more about the Message Batches API in our
2323
* [user guide](/en/docs/build-with-claude/batch-processing)
24+
*
25+
* @example
26+
* ```ts
27+
* const betaMessageBatch =
28+
* await client.beta.messages.batches.create({
29+
* requests: [
30+
* {
31+
* custom_id: 'my-custom-id-1',
32+
* params: {
33+
* max_tokens: 1024,
34+
* messages: [
35+
* { content: 'Hello, world', role: 'user' },
36+
* ],
37+
* model: 'claude-3-7-sonnet-20250219',
38+
* },
39+
* },
40+
* ],
41+
* });
42+
* ```
2443
*/
2544
create(params: BatchCreateParams, options?: RequestOptions): APIPromise<BetaMessageBatch> {
2645
const { betas, ...body } = params;
@@ -41,6 +60,14 @@ export class Batches extends APIResource {
4160
*
4261
* Learn more about the Message Batches API in our
4362
* [user guide](/en/docs/build-with-claude/batch-processing)
63+
*
64+
* @example
65+
* ```ts
66+
* const betaMessageBatch =
67+
* await client.beta.messages.batches.retrieve(
68+
* 'message_batch_id',
69+
* );
70+
* ```
4471
*/
4572
retrieve(
4673
messageBatchID: string,
@@ -63,6 +90,14 @@ export class Batches extends APIResource {
6390
*
6491
* Learn more about the Message Batches API in our
6592
* [user guide](/en/docs/build-with-claude/batch-processing)
93+
*
94+
* @example
95+
* ```ts
96+
* // Automatically fetches more pages as needed.
97+
* for await (const betaMessageBatch of client.beta.messages.batches.list()) {
98+
* // ...
99+
* }
100+
* ```
66101
*/
67102
list(
68103
params: BatchListParams | null | undefined = {},
@@ -87,6 +122,14 @@ export class Batches extends APIResource {
87122
*
88123
* Learn more about the Message Batches API in our
89124
* [user guide](/en/docs/build-with-claude/batch-processing)
125+
*
126+
* @example
127+
* ```ts
128+
* const betaDeletedMessageBatch =
129+
* await client.beta.messages.batches.delete(
130+
* 'message_batch_id',
131+
* );
132+
* ```
90133
*/
91134
delete(
92135
messageBatchID: string,
@@ -116,6 +159,14 @@ export class Batches extends APIResource {
116159
*
117160
* Learn more about the Message Batches API in our
118161
* [user guide](/en/docs/build-with-claude/batch-processing)
162+
*
163+
* @example
164+
* ```ts
165+
* const betaMessageBatch =
166+
* await client.beta.messages.batches.cancel(
167+
* 'message_batch_id',
168+
* );
169+
* ```
119170
*/
120171
cancel(
121172
messageBatchID: string,
@@ -141,6 +192,14 @@ export class Batches extends APIResource {
141192
*
142193
* Learn more about the Message Batches API in our
143194
* [user guide](/en/docs/build-with-claude/batch-processing)
195+
*
196+
* @example
197+
* ```ts
198+
* const betaMessageBatchIndividualResponse =
199+
* await client.beta.messages.batches.results(
200+
* 'message_batch_id',
201+
* );
202+
* ```
144203
*/
145204
async results(
146205
messageBatchID: string,

‎src/resources/beta/messages/messages.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ export class Messages extends APIResource {
4040
* conversations.
4141
*
4242
* Learn more about the Messages API in our [user guide](/en/docs/initial-setup)
43+
*
44+
* @example
45+
* ```ts
46+
* const betaMessage = await client.beta.messages.create({
47+
* max_tokens: 1024,
48+
* messages: [{ content: 'Hello, world', role: 'user' }],
49+
* model: 'claude-3-7-sonnet-20250219',
50+
* });
51+
* ```
4352
*/
4453
create(params: MessageCreateParamsNonStreaming, options?: RequestOptions): APIPromise<BetaMessage>;
4554
create(
@@ -77,6 +86,15 @@ export class Messages extends APIResource {
7786
*
7887
* Learn more about token counting in our
7988
* [user guide](/en/docs/build-with-claude/token-counting)
89+
*
90+
* @example
91+
* ```ts
92+
* const betaMessageTokensCount =
93+
* await client.beta.messages.countTokens({
94+
* messages: [{ content: 'string', role: 'user' }],
95+
* model: 'claude-3-7-sonnet-latest',
96+
* });
97+
* ```
8098
*/
8199
countTokens(
82100
params: MessageCountTokensParams,

‎src/resources/beta/models.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,13 @@ export class Models extends APIResource {
1212
*
1313
* The Models API response can be used to determine information about a specific
1414
* model or resolve a model alias to a model ID.
15+
*
16+
* @example
17+
* ```ts
18+
* const betaModelInfo = await client.beta.models.retrieve(
19+
* 'model_id',
20+
* );
21+
* ```
1522
*/
1623
retrieve(modelID: string, options?: RequestOptions): APIPromise<BetaModelInfo> {
1724
return this._client.get(path`/v1/models/${modelID}?beta=true`, options);
@@ -22,6 +29,14 @@ export class Models extends APIResource {
2229
*
2330
* The Models API response can be used to determine which models are available for
2431
* use in the API. More recently released models are listed first.
32+
*
33+
* @example
34+
* ```ts
35+
* // Automatically fetches more pages as needed.
36+
* for await (const betaModelInfo of client.beta.models.list()) {
37+
* // ...
38+
* }
39+
* ```
2540
*/
2641
list(
2742
query: ModelListParams | null | undefined = {},

‎src/resources/completions.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ export class Completions extends APIResource {
1717
* Future models and features will not be compatible with Text Completions. See our
1818
* [migration guide](https://docs.anthropic.com/en/api/migrating-from-text-completions-to-messages)
1919
* for guidance in migrating from Text Completions to Messages.
20+
*
21+
* @example
22+
* ```ts
23+
* const completion = await client.completions.create({
24+
* max_tokens_to_sample: 256,
25+
* model: 'claude-3-7-sonnet-latest',
26+
* prompt: '\n\nHuman: Hello, world!\n\nAssistant:',
27+
* });
28+
* ```
2029
*/
2130
create(body: CompletionCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Completion>;
2231
create(body: CompletionCreateParamsStreaming, options?: RequestOptions): APIPromise<Stream<Completion>>;

‎src/resources/messages/batches.ts‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,24 @@ export class Batches extends APIResource {
2121
*
2222
* Learn more about the Message Batches API in our
2323
* [user guide](/en/docs/build-with-claude/batch-processing)
24+
*
25+
* @example
26+
* ```ts
27+
* const messageBatch = await client.messages.batches.create({
28+
* requests: [
29+
* {
30+
* custom_id: 'my-custom-id-1',
31+
* params: {
32+
* max_tokens: 1024,
33+
* messages: [
34+
* { content: 'Hello, world', role: 'user' },
35+
* ],
36+
* model: 'claude-3-7-sonnet-20250219',
37+
* },
38+
* },
39+
* ],
40+
* });
41+
* ```
2442
*/
2543
create(body: BatchCreateParams, options?: RequestOptions): APIPromise<MessageBatch> {
2644
return this._client.post('/v1/messages/batches', { body, ...options });
@@ -33,6 +51,13 @@ export class Batches extends APIResource {
3351
*
3452
* Learn more about the Message Batches API in our
3553
* [user guide](/en/docs/build-with-claude/batch-processing)
54+
*
55+
* @example
56+
* ```ts
57+
* const messageBatch = await client.messages.batches.retrieve(
58+
* 'message_batch_id',
59+
* );
60+
* ```
3661
*/
3762
retrieve(messageBatchID: string, options?: RequestOptions): APIPromise<MessageBatch> {
3863
return this._client.get(path`/v1/messages/batches/${messageBatchID}`, options);
@@ -44,6 +69,14 @@ export class Batches extends APIResource {
4469
*
4570
* Learn more about the Message Batches API in our
4671
* [user guide](/en/docs/build-with-claude/batch-processing)
72+
*
73+
* @example
74+
* ```ts
75+
* // Automatically fetches more pages as needed.
76+
* for await (const messageBatch of client.messages.batches.list()) {
77+
* // ...
78+
* }
79+
* ```
4780
*/
4881
list(
4982
query: BatchListParams | null | undefined = {},
@@ -60,6 +93,12 @@ export class Batches extends APIResource {
6093
*
6194
* Learn more about the Message Batches API in our
6295
* [user guide](/en/docs/build-with-claude/batch-processing)
96+
*
97+
* @example
98+
* ```ts
99+
* const deletedMessageBatch =
100+
* await client.messages.batches.delete('message_batch_id');
101+
* ```
63102
*/
64103
delete(messageBatchID: string, options?: RequestOptions): APIPromise<DeletedMessageBatch> {
65104
return this._client.delete(path`/v1/messages/batches/${messageBatchID}`, options);
@@ -78,6 +117,13 @@ export class Batches extends APIResource {
78117
*
79118
* Learn more about the Message Batches API in our
80119
* [user guide](/en/docs/build-with-claude/batch-processing)
120+
*
121+
* @example
122+
* ```ts
123+
* const messageBatch = await client.messages.batches.cancel(
124+
* 'message_batch_id',
125+
* );
126+
* ```
81127
*/
82128
cancel(messageBatchID: string, options?: RequestOptions): APIPromise<MessageBatch> {
83129
return this._client.post(path`/v1/messages/batches/${messageBatchID}/cancel`, options);
@@ -92,6 +138,12 @@ export class Batches extends APIResource {
92138
*
93139
* Learn more about the Message Batches API in our
94140
* [user guide](/en/docs/build-with-claude/batch-processing)
141+
*
142+
* @example
143+
* ```ts
144+
* const messageBatchIndividualResponse =
145+
* await client.messages.batches.results('message_batch_id');
146+
* ```
95147
*/
96148
async results(
97149
messageBatchID: string,

‎src/resources/messages/messages.ts‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ export class Messages extends APIResource {
3636
* conversations.
3737
*
3838
* Learn more about the Messages API in our [user guide](/en/docs/initial-setup)
39+
*
40+
* @example
41+
* ```ts
42+
* const message = await client.messages.create({
43+
* max_tokens: 1024,
44+
* messages: [{ content: 'Hello, world', role: 'user' }],
45+
* model: 'claude-3-7-sonnet-20250219',
46+
* });
47+
* ```
3948
*/
4049
create(body: MessageCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Message>;
4150
create(
@@ -82,6 +91,15 @@ export class Messages extends APIResource {
8291
*
8392
* Learn more about token counting in our
8493
* [user guide](/en/docs/build-with-claude/token-counting)
94+
*
95+
* @example
96+
* ```ts
97+
* const messageTokensCount =
98+
* await client.messages.countTokens({
99+
* messages: [{ content: 'string', role: 'user' }],
100+
* model: 'claude-3-7-sonnet-latest',
101+
* });
102+
* ```
85103
*/
86104
countTokens(body: MessageCountTokensParams, options?: RequestOptions): APIPromise<MessageTokensCount> {
87105
return this._client.post('/v1/messages/count_tokens', { body, ...options });

0 commit comments

Comments
 (0)