View Source LangChain.ChatModels.ChatVertexAI (LangChain v0.3.0-rc.0)

Parses and validates inputs for making a request for the Google AI Chat API.

Converts response into more specialized LangChain data structures.

Summary

Functions

Calls the Google AI API passing the ChatVertexAI struct with configuration, plus either a simple message or the list of messages to act as the prompt.

complete_final_delta(data)

do_process_response(response, message_type \\ Message)

for_api(vertex_ai, messages, functions)

get_message_contents(message)

Return the content parts for the message.

new(attrs \\ %{})

Setup a ChatVertexAI client configuration.

new!(attrs \\ %{})

Setup a ChatVertexAI client configuration and return it or raise an error if invalid.

restore_from_map(data)

Restores the model from the config.

serialize_config(model)

Generate a config map that can later restore the model's configuration.

Types

t()

@type t() :: %LangChain.ChatModels.ChatVertexAI{
  api_key: term(),
  callbacks: term(),
  endpoint: term(),
  json_response: term(),
  model: term(),
  receive_timeout: term(),
  stream: term(),
  temperature: term(),
  top_k: term(),
  top_p: term()
}

Functions

call(openai, prompt, tools \\ [])

Calls the Google AI API passing the ChatVertexAI struct with configuration, plus either a simple message or the list of messages to act as the prompt.

Optionally pass in a list of tools available to the LLM for requesting execution in response.

NOTE: This function can be used directly, but the primary interface should be through LangChain.Chains.LLMChain. The ChatVertexAI module is more focused on translating the LangChain data structures to and from the OpenAI API.

Another benefit of using LangChain.Chains.LLMChain is that it combines the storage of messages, adding tools, adding custom context that should be passed to tools, and automatically applying LangChain.MessageDelta structs as they are are received, then converting those to the full LangChain.Message once fully complete.

complete_final_delta(data)

do_process_response(response, message_type \\ Message)

for_api(vertex_ai, messages, functions)

get_message_contents(message)

@spec get_message_contents(LangChain.MessageDelta.t() | LangChain.Message.t()) :: [
  %{required(String.t()) => any()}
]

Return the content parts for the message.

new(attrs \\ %{})

@spec new(attrs :: map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Setup a ChatVertexAI client configuration.

new!(attrs \\ %{})

@spec new!(attrs :: map()) :: t() | no_return()

Setup a ChatVertexAI client configuration and return it or raise an error if invalid.

restore_from_map(data)

Restores the model from the config.

serialize_config(model)

@spec serialize_config(t()) :: %{required(String.t()) => any()}

Generate a config map that can later restore the model's configuration.