Class LlmRequest

LLM request class that allows passing in tools, output schema and system instructions to the model.

Attributes: model: The model name. contents: The contents to send to the model. config: Additional config for the generate content request. toolsDict: The tools dictionary.

Constructors

constructor

Properties

model? contents config? cacheConfig? cacheMetadata? cacheableContentsTokenCount? liveConnectConfig toolsDict

Methods

appendInstructions appendTools setOutputSchema getSystemInstructionText extractTextFromContent

Constructors

constructor

  • new LlmRequest(data?): LlmRequest

  • Parameters

    • Optionaldata: {
          model?: string;
          contents?: Content[];
          config?: GenerateContentConfig;
          liveConnectConfig?: LiveConnectConfig;
          toolsDict?: Record<string, BaseTool>;
          cacheConfig?: ContextCacheConfig;
          cacheMetadata?: CacheMetadata;
          cacheableContentsTokenCount?: number;
      }
      • Optionalmodel?: string
      • Optionalcontents?: Content[]
      • Optionalconfig?: GenerateContentConfig
      • OptionalliveConnectConfig?: LiveConnectConfig
      • OptionaltoolsDict?: Record<string, BaseTool>
      • OptionalcacheConfig?: ContextCacheConfig
      • OptionalcacheMetadata?: CacheMetadata
      • OptionalcacheableContentsTokenCount?: number

    Returns LlmRequest

Properties

Optionalmodel

model?: string

The model name.

contents

contents: Content[]

The contents to send to the model.

Optionalconfig

config?: GenerateContentConfig

Additional config for the generate content request. Tools in generate_content_config should not be set.

OptionalcacheConfig

cacheConfig?: ContextCacheConfig

Context cache config for the request.

OptionalcacheMetadata

cacheMetadata?: CacheMetadata

Cache metadata from previous requests, used for cache management.

OptionalcacheableContentsTokenCount

cacheableContentsTokenCount?: number

Token count from previous request's prompt, used for cache size validation.

liveConnectConfig

liveConnectConfig: LiveConnectConfig

Live connect config for the request.

toolsDict

toolsDict: Record<string, BaseTool>

The tools dictionary.

Methods

appendInstructions

  • appendInstructions(instructions): void

  • Appends instructions to the system instruction.

    Parameters

    • instructions: string[]

      The instructions to append.

    Returns void

appendTools

setOutputSchema

getSystemInstructionText

  • getSystemInstructionText(): string

  • Extracts the system instruction as plain text from Content or string. System instructions can be either string or Content type.

    Returns string

    The system instruction as a string, or undefined if not set.

StaticextractTextFromContent

  • extractTextFromContent(content): string

  • Extracts text content from a Content object. Used for extracting text from message contents.

    Parameters

    • content: any

      The Content object to extract text from.

    Returns string

    The extracted text as a string.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods