docs: add examples to tsdocs

Author: stainless-app[bot]

src/index.ts

@@ -184,6 +184,20 @@ export class Together extends Core.APIClient {
 
   /**
    * Query a reranker model
+   *
+   * @example
+   * ```ts
+   * const response = await client.rerank({
+   *   documents: [
+   *     { title: 'bar', text: 'bar' },
+   *     { title: 'bar', text: 'bar' },
+   *     { title: 'bar', text: 'bar' },
+   *     { title: 'bar', text: 'bar' },
+   *   ],
+   *   model: 'Salesforce/Llama-Rank-V1',
+   *   query: 'What animals can I find near Peru?',
+   * });
+   * ```
    */
   rerank(
     body: TopLevelAPI.RerankParams,

src/resources/audio.ts

@@ -7,6 +7,18 @@ import { type Response } from '../_shims/index';
 export class Audio extends APIResource {
   /**
    * Generate audio from input text
+   *
+   * @example
+   * ```ts
+   * const audio = await client.audio.create({
+   *   input: 'input',
+   *   model: 'cartesia/sonic',
+   *   voice: 'laidback woman',
+   * });
+   *
+   * const content = await audio.blob();
+   * console.log(content);
+   * ```
    */
   create(body: AudioCreateParams, options?: Core.RequestOptions): Core.APIPromise<Response> {
     return this._client.post('/audio/speech', {

src/resources/chat/completions.ts

@@ -11,6 +11,16 @@ import { ChatCompletionStream, ChatCompletionStreamParams } from 'together-ai/li
 export class Completions extends APIResource {
   /**
    * Query a chat model.
+   *
+   * @example
+   * ```ts
+   * const chatCompletion = await client.chat.completions.create(
+   *   {
+   *     messages: [{ content: 'string', role: 'system' }],
+   *     model: 'meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo',
+   *   },
+   * );
+   * ```
    */
   create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<ChatCompletion>;
   create(

src/resources/code-interpreter/code-interpreter.ts

@@ -14,6 +14,15 @@ export class CodeInterpreter extends APIResource {
    * session_id, the code will be run in that session. This is useful for running
    * multiple code snippets in the same environment, because dependencies and similar
    * things are persisted between calls to the same session.
+   *
+   * @example
+   * ```ts
+   * const executeResponse =
+   *   await client.codeInterpreter.execute({
+   *     code: "print('Hello, world!')",
+   *     language: 'python',
+   *   });
+   * ```
    */
   execute(
     body: CodeInterpreterExecuteParams,

src/resources/code-interpreter/sessions.ts

@@ -6,6 +6,12 @@ import * as Core from '../../core';
 export class Sessions extends APIResource {
   /**
    * Lists all your currently active sessions.
+   *
+   * @example
+   * ```ts
+   * const sessionListResponse =
+   *   await client.codeInterpreter.sessions.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<SessionListResponse> {
     return this._client.get('/tci/sessions', options);

src/resources/completions.ts

@@ -10,6 +10,15 @@ import { Stream } from '../streaming';
 export class Completions extends APIResource {
   /**
    * Query a language, code, or image model.
+   *
+   * @example
+   * ```ts
+   * const completion = await client.completions.create({
+   *   model: 'mistralai/Mixtral-8x7B-Instruct-v0.1',
+   *   prompt:
+   *     '<s>[INST] What is the capital of France? [/INST]',
+   * });
+   * ```
    */
   create(body: CompletionCreateParamsNonStreaming, options?: Core.RequestOptions): APIPromise<Completion>;
   create(

src/resources/embeddings.ts

@@ -6,6 +6,15 @@ import * as Core from '../core';
 export class Embeddings extends APIResource {
   /**
    * Query an embedding model for a given string of text.
+   *
+   * @example
+   * ```ts
+   * const embedding = await client.embeddings.create({
+   *   input:
+   *     'Our solar system orbits the Milky Way galaxy at about 515,000 mph',
+   *   model: 'togethercomputer/m2-bert-80M-8k-retrieval',
+   * });
+   * ```
    */
   create(body: EmbeddingCreateParams, options?: Core.RequestOptions): Core.APIPromise<Embedding> {
     return this._client.post('/embeddings', { body, ...options });

src/resources/endpoints.ts

@@ -9,6 +9,15 @@ export class Endpoints extends APIResource {
    * Creates a new dedicated endpoint for serving models. The endpoint will
    * automatically start after creation. You can deploy any supported model on
    * hardware configurations that meet the model's requirements.
+   *
+   * @example
+   * ```ts
+   * const endpoint = await client.endpoints.create({
+   *   autoscaling: { max_replicas: 5, min_replicas: 2 },
+   *   hardware: '1x_nvidia_a100_80gb_sxm',
+   *   model: 'meta-llama/Llama-3-8b-chat-hf',
+   * });
+   * ```
    */
   create(body: EndpointCreateParams, options?: Core.RequestOptions): Core.APIPromise<EndpointCreateResponse> {
     return this._client.post('/endpoints', { body, ...options });
@@ -17,6 +26,13 @@ export class Endpoints extends APIResource {
   /**
    * Retrieves details about a specific endpoint, including its current state,
    * configuration, and scaling settings.
+   *
+   * @example
+   * ```ts
+   * const endpoint = await client.endpoints.retrieve(
+   *   'endpoint-d23901de-ef8f-44bf-b3e7-de9c1ca8f2d7',
+   * );
+   * ```
    */
   retrieve(endpointId: string, options?: Core.RequestOptions): Core.APIPromise<EndpointRetrieveResponse> {
     return this._client.get(`/endpoints/${endpointId}`, options);
@@ -25,6 +41,13 @@ export class Endpoints extends APIResource {
   /**
    * Updates an existing endpoint's configuration. You can modify the display name,
    * autoscaling settings, or change the endpoint's state (start/stop).
+   *
+   * @example
+   * ```ts
+   * const endpoint = await client.endpoints.update(
+   *   'endpoint-d23901de-ef8f-44bf-b3e7-de9c1ca8f2d7',
+   * );
+   * ```
    */
   update(
     endpointId: string,
@@ -37,6 +60,11 @@ export class Endpoints extends APIResource {
   /**
    * Returns a list of all endpoints associated with your account. You can filter the
    * results by type (dedicated or serverless).
+   *
+   * @example
+   * ```ts
+   * const endpoints = await client.endpoints.list();
+   * ```
    */
   list(query?: EndpointListParams, options?: Core.RequestOptions): Core.APIPromise<EndpointListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<EndpointListResponse>;
@@ -52,6 +80,13 @@ export class Endpoints extends APIResource {
 
   /**
    * Permanently deletes an endpoint. This action cannot be undone.
+   *
+   * @example
+   * ```ts
+   * await client.endpoints.delete(
+   *   'endpoint-d23901de-ef8f-44bf-b3e7-de9c1ca8f2d7',
+   * );
+   * ```
    */
   delete(endpointId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/endpoints/${endpointId}`, {

src/resources/images.ts

@@ -6,6 +6,14 @@ import * as Core from '../core';
 export class Images extends APIResource {
   /**
    * Use an image model to generate an image for a given prompt.
+   *
+   * @example
+   * ```ts
+   * const imageFile = await client.images.create({
+   *   model: 'black-forest-labs/FLUX.1-schnell',
+   *   prompt: 'cat floating in space, cinematic',
+   * });
+   * ```
    */
   create(body: ImageCreateParams, options?: Core.RequestOptions): Core.APIPromise<ImageFile> {
     return this._client.post('/images/generations', { body, ...options });

src/resources/jobs.ts

@@ -6,13 +6,25 @@ import * as Core from '../core';
 export class Jobs extends APIResource {
   /**
    * Get the status of a specific job
+   *
+   * @example
+   * ```ts
+   * const job = await client.jobs.retrieve(
+   *   'job-a15dad11-8d8e-4007-97c5-a211304de284',
+   * );
+   * ```
    */
   retrieve(jobId: string, options?: Core.RequestOptions): Core.APIPromise<JobRetrieveResponse> {
     return this._client.get(`/jobs/${jobId}`, options);
   }
 
   /**
    * List all jobs and their statuses
+   *
+   * @example
+   * ```ts
+   * const jobs = await client.jobs.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<JobListResponse> {
     return this._client.get('/jobs', options);

src/resources/models.ts

@@ -6,13 +6,26 @@ import * as Core from '../core';
 export class Models extends APIResource {
   /**
    * Lists all of Together's open-source models
+   *
+   * @example
+   * ```ts
+   * const models = await client.models.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<ModelListResponse> {
     return this._client.get('/models', options);
   }
 
   /**
    * Upload a custom model from Hugging Face or S3
+   *
+   * @example
+   * ```ts
+   * const response = await client.models.upload({
+   *   model_name: 'Qwen2.5-72B-Instruct',
+   *   model_source: 'unsloth/Qwen2.5-72B-Instruct',
+   * });
+   * ```
    */
   upload(body: ModelUploadParams, options?: Core.RequestOptions): Core.APIPromise<ModelUploadResponse> {
     return this._client.post('/models', { body, ...options });