Class GeminiInteractionsSDK

constructor

• new GeminiInteractionsSDK(): GeminiInteractionsSDK

  Returns GeminiInteractionsSDK

ReadonlypromptsHelperImport

denormalizeUpdates

• denormalizeUpdates(
      updates: NormalizedPromptUpdates,
      currentValues?: Record<string, PropValue>,
  ): Record<string, ModelPropValue | null>

  Convert NormalizedPromptUpdates (what the UI sends back) into the raw property-name-keyed updates that PromptFileType.updateProperty and friends operate on.

  Parameters

  • updates: NormalizedPromptUpdates

    Updates expressed in the normalized vocabulary.

  • OptionalcurrentValues: Record<string, PropValue>

  Returns Record<string, ModelPropValue | null>

  A Record keyed by the SDK's actual property names. Values may be null (to remove) or a PropValue.

executeConfig

• executeConfig(config: CreateInteractionParams): Promise<void>

  Executes a prompt config object.

  Parameters

  • config: CreateInteractionParams

    The config object returned by the prompt function.

  Returns Promise<void>

getModelCatalog

• getModelCatalog(): Promise<
      {
          groups: {
              Google: {
                  customValueTemplates: {
                      agent: {
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "agent" };
                              value: { kind: "primitive"; value: "$input" };
                          };
                      };
                      model: {
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "$input" };
                          };
                      };
                  };
              };
          };
          models: readonly [
              {
                  group: "Google";
                  id: "gemini-3.1-pro-preview";
                  label: "Gemini 3.1 Pro Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3.1-pro-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3.1-pro-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-3-flash-preview";
                  label: "Gemini 3 Flash Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3-flash-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3-flash-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-3.1-flash-lite-preview";
                  label: "Gemini 3.1 Flash-Lite Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3.1-flash-lite-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3.1-flash-lite-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-pro";
                  label: "Gemini 2.5 Pro";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-pro";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-pro" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-flash";
                  label: "Gemini 2.5 Flash";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-flash";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-flash" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-flash-lite";
                  label: "Gemini 2.5 Flash-lite";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-flash-lite";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-flash-lite" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "deep-research-pro-preview-12-2025";
                  label: "Deep Research Preview";
                  values: {
                      agent: {
                          displayValue: "deep-research-pro-preview-12-2025";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "agent" };
                              value: {
                                  kind: "primitive";
                                  value: "deep-research-pro-preview-12-2025";
                              };
                          };
                      };
                  };
              },
          ];
          modelValueTypes: {
              agent: { description: "Agents"; label: "Agents" };
              model: { description: "Models"; label: "Models" };
          };
      },
  >

  Returns model catalog information: the set of known providers and a curated list of popular models for this SDK.

  Returns Promise<
      {
          groups: {
              Google: {
                  customValueTemplates: {
                      agent: {
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "agent" };
                              value: { kind: "primitive"; value: "$input" };
                          };
                      };
                      model: {
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "$input" };
                          };
                      };
                  };
              };
          };
          models: readonly [
              {
                  group: "Google";
                  id: "gemini-3.1-pro-preview";
                  label: "Gemini 3.1 Pro Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3.1-pro-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3.1-pro-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-3-flash-preview";
                  label: "Gemini 3 Flash Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3-flash-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3-flash-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-3.1-flash-lite-preview";
                  label: "Gemini 3.1 Flash-Lite Preview";
                  values: {
                      model: {
                          displayValue: "gemini-3.1-flash-lite-preview";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-3.1-flash-lite-preview" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-pro";
                  label: "Gemini 2.5 Pro";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-pro";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-pro" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-flash";
                  label: "Gemini 2.5 Flash";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-flash";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-flash" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "gemini-2.5-flash-lite";
                  label: "Gemini 2.5 Flash-lite";
                  values: {
                      model: {
                          displayValue: "gemini-2.5-flash-lite";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "model" };
                              value: { kind: "primitive"; value: "gemini-2.5-flash-lite" };
                          };
                      };
                  };
              },
              {
                  group: "Google";
                  id: "deep-research-pro-preview-12-2025";
                  label: "Deep Research Preview";
                  values: {
                      agent: {
                          displayValue: "deep-research-pro-preview-12-2025";
                          kind: "object";
                          properties: {
                              key: { kind: "primitive"; value: "agent" };
                              value: {
                                  kind: "primitive";
                                  value: "deep-research-pro-preview-12-2025";
                              };
                          };
                      };
                  };
              },
          ];
          modelValueTypes: {
              agent: { description: "Agents"; label: "Agents" };
              model: { description: "Models"; label: "Models" };
          };
      },
  >

getModelParameters

• getModelParameters(rootDir: string): PropDefinition[]

  Returns the list of model parameters that can be edited in the playground UI for projects rooted at rootDir. Typically extracted from the SDK's published TypeScript type definitions.

  Parameters

  • rootDir: string

    Absolute path to the project root.

  Returns PropDefinition[]

normalizePrompt

• normalizePrompt(prompt: ParsedPrompt): NormalizedPrompt

  Convert a low-level ParsedPrompt produced by a PromptFileType into a NormalizedPrompt that the UI can consume without knowing the SDK's specific property names or message shape.

  Parameters

  • prompt: ParsedPrompt

    The raw parsed prompt.

  Returns NormalizedPrompt