Class HttpRequestTool

Tool for making HTTP requests to external APIs and web services

Hierarchy (view full)

BaseTool
- HttpRequestTool

Index

Constructors

constructor

new HttpRequestTool(): HttpRequestTool
Returns HttpRequestTool
Overrides BaseTool.constructor
- Defined in packages/adk/src/tools/common/http-request-tool.ts:17

Properties

name

name: string

Name of the tool

description

description: string

Description of the tool

isLongRunning

isLongRunning: boolean

Whether the tool is a long running operation, which typically returns a resource id first and finishes the operation later.

shouldRetryOnFailure

shouldRetryOnFailure: boolean

Whether the tool execution should be retried on failure

maxRetryAttempts

maxRetryAttempts: number

Maximum retry attempts

baseRetryDelay

baseRetryDelay: number = 1000

Base delay for retry in ms (will be used with exponential backoff)

maxRetryDelay

maxRetryDelay: number = 10000

Maximum delay for retry in ms

`Protected`logger

logger: Logger = ...

Accessors

`Protected`apiVariant

get apiVariant(): ApiVariant
Gets the API variant for this tool

Returns ApiVariant
Inherited from BaseTool.apiVariant
- Defined in packages/adk/src/tools/base/base-tool.ts:230

Methods

validateArguments

validateArguments(args): boolean
Validates the arguments against the schema in the function declaration
Parameters
- args: Record<string, any>
  Arguments to validate
Returns boolean
True if arguments are valid
Inherited from BaseTool.validateArguments
- Defined in packages/adk/src/tools/base/base-tool.ts:129

processLlmRequest

processLlmRequest(_toolContext, llmRequest): Promise<void>
Processes the outgoing LLM request for this tool.

Use cases:
- Most common use case is adding this tool to the LLM request.
- Some tools may just preprocess the LLM request before it's sent out.
Parameters
- _toolContext: ToolContext
- llmRequest: LlmRequest
  The outgoing LLM request, mutable by this method
Returns Promise<void>
Inherited from BaseTool.processLlmRequest
- Defined in packages/adk/src/tools/base/base-tool.ts:179

safeExecute

safeExecute(args, context): Promise<any>
Executes the tool with error handling and retries
Parameters
- args: Record<string, any>
  Arguments for the tool
- context: ToolContext
  Tool execution context
Returns Promise<any>
Result of the tool execution or error information
Inherited from BaseTool.safeExecute
- Defined in packages/adk/src/tools/base/base-tool.ts:242

getDeclaration

getDeclaration(): FunctionDeclaration
Get the function declaration for the tool

Returns FunctionDeclaration
Overrides BaseTool.getDeclaration
- Defined in packages/adk/src/tools/common/http-request-tool.ts:27

runAsync

runAsync(args, _context): Promise<HttpRequestResult>
Execute the HTTP request
Parameters
- args: {
      url: string;
      method?: string;
      headers?: Record<string, string>;
      body?: string;
      params?: Record<string, string>;
      timeout?: number;
  }
  - url: string
  - Optionalmethod?: string
  - Optionalheaders?: Record<string, string>
  - Optionalbody?: string
  - Optionalparams?: Record<string, string>
  - Optionaltimeout?: number
- _context: ToolContext
Returns Promise<HttpRequestResult>
Overrides BaseTool.runAsync
- Defined in packages/adk/src/tools/common/http-request-tool.ts:71

Class HttpRequestTool

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns HttpRequestTool

Properties

name

description

isLongRunning

shouldRetryOnFailure

maxRetryAttempts

baseRetryDelay

maxRetryDelay

Protectedlogger

Accessors

ProtectedapiVariant

Returns ApiVariant

Methods

validateArguments

Parameters

Returns boolean

processLlmRequest

Parameters

Returns Promise<void>

safeExecute

Parameters

Returns Promise<any>

getDeclaration

Returns FunctionDeclaration

runAsync

Parameters

url: string

Optionalmethod?: string

Optionalheaders?: Record<string, string>

Optionalbody?: string

Optionalparams?: Record<string, string>

Optionaltimeout?: number

Returns Promise<HttpRequestResult>

Settings

On This Page

`Protected`logger

`Protected`apiVariant

`Optional`method?: string

`Optional`headers?: Record<string, string>

`Optional`body?: string

`Optional`params?: Record<string, string>

`Optional`timeout?: number