Class Interactions

constructor

• new Interactions(
      client: BaseGeminiNextGenAPIClient,
  ): GeminiNextGenAPIClient.Interactions

  Parameters

  • client: BaseGeminiNextGenAPIClient

  Returns GeminiNextGenAPIClient.Interactions

Static Readonly_key

cancel

• cancel(
      id: string,
      params?:
          | undefined
          | null
          | GeminiNextGenAPIClient.Interactions.InteractionCancelParams,
      options?: RequestOptions,
  ): APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Cancels an interaction by id. This only applies to background interactions that are still running.

  Parameters

  • id: string
  • params: undefined | null | GeminiNextGenAPIClient.Interactions.InteractionCancelParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Example

  const interaction = await client.interactions.cancel('id');
  Copy

create

• create(
      params: GeminiNextGenAPIClient.Interactions.CreateModelInteractionParamsNonStreaming,
      options?: RequestOptions,
  ): APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Creates a new interaction.

  Parameters

  • params: GeminiNextGenAPIClient.Interactions.CreateModelInteractionParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Example

  const interaction = await client.interactions.create({
    input: 'string',
    model: 'gemini-2.5-pro',
  });
  Copy

• create(
      params: GeminiNextGenAPIClient.Interactions.CreateModelInteractionParamsStreaming,
      options?: RequestOptions,
  ): APIPromise<
      Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Creates a new interaction.

  Parameters

  • params: GeminiNextGenAPIClient.Interactions.CreateModelInteractionParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>>

  Example

  const interaction = await client.interactions.create({
    input: 'string',
    model: 'gemini-2.5-pro',
  });
  Copy

• create(
      params: GeminiNextGenAPIClient.Interactions.CreateAgentInteractionParamsNonStreaming,
      options?: RequestOptions,
  ): APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Creates a new interaction.

  Parameters

  • params: GeminiNextGenAPIClient.Interactions.CreateAgentInteractionParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Example

  const interaction = await client.interactions.create({
    input: 'string',
    model: 'gemini-2.5-pro',
  });
  Copy

• create(
      params: GeminiNextGenAPIClient.Interactions.CreateAgentInteractionParamsStreaming,
      options?: RequestOptions,
  ): APIPromise<
      Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Creates a new interaction.

  Parameters

  • params: GeminiNextGenAPIClient.Interactions.CreateAgentInteractionParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>>

  Example

  const interaction = await client.interactions.create({
    input: 'string',
    model: 'gemini-2.5-pro',
  });
  Copy

• create(
      params:
          | BaseCreateModelInteractionParams
          | BaseCreateAgentInteractionParams,
      options?: RequestOptions,
  ): APIPromise<
      | GeminiNextGenAPIClient.Interactions.Interaction
      | Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Creates a new interaction.

  Parameters

  • params: BaseCreateModelInteractionParams | BaseCreateAgentInteractionParams
  • Optionaloptions: RequestOptions

  Returns APIPromise<
      | GeminiNextGenAPIClient.Interactions.Interaction
      | Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Example

  const interaction = await client.interactions.create({
    input: 'string',
    model: 'gemini-2.5-pro',
  });
  Copy

delete

• delete(
      id: string,
      params?:
          | undefined
          | null
          | GeminiNextGenAPIClient.Interactions.InteractionDeleteParams,
      options?: RequestOptions,
  ): APIPromise<unknown>

  Deletes the interaction by id.

  Parameters

  • id: string
  • params: undefined | null | GeminiNextGenAPIClient.Interactions.InteractionDeleteParams = {}
  • Optionaloptions: RequestOptions

  Returns APIPromise<unknown>

  Example

  const interaction = await client.interactions.delete('id');
  Copy

get

• get(
      id: string,
      params?: GeminiNextGenAPIClient.Interactions.InteractionGetParamsNonStreaming,
      options?: RequestOptions,
  ): APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • Optionalparams: GeminiNextGenAPIClient.Interactions.InteractionGetParamsNonStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<GeminiNextGenAPIClient.Interactions.Interaction>

  Example

  const interaction = await client.interactions.get('id');
  Copy

• get(
      id: string,
      params: GeminiNextGenAPIClient.Interactions.InteractionGetParamsStreaming,
      options?: RequestOptions,
  ): APIPromise<
      Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • params: GeminiNextGenAPIClient.Interactions.InteractionGetParamsStreaming
  • Optionaloptions: RequestOptions

  Returns APIPromise<Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>>

  Example

  const interaction = await client.interactions.get('id');
  Copy

• get(
      id: string,
      params?: InteractionGetParamsBase,
      options?: RequestOptions,
  ): APIPromise<
      | GeminiNextGenAPIClient.Interactions.Interaction
      | Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Retrieves the full details of a single interaction based on its Interaction.id.

  Parameters

  • id: string
  • Optionalparams: InteractionGetParamsBase
  • Optionaloptions: RequestOptions

  Returns APIPromise<
      | GeminiNextGenAPIClient.Interactions.Interaction
      | Stream<GeminiNextGenAPIClient.Interactions.InteractionSSEEvent>,
  >

  Example

  const interaction = await client.interactions.get('id');
  Copy