-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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.
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
feat: Add anthropic image description #1436
base: develop
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,6 +21,7 @@ import fs from "fs"; | |
import gifFrames from "gif-frames"; | ||
import os from "os"; | ||
import path from "path"; | ||
import { resizeImageBuffer } from "./imageUtils"; | ||
|
||
export class ImageDescriptionService | ||
extends Service | ||
|
@@ -97,11 +98,13 @@ export class ImageDescriptionService | |
|
||
if (model === models[ModelProviderName.LLAMALOCAL]) { | ||
await this.initializeLocalModel(); | ||
} else if (model === models[ModelProviderName.ANTHROPIC]) { | ||
this.modelId = "claude-3-haiku-20240307"; | ||
this.device = "cloud"; | ||
} else { | ||
this.modelId = "gpt-4o-mini"; | ||
this.device = "cloud"; | ||
Comment on lines
99
to
106
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The model selection logic lacks a default case for unrecognized models. This could lead to unexpected behavior if a new model is added but not handled. Consider adding a default case that logs an error or throws an exception to ensure that all models are accounted for. |
||
} | ||
|
||
this.initialized = true; | ||
} | ||
|
||
|
@@ -111,7 +114,7 @@ export class ImageDescriptionService | |
"Runtime is required for OpenAI image recognition" | ||
); | ||
} | ||
return this.recognizeWithOpenAI(imageUrl); | ||
return this.recognizeWithCloud(imageUrl); | ||
} | ||
|
||
this.queue.push(imageUrl); | ||
|
@@ -130,7 +133,7 @@ export class ImageDescriptionService | |
}); | ||
} | ||
|
||
private async recognizeWithOpenAI( | ||
private async recognizeWithCloud( | ||
imageUrl: string | ||
): Promise<{ title: string; description: string }> { | ||
const isGif = imageUrl.toLowerCase().endsWith(".gif"); | ||
|
@@ -159,13 +162,16 @@ export class ImageDescriptionService | |
|
||
const prompt = | ||
"Describe this image and give it a title. The first line should be the title, and then a line break, then a detailed description of the image. Respond with the format 'title\ndescription'"; | ||
const text = await this.requestOpenAI( | ||
imageUrl, | ||
imageData, | ||
prompt, | ||
isGif, | ||
true | ||
); | ||
const text = | ||
this.runtime.imageModelProvider === ModelProviderName.ANTHROPIC | ||
? await this.requestAnthropic(imageData, prompt) | ||
: await this.requestOpenAI( | ||
imageUrl, | ||
imageData, | ||
prompt, | ||
isGif, | ||
true | ||
); | ||
|
||
const [title, ...descriptionParts] = text.split("\n"); | ||
return { | ||
|
@@ -218,7 +224,7 @@ export class ImageDescriptionService | |
Authorization: `Bearer ${this.runtime.getSetting("OPENAI_API_KEY")}`, | ||
}, | ||
body: JSON.stringify({ | ||
model: "gpt-4o-mini", | ||
model: this.modelId, | ||
messages: [{ role: "user", content }], | ||
max_tokens: shouldUseBase64 ? 500 : 300, | ||
}), | ||
|
@@ -252,6 +258,78 @@ export class ImageDescriptionService | |
); | ||
} | ||
|
||
private async requestAnthropic( | ||
imageData: Buffer, | ||
prompt: string | ||
): Promise<string> { | ||
for (let attempt = 0; attempt < 3; attempt++) { | ||
try { | ||
const endpoint = | ||
models[this.runtime.imageModelProvider].endpoint ?? | ||
"https://api.anthropic.com/v1"; | ||
|
||
// Resize image to 400x400 max, keeping the token count ~ 213 | ||
const resizedImage = await resizeImageBuffer( | ||
imageData, | ||
400, | ||
400 | ||
Comment on lines
+273
to
+275
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You should be able to configure the dimensions of this can we pass that in as a param |
||
); | ||
|
||
const response = await fetch(endpoint + "/messages", { | ||
method: "POST", | ||
headers: { | ||
"Content-Type": "application/json", | ||
"x-api-key": `${this.runtime.getSetting("ANTHROPIC_API_KEY")}`, | ||
"anthropic-version": "2023-06-01", | ||
}, | ||
body: JSON.stringify({ | ||
model: this.modelId, | ||
max_tokens: 300, | ||
messages: [ | ||
{ | ||
role: "user", | ||
content: [ | ||
{ | ||
type: "image", | ||
source: { | ||
type: "base64", | ||
media_type: resizedImage.mimeType, | ||
data: resizedImage.buffer.toString( | ||
"base64" | ||
), | ||
}, | ||
}, | ||
{ | ||
type: "text", | ||
text: prompt, | ||
}, | ||
], | ||
}, | ||
], | ||
}), | ||
}); | ||
|
||
if (!response.ok) { | ||
throw new Error( | ||
`HTTP error! status: ${await response.text()}` | ||
); | ||
} | ||
|
||
const data = await response.json(); | ||
return data.content[0].text; | ||
} catch (error) { | ||
elizaLogger.error( | ||
`Anthropic request failed (attempt ${attempt + 1}):`, | ||
error | ||
); | ||
if (attempt === 2) throw error; | ||
Comment on lines
+312
to
+325
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Logging the error in the retry mechanism is good, but consider adding more context to the log message, such as the endpoint being called or the parameters used. This will help in debugging issues when they arise. |
||
} | ||
} | ||
throw new Error( | ||
"Failed to recognize image with Anthropic after 3 attempts" | ||
Comment on lines
+261
to
+329
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
); | ||
} | ||
|
||
private async processQueue(): Promise<void> { | ||
if (this.processing || this.queue.length === 0) return; | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
import sharp from "sharp"; | ||
import * as FileType from "file-type/core"; | ||
|
||
interface ImageDimensions { | ||
width: number; | ||
height: number; | ||
} | ||
|
||
interface ProcessedImage { | ||
buffer: Buffer; | ||
mimeType: string; | ||
dimensions: { | ||
original: ImageDimensions; | ||
resized: ImageDimensions; | ||
}; | ||
} | ||
|
||
export async function resizeImageBuffer( | ||
imageBuffer: Buffer, | ||
maxWidth: number, | ||
maxHeight: number | ||
): Promise<ProcessedImage> { | ||
// Detect MIME type | ||
try { | ||
// Detect MIME type | ||
const fileTypeResult = await FileType.fileTypeFromBuffer(imageBuffer); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The method 'fileTypeFromBuffer' is not guaranteed to return a valid result. Consider adding a check for 'fileTypeResult.ext' to ensure the file type is supported before proceeding. |
||
if (!fileTypeResult || !fileTypeResult.mime.startsWith("image/")) { | ||
throw new Error("Invalid image format"); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. please elizaLogger before errors thanks |
||
} | ||
|
||
// Get original image metadata | ||
const metadata = await sharp(imageBuffer).metadata(); | ||
if (!metadata.width || !metadata.height) { | ||
throw new Error("Could not get image dimensions"); | ||
Comment on lines
+32
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The error handling for metadata retrieval is too generic. Consider logging the error or providing more context about the failure to aid in debugging. |
||
} | ||
|
||
// Calculate new dimensions maintaining aspect ratio | ||
let width = metadata.width; | ||
let height = metadata.height; | ||
|
||
if (width > maxWidth) { | ||
height = Math.round((maxWidth * height) / width); | ||
width = maxWidth; | ||
} | ||
|
||
if (height > maxHeight) { | ||
width = Math.round((maxHeight * width) / height); | ||
height = maxHeight; | ||
} | ||
|
||
// Process the image | ||
const resizedBuffer = await sharp(imageBuffer) | ||
.resize(width, height, { | ||
fit: "inside", | ||
withoutEnlargement: true, | ||
}) | ||
.toBuffer(); | ||
Comment on lines
+52
to
+57
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The image processing could lead to performance issues if the input image is large. Consider implementing a size limit check before processing to avoid excessive memory usage. |
||
|
||
return { | ||
buffer: resizedBuffer, | ||
mimeType: fileTypeResult.mime, | ||
dimensions: { | ||
original: { | ||
width: metadata.width, | ||
height: metadata.height, | ||
}, | ||
resized: { | ||
width, | ||
height, | ||
}, | ||
}, | ||
}; | ||
} catch (error) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here |
||
if (error instanceof Error) { | ||
throw new Error(`Image processing failed: ${error.message}`); | ||
} | ||
throw new Error("Image processing failed with unknown error"); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make this a env var and add this hard coded value as a default?