Class GoogleAI

Script integration with Google's Gemini AI API. This object offers convenience over direct HTTP requests by:

  • Integrating with Drafts Credentials system to store your API key.
  • Handling request authorization headers for requests
  • Parsing results to JSON
  • Providing several convenience functions that wrap more complex API calls into simple requests.

NOTE: Drafts does not provide an API Key for use with Google Gemini. To use Google AI features, you will have to setup your own API Key for use with Drafts in the Google AI Studio.

Example

Translation

// build prompt
const targetLanguage = "Spanish"
const text = "Where is the library?"
const chatPrompt = `Translate the following text into ${targetLanguage}: "${text}"`

// create API object and use single response
// convenience function to send prompt
let ai = new GoogleAI()
let answer = ai.quickPrompt(chatPrompt)

// answer == "¿Dónde está la biblioteca?"

Hierarchy

  • GoogleAI

Convenience

quickPrompt

Options

credentialIdentifier?

Other

constructor timeout request create

Convenience

quickPrompt

  • Submit a single text prompt to Google Gemini, and return only the message generated. Convenience method for single request prompts.

    Parameters

    • prompt: string

      Text prompt to submit

    • Optional model: string

    Returns string

Options

Optional credentialIdentifier

credentialIdentifier?: string

Optional identifier for API Key credentials. If an API Key is not provided as a parameter when instantiating the object, the user will be prompted to enter one of the first time they run an action requiring it. By default, these will be stored as Google AI credentials. If you have the need to store multiple API Keys, you can set an alternate identifier for use with the Credential system. Default: Google AI

Other

constructor

  • Create new instance.

    Parameters

    • Optional apiKey: string

    Returns GoogleAI

timeout

timeout: number

Time in seconds to wait for a request to receive a response from the server. Default: 120 seconds.

request

  • Execute a request against the Google Gemini API. For successful requests, the HTTPResponse object will contain an object or array or objects decoded from the JSON returned by Google Gemini as appropriate to the request made. Refer to Google Gemini API documentation for details about the expected parameters and responses.

    Parameters

    • settings: {
          data?: {
              [x: string]: string;
          };
          headers?: {
              [x: string]: string;
          };
          method: string;
          model?: string;
          parameters?: {
              [x: string]: string;
          };
          path: string;
      }
      • Optional data?: {
            [x: string]: string;
        }

        An object containing data to be encoded into the HTTP body of the request. Drafts will take care of the JSON conversion.

        • [x: string]: string
      • Optional headers?: {
            [x: string]: string;
        }

        An object contain key-values to be added as custom headers in the request. There is no need to provide authorization headers, Drafts will add those.

        • [x: string]: string
      • method: string

        The HTTP method, like "GET", "POST", etc.

      • Optional model?: string

        The name of a model available to your API key. Defaults: models/gemini-pro

      • Optional parameters?: {
            [x: string]: string;
        }

        An object containing key-values to be added to the request as URL parameters. Drafts will take care of encoding these.

        • [x: string]: string
      • path: string

        The path to the API endpoint in the Google Gemini API.

    Returns HTTPResponse

Static create

  • Creates a new GoogleAI object.

    Parameters

    • Optional apiKey: string

      A valid Google Gemini API Key. This value is optional, and if not provided, the default Google AI API key stored in Credentials will be used, or the user prompted to provide an API Key to store. Only provide a specific API Key if you desire to override the default.

    Returns OpenAI

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc