Skip to content

feat: Support multimodal embedding for Gemini Embedding 2.0 and MaaS models in Models.embed_content() (Vertex AI API) #1165

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

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: Support multimodal embedding for Gemini Embedding 2.0 and MaaS models in Models.embed_content() (Vertex AI API) #1165

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
17 changes: 16 additions & 1 deletion api-report/genai-node.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,13 +948,28 @@ export interface EmbedContentParameters {
model: string;
}

// @public
export interface EmbedContentParametersPrivate {
config?: EmbedContentConfig;
content?: ContentUnion;
contents?: ContentListUnion;
embeddingApiType?: EmbeddingApiType;
model: string;
}

// @public
export class EmbedContentResponse {
embeddings?: ContentEmbedding[];
metadata?: EmbedContentMetadata;
sdkHttpResponse?: HttpResponse;
}

// @public
export enum EmbeddingApiType {
EMBED_CONTENT = "EMBED_CONTENT",
PREDICT = "PREDICT"
}

// @public (undocumented)
export interface EmbeddingsBatchJobSource {
fileName?: string;
Expand Down Expand Up @@ -2520,7 +2535,7 @@ export class Models extends BaseModule {
countTokens(params: types.CountTokensParameters): Promise<types.CountTokensResponse>;
delete(params: types.DeleteModelParameters): Promise<types.DeleteModelResponse>;
editImage: (params: types.EditImageParameters) => Promise<types.EditImageResponse>;
embedContent(params: types.EmbedContentParameters): Promise<types.EmbedContentResponse>;
embedContent: (params: types.EmbedContentParameters) => Promise<types.EmbedContentResponse>;
generateContent: (params: types.GenerateContentParameters) => Promise<types.GenerateContentResponse>;
generateContentStream: (params: types.GenerateContentParameters) => Promise<AsyncGenerator<types.GenerateContentResponse>>;
generateImages: (params: types.GenerateImagesParameters) => Promise<types.GenerateImagesResponse>;
Expand Down
17 changes: 16 additions & 1 deletion api-report/genai-web.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,13 +948,28 @@ export interface EmbedContentParameters {
model: string;
}

// @public
export interface EmbedContentParametersPrivate {
config?: EmbedContentConfig;
content?: ContentUnion;
contents?: ContentListUnion;
embeddingApiType?: EmbeddingApiType;
model: string;
}

// @public
export class EmbedContentResponse {
embeddings?: ContentEmbedding[];
metadata?: EmbedContentMetadata;
sdkHttpResponse?: HttpResponse;
}

// @public
export enum EmbeddingApiType {
EMBED_CONTENT = "EMBED_CONTENT",
PREDICT = "PREDICT"
}

// @public (undocumented)
export interface EmbeddingsBatchJobSource {
fileName?: string;
Expand Down Expand Up @@ -2520,7 +2535,7 @@ export class Models extends BaseModule {
countTokens(params: types.CountTokensParameters): Promise<types.CountTokensResponse>;
delete(params: types.DeleteModelParameters): Promise<types.DeleteModelResponse>;
editImage: (params: types.EditImageParameters) => Promise<types.EditImageResponse>;
embedContent(params: types.EmbedContentParameters): Promise<types.EmbedContentResponse>;
embedContent: (params: types.EmbedContentParameters) => Promise<types.EmbedContentResponse>;
generateContent: (params: types.GenerateContentParameters) => Promise<types.GenerateContentResponse>;
generateContentStream: (params: types.GenerateContentParameters) => Promise<AsyncGenerator<types.GenerateContentResponse>>;
generateImages: (params: types.GenerateImagesParameters) => Promise<types.GenerateImagesResponse>;
Expand Down
17 changes: 16 additions & 1 deletion api-report/genai.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,13 +948,28 @@ export interface EmbedContentParameters {
model: string;
}

// @public
export interface EmbedContentParametersPrivate {
config?: EmbedContentConfig;
content?: ContentUnion;
contents?: ContentListUnion;
embeddingApiType?: EmbeddingApiType;
model: string;
}

// @public
export class EmbedContentResponse {
embeddings?: ContentEmbedding[];
metadata?: EmbedContentMetadata;
sdkHttpResponse?: HttpResponse;
}

// @public
export enum EmbeddingApiType {
EMBED_CONTENT = "EMBED_CONTENT",
PREDICT = "PREDICT"
}

// @public (undocumented)
export interface EmbeddingsBatchJobSource {
fileName?: string;
Expand Down Expand Up @@ -2520,7 +2535,7 @@ export class Models extends BaseModule {
countTokens(params: types.CountTokensParameters): Promise<types.CountTokensResponse>;
delete(params: types.DeleteModelParameters): Promise<types.DeleteModelResponse>;
editImage: (params: types.EditImageParameters) => Promise<types.EditImageResponse>;
embedContent(params: types.EmbedContentParameters): Promise<types.EmbedContentResponse>;
embedContent: (params: types.EmbedContentParameters) => Promise<types.EmbedContentResponse>;
generateContent: (params: types.GenerateContentParameters) => Promise<types.GenerateContentResponse>;
generateContentStream: (params: types.GenerateContentParameters) => Promise<AsyncGenerator<types.GenerateContentResponse>>;
generateImages: (params: types.GenerateImagesParameters) => Promise<types.GenerateImagesResponse>;
Expand Down
23 changes: 21 additions & 2 deletions sdk-samples/embed_content.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,31 @@ async function embedContentFromVertexAI() {
location: GOOGLE_CLOUD_LOCATION,
});

const response = await ai.models.embedContent({
const textResponse = await ai.models.embedContent({
model: 'text-embedding-004',
contents: 'Hello world!',
});

console.debug(JSON.stringify(response));
const multimodalResponse = await ai.models.embedContent({
model: 'gemini-embedding-2-exp-11-2025',
contents: [
{
parts: [
{text: 'Similar things to the following image:'},
{
fileData: {
mimeType: 'image/png',
fileUri:
'gs://cloud-samples-data/generative-ai/image/a-man-and-a-dog.png',
},
},
],
},
],
});

console.debug(JSON.stringify(textResponse));
console.debug(JSON.stringify(multimodalResponse));
}

async function main() {
Expand Down
7 changes: 7 additions & 0 deletions src/_transformers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,3 +983,10 @@ export function tJobState(state: unknown): string {
return stateString;
}
}

export function tIsVertexEmbedContentModel(model: string): boolean {
return (
(model.includes('gemini') && model !== 'gemini-embedding-001') ||
model.includes('maas')
);
}
Loading