REST Resource: projects.locations.extensions | Generative AI on Vertex AI

Resource: Extension

extensions are tools for large language models to access external data, run computations, etc.

Fields

name string

Identifier. The resource name of the Extension.

displayName string

Required. The display name of the Extension. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description string

Optional. The description of the Extension.

createTime string (Timestamp format)

Output only. timestamp when this Extension was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Output only. timestamp when this Extension was most recently updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

etag string

Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

manifest object (ExtensionManifest)

Required. Manifest of the Extension.

extensionOperations[] object (ExtensionOperation)

Output only. Supported operations.

runtimeConfig object (RuntimeConfig)

Optional. Runtime config controlling the runtime behavior of this Extension.

toolUseExamples[] object (ToolUseExample)

Optional. Examples to illustrate the usage of the extension as a tool.

privateServiceConnectConfig object (ExtensionPrivateServiceConnectConfig)

Optional. The PrivateServiceConnect config for the extension. If specified, the service endpoints associated with the Extension should be registered with private network access in the provided service Directory.

If the service contains more than one endpoint with a network, the service will arbitrarilty choose one of the endpoints to use for extension execution.

satisfiesPzs boolean

Output only. reserved for future use.

satisfiesPzi boolean

Output only. reserved for future use.

JSON representation

JSON representation
{ "name": string, "displayName": string, "description": string, "createTime": string, "updateTime": string, "etag": string, "manifest": { object (`ExtensionManifest`) }, "extensionOperations": [ { object (`ExtensionOperation`) } ], "runtimeConfig": { object (`RuntimeConfig`) }, "toolUseExamples": [ { object (`ToolUseExample`) } ], "privateServiceConnectConfig": { object (`ExtensionPrivateServiceConnectConfig`) }, "satisfiesPzs": boolean, "satisfiesPzi": boolean }

{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "manifest": {
    object (ExtensionManifest)
  },
  "extensionOperations": [
    {
      object (ExtensionOperation)
    }
  ],
  "runtimeConfig": {
    object (RuntimeConfig)
  },
  "toolUseExamples": [
    {
      object (ToolUseExample)
    }
  ],
  "privateServiceConnectConfig": {
    object (ExtensionPrivateServiceConnectConfig)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}

ExtensionManifest

Manifest spec of an Extension needed for runtime execution.

Fields

name string

Required. Extension name shown to the LLM. The name can be up to 128 characters long.

description string

Required. The natural language description shown to the LLM. It should describe the usage of the extension, and is essential for the LLM to perform reasoning. e.g., if the extension is a data store, you can let the LLM know what data it contains.

apiSpec object (ApiSpec)

Required. Immutable. The API specification shown to the LLM.

authConfig object (AuthConfig)

Required. Immutable. type of auth supported by this extension.

JSON representation
{ "name": string, "description": string, "apiSpec": { object (`ApiSpec`) }, "authConfig": { object (`AuthConfig`) } }

ApiSpec

The API specification shown to the LLM.

Fields

api_spec Union type

api_spec can be only one of the following:

openApiYaml string

The API spec in Open API standard and YAML format.

openApiGcsUri string

Cloud Storage URI pointing to the OpenAPI spec.

JSON representation
{ // api_spec "openApiYaml": string, "openApiGcsUri": string // Union type }

ExtensionOperation

Operation of an extension.

Fields

operationId string

Operation id that uniquely identifies the operations among the extension. See: "Operation Object" in https://swagger.io/specification/.

This field is parsed from the OpenAPI spec. For HTTP extensions, if it does not exist in the spec, we will generate one from the HTTP method and path.

functionDeclaration object (FunctionDeclaration)

Output only. Structured representation of a function declaration as defined by the OpenAPI Spec.

JSON representation
{ "operationId": string, "functionDeclaration": { object (`FunctionDeclaration`) } }

RuntimeConfig

Runtime configuration to run the extension.

Fields

defaultParams object (Struct format)

Optional. Default parameters that will be set for all the execution of this extension. If specified, the parameter values can be overridden by values in [[ExecuteExtensionRequest.operation_params]] at request time.

The struct should be in a form of map with param name as the key and actual param value as the value. E.g. If this operation requires a param "name" to be set to "abc". you can set this to something like {"name": "abc"}.

GoogleFirstPartyExtensionConfig Union type

Runtime configurations for Google first party extensions. GoogleFirstPartyExtensionConfig can be only one of the following:

codeInterpreterRuntimeConfig object (CodeInterpreterRuntimeConfig)

code execution runtime configurations for code interpreter extension.

vertexAiSearchRuntimeConfig object (VertexAISearchRuntimeConfig)

Runtime configuration for Vertex AI Search extension.

JSON representation

JSON representation
{ "defaultParams": { object }, // GoogleFirstPartyExtensionConfig "codeInterpreterRuntimeConfig": { object (`CodeInterpreterRuntimeConfig`) }, "vertexAiSearchRuntimeConfig": { object (`VertexAISearchRuntimeConfig`) } // Union type }

{
  "defaultParams": {
    object
  },

  // GoogleFirstPartyExtensionConfig
  "codeInterpreterRuntimeConfig": {
    object (CodeInterpreterRuntimeConfig)
  },
  "vertexAiSearchRuntimeConfig": {
    object (VertexAISearchRuntimeConfig)
  }
  // Union type
}

CodeInterpreterRuntimeConfig

Fields

fileInputGcsBucket string

Optional. The Cloud Storage bucket for file input of this Extension. If specified, support input from the Cloud Storage bucket. Vertex Extension Custom code service Agent should be granted file reader to this bucket. If not specified, the extension will only accept file contents from request body and reject Cloud Storage file inputs.

fileOutputGcsBucket string

Optional. The Cloud Storage bucket for file output of this Extension. If specified, write all output files to the Cloud Storage bucket. Vertex Extension Custom code service Agent should be granted file writer to this bucket. If not specified, the file content will be output in response body.

JSON representation
{ "fileInputGcsBucket": string, "fileOutputGcsBucket": string }

VertexAISearchRuntimeConfig

Fields

servingConfigName string

Optional. Vertex AI Search serving config name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{servingConfig}

engineId string

Optional. Vertex AI Search engine id. This is used to construct the search request. By setting this engineId, API will construct the serving config using the default value to call search API for the user. The engineId and servingConfigName cannot both be empty at the same time.

JSON representation
{ "servingConfigName": string, "engineId": string }

ToolUseExample

A single example of the tool usage.

Fields

displayName string

Required. The display name for example.

query string

Required. Query that should be routed to this tool.

requestParams object (Struct format)

Request parameters used for executing this tool.

responseParams object (Struct format)

Response parameters generated by this tool.

responseSummary string

Summary of the tool response to the user query.

Target Union type

Target tool to use. Target can be only one of the following:

extensionOperation object (ExtensionOperation)

Extension operation to call.

functionName string

Function name to call.

JSON representation

JSON representation
{ "displayName": string, "query": string, "requestParams": { object }, "responseParams": { object }, "responseSummary": string, // Target "extensionOperation": { object (`ExtensionOperation`) }, "functionName": string // Union type }

{
  "displayName": string,
  "query": string,
  "requestParams": {
    object
  },
  "responseParams": {
    object
  },
  "responseSummary": string,

  // Target
  "extensionOperation": {
    object (ExtensionOperation)
  },
  "functionName": string
  // Union type
}

ExtensionOperation

Identifies one operation of the extension.

Fields

extension string

Resource name of the extension.

operationId string

Required. Operation id of the extension.

JSON representation
{ "extension": string, "operationId": string }

ExtensionPrivateServiceConnectConfig

PrivateExtensionConfig configuration for the extension.

Fields

serviceDirectory string

Required. The service Directory resource name in which the service endpoints associated to the extension are registered. Format: projects/{projectId}/locations/{locationId}/namespaces/{namespace_id}/services/{serviceId}

The Vertex AI Extension service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) should be granted servicedirectory.viewer and servicedirectory.pscAuthorizedService roles on the resource.

JSON representation
{ "serviceDirectory": string }

Methods
`delete`	Deletes an Extension.
`execute`	Executes the request against a given extension.
`get`	Gets an Extension.
`import`	Imports an Extension.
`list`	Lists Extensions in a location.
`patch`	Updates an Extension.
`query`	Queries an extension with a default controller.

REST Resource: projects.locations.extensions
Stay organized with collections Save and categorize content based on your preferences.

Resource: Extension

ExtensionManifest

ApiSpec

ExtensionOperation

RuntimeConfig

CodeInterpreterRuntimeConfig

VertexAISearchRuntimeConfig

ToolUseExample

ExtensionOperation

ExtensionPrivateServiceConnectConfig

Methods

`delete`

`execute`

`get`

`import`

`list`

`patch`

`query`

REST Resource: projects.locations.extensions Stay organized with collections Save and categorize content based on your preferences.

Resource: Extension

ExtensionManifest

ApiSpec

ExtensionOperation

RuntimeConfig

CodeInterpreterRuntimeConfig

VertexAISearchRuntimeConfig

ToolUseExample

ExtensionOperation

ExtensionPrivateServiceConnectConfig

Methods

delete

execute

get

import

list

patch

query

REST Resource: projects.locations.extensions
Stay organized with collections Save and categorize content based on your preferences.

`delete`

`execute`

`get`

`import`

`list`

`patch`

`query`