feat(api): Change the default max retries from 5 to 2

BREAKING CHANGE: The default max retries for api calls has changed from 5 to 2. This may result in more frequent non-200 responses.

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 41
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/togetherai%2Ftogetherai-f53d9282224f2c3943d83d014d64ba61271f3aedef59197cc4dae0102d2b365d.yml
 openapi_spec_hash: a884fe7d04e9f64675e3943a962ebb65
-config_hash: 74799f281947721570d77d51e09f278e
+config_hash: 3c3a676f96a972da95e0e85618e64c76

README.md

@@ -165,7 +165,7 @@ Error codes are as follows:
 
 ### Retries
 
-Certain errors will be automatically retried 5 times by default, with a short exponential backoff.
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
 Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
 429 Rate Limit, and >=500 Internal errors will all be retried by default.
 

src/client.ts

@@ -161,7 +161,7 @@ export interface ClientOptions {
    * The maximum number of times that the client will retry a request in case of a
    * temporary failure, like a network error or a 5XX error from the server.
    *
-   * @default 5
+   * @default 2
    */
   maxRetries?: number | undefined;
 
@@ -222,7 +222,7 @@ export class Together {
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
    * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
-   * @param {number} [opts.maxRetries=5] - The maximum number of times the client will retry a request.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
    * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
    * @param {Record<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
    */
@@ -254,7 +254,7 @@ export class Together {
       parseLogLevel(readEnv('TOGETHER_LOG'), "process.env['TOGETHER_LOG']", this) ??
       defaultLogLevel;
     this.fetchOptions = options.fetchOptions;
-    this.maxRetries = options.maxRetries ?? 5;
+    this.maxRetries = options.maxRetries ?? 2;
     this.fetch = options.fetch ?? Shims.getDefaultFetch();
     this.#encoder = Opts.FallbackEncoder;
 

src/internal/request-options.ts

@@ -41,7 +41,7 @@ export type RequestOptions = {
    * The maximum number of times that the client will retry a request in case of a
    * temporary failure, like a network error or a 5XX error from the server.
    *
-   * @default 5
+   * @default 2
    */
   maxRetries?: number;
 

tests/index.test.ts

@@ -339,12 +339,12 @@ describe('instantiate client', () => {
   });
 
   test('maxRetries option is correctly set', () => {
-    const client = new Together({ maxRetries: 10, apiKey: 'My API Key' });
-    expect(client.maxRetries).toEqual(10);
+    const client = new Together({ maxRetries: 4, apiKey: 'My API Key' });
+    expect(client.maxRetries).toEqual(4);
 
     // default
     const client2 = new Together({ apiKey: 'My API Key' });
-    expect(client2.maxRetries).toEqual(5);
+    expect(client2.maxRetries).toEqual(2);
   });
 
   describe('withOptions', () => {