Skip to content

feat: support configurable safety_settings on ChatVertexAI #576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pinetops wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: support configurable safety_settings on ChatVertexAI #576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion lib/chat_models/chat_vertex_ai.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,14 @@ defmodule LangChain.ChatModels.ChatVertexAI do
# Refer to `https://hexdocs.pm/req/Req.html#new/1-options` for
# `Req.new` supported set of options.
field :req_config, :map, default: %{}

# The safety settings for the model, specified as a list of maps. Each map
# should contain a `category` and a `threshold` for that category.
# e.g. [%{"category" => "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold" => "BLOCK_ONLY_HIGH"}]
# see https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/configure-safety-filters
# for the list of categories and thresholds. Defaults to `[]` (the
# provider's own defaults apply).
field :safety_settings, {:array, :map}, default: []
end

@type t :: %ChatVertexAI{}
Expand All @@ -132,7 +140,8 @@ defmodule LangChain.ChatModels.ChatVertexAI do
:json_response,
:json_schema,
:stream,
:req_config
:req_config,
:safety_settings
]
@required_fields [
:endpoint,
Expand Down Expand Up @@ -209,6 +218,7 @@ defmodule LangChain.ChatModels.ChatVertexAI do
"generationConfig" => generation_config_params
}
|> Utils.conditionally_add_to_map("system_instruction", for_api(sys_instructions))
|> Utils.conditionally_add_to_map("safetySettings", vertex_ai.safety_settings)

if functions && not Enum.empty?(functions) do
req
Expand Down
23 changes: 23 additions & 0 deletions test/chat_models/chat_vertex_ai_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,29 @@ defmodule ChatModels.ChatVertexAITest do
assert %{"temperature" => 1.0, "topK" => 1.0, "topP" => 1.0} = config
end

test "adds safety settings to the request if present" do
settings = [
%{"category" => "HARM_CATEGORY_DANGEROUS_CONTENT", "threshold" => "BLOCK_ONLY_HIGH"}
]

vertex_ai =
ChatVertexAI.new!(%{
model: @test_model,
endpoint: "http://localhost:1234/",
safety_settings: settings
})

data = ChatVertexAI.for_api(vertex_ai, [], [])
assert %{"safetySettings" => ^settings} = data
end

test "does not add safety settings to the request when the list is empty", %{
vertex_ai: vertex_ai
} do
data = ChatVertexAI.for_api(vertex_ai, [], [])
refute Map.has_key?(data, "safetySettings")
end

test "generate a map containing a text, inline image, and image url parts", %{
vertex_ai: google_ai
} do
Expand Down