Skip to content

core[patch]: Fix formatting mustache image templates #5666

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

Merged
merged 4 commits into from
Jun 5, 2024
Merged

core[patch]: Fix formatting mustache image templates #5666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cdfdc2a
core[patch]: Fix formatting mustache image templates
bracesproul Jun 4, 2024
ff4687c
Merge branch 'main' into brace/fix-image-mustache-formatting
bracesproul Jun 4, 2024
2fcefcf
unfocus test
bracesproul Jun 4, 2024
66915fd
fix tests
bracesproul Jun 4, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 27 additions & 5 deletions langchain-core/src/prompts/chat.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,12 @@ import {
ExtractedFStringParams,
} from "./prompt.js";
import { ImagePromptTemplate } from "./image.js";
import { TemplateFormat, parseFString } from "./template.js";
import {
ParsedTemplateNode,
TemplateFormat,
parseFString,
parseMustache,
} from "./template.js";

/**
* Abstract class that serves as a base for creating message prompt
Expand Down Expand Up @@ -495,13 +500,19 @@ class _StringImageMessagePromptTemplate<
} else if (typeof item.text === "string") {
text = item.text ?? "";
}
prompt.push(PromptTemplate.fromTemplate(text));
prompt.push(PromptTemplate.fromTemplate(text, additionalOptions));
} else if (typeof item === "object" && "image_url" in item) {
let imgTemplate = item.image_url ?? "";
let imgTemplateObject: ImagePromptTemplate<InputValues>;
let inputVariables: string[] = [];
if (typeof imgTemplate === "string") {
const parsedTemplate = parseFString(imgTemplate);
let parsedTemplate: ParsedTemplateNode[];
if (additionalOptions?.templateFormat === "mustache") {
parsedTemplate = parseMustache(imgTemplate);
} else {
parsedTemplate = parseFString(imgTemplate);
}

const variables = parsedTemplate.flatMap((item) =>
item.type === "variable" ? [item.name] : []
);
Expand All @@ -524,7 +535,13 @@ class _StringImageMessagePromptTemplate<
});
} else if (typeof imgTemplate === "object") {
if ("url" in imgTemplate) {
const parsedTemplate = parseFString(imgTemplate.url);
let parsedTemplate: ParsedTemplateNode[];
if (additionalOptions?.templateFormat === "mustache") {
parsedTemplate = parseMustache(imgTemplate.url);
} else {
parsedTemplate = parseFString(imgTemplate.url);
}

inputVariables = parsedTemplate.flatMap((item) =>
item.type === "variable" ? [item.name] : []
);
Expand Down Expand Up @@ -913,7 +930,12 @@ export class ChatPromptTemplate<
imageUrl = item.image_url.url;
}

const promptTemplatePlaceholder = PromptTemplate.fromTemplate(imageUrl);
const promptTemplatePlaceholder = PromptTemplate.fromTemplate(
imageUrl,
{
templateFormat: this.templateFormat,
}
);
const formattedUrl = await promptTemplatePlaceholder.format(
inputValues
);
Expand Down
52 changes: 51 additions & 1 deletion langchain-core/src/prompts/tests/chat.mustache.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { test, expect } from "@jest/globals";
import { AIMessage } from "../../messages/ai.js";
import { HumanMessage } from "../../messages/human.js";
import { SystemMessage } from "../../messages/system.js";
import { ChatPromptTemplate } from "../chat.js";
import { ChatPromptTemplate, HumanMessagePromptTemplate } from "../chat.js";

test("Test creating a chat prompt template from role string messages", async () => {
const template = ChatPromptTemplate.fromMessages(
Expand Down Expand Up @@ -67,3 +67,53 @@ test("Ignores f-string inputs input variables with repeats.", async () => {
new HumanMessage("This {bar} is a {foo} test {foo}."),
]);
});

test("Mustache template with image and chat prompts inside one template (fromMessages)", async () => {
const template = ChatPromptTemplate.fromMessages(
[
[
"human",
[
{
type: "image_url",
image_url: "{{image_url}}",
},
{
type: "text",
text: "{{other_var}}",
},
],
],
["human", "hello {{name}}"],
],
{
templateFormat: "mustache",
}
);

expect(template.inputVariables.sort()).toEqual([
"image_url",
"name",
"other_var",
]);
});

test("Mustache image template with nested URL and chat prompts HumanMessagePromptTemplate.fromTemplate", async () => {
const template = HumanMessagePromptTemplate.fromTemplate(
[
{
text: "{{name}}",
},
{
image_url: {
url: "{{image_url}}",
},
},
],
{
templateFormat: "mustache",
}
);

expect(template.inputVariables.sort()).toEqual(["image_url", "name"]);
});