Integration: Google Vertex AI
Use Google Vertex AI Models with Haystack
Table of Contents
Overview
Vertex AI is a machine learning (ML) platform that lets you train and deploy ML models and AI applications, and customize large language models (LLMs) for use in your AI-powered applications. This integration enables the usage of models through Vertex AI API on Google Cloud Platform (GCP).
Haystack supports Gemini API models, PaLM API models, Codey APIs models, and Imagen API models for task such as text generation, function calling, image generation, visual question answering, code generation, and image captioning.
To learn more about the use cases and test Vertex AI models with Haystack, follow this Colab Notebook.
There is an article about Gemini models and how to use them with Haystack: Gemini Models with Google Vertex AI Integration for Haystack
Installation
Install the Google Vertex AI integration:
pip install google-vertex-haystack
Usage
Once installed, you will have access to various Haystack Generators:
-
VertexAIGeminiGenerator: Use this component with Gemini models ‘gemini-pro’ and ‘gemini-1.5-flash’ for text generation and multimodal prompts. -
VertexAIGeminiChatGenerator: Use this component with Gemini models ‘gemini-pro’ and ‘gemini-1.5-flash’ for text generation, multimodal prompts and function calling in chat completion setting. VertexAITextGenerator: Use this component with PaLM models for text generation.VertexAICodeGenerator: Use this component with Codey model for code generation and code completion.VertexAIImageGenerator: Use this component with Imagen model ‘imagegeneration’ for image generation.-
VertexAIImageCaptioner: Use this component with Imagen model ‘imagetext’ for image captioning. VertexAIImageQA: Use this component with Imagen model ‘imagetext’ for visual question answering.
To use Vertex AI models, you need to have a Google Cloud Platform account and be logged in using Application Default Credentials (ADCs). For more info see the official documentation.
To start using Vertex AI generators in Haystack, it is essential that your account has access to a project authorized to use Google Vertex AI endpoints. The project_id needed for initialization of Vertex AI generators is set during GCP authentication mentioned above. Additonally, you can also set a different project_id by passing it as a variable during initialization of the generator.
You can find your project_id in the
GCP resource manager or locally by running gcloud projects list in your terminal. For more info on the gcloud CLI see the
official documentation.
Gemini API models
You can leverage Gemini models through two components: VertexAIGeminiGenerator and VertexAIGeminiChatGenerator. You can use these components on their own or in a pipeline.
Text Generation with gemini-pro
To use Gemini model for text generation, initialize a VertexAIGeminiGenerator with "gemini-pro" and project_id:
from haystack_integrations.components.generators.google_vertex import VertexAIGeminiGenerator
gemini_generator = VertexAIGeminiGenerator(model="gemini-pro")
result = gemini_generator.run(parts = ["What is assemblage in art?"])
print(result["replies"][0])
Output:
Assemblage in art refers to the creation of a three-dimensional artwork by combining various found objects...
Multimodality with gemini-1.5-flash
To use gemini-1.5-flash model for visual question answering, initialize a VertexAIGeminiGenerator with "gemini-1.5-flash". Then, run it with the images as well as the prompt:
import requests
from haystack.dataclasses.byte_stream import ByteStream
URLS = [
"https://raw.githubusercontent.com/silvanocerza/robots/main/robot1.jpg",
"https://raw.githubusercontent.com/silvanocerza/robots/main/robot2.jpg",
"https://raw.githubusercontent.com/silvanocerza/robots/main/robot3.jpg",
"https://raw.githubusercontent.com/silvanocerza/robots/main/robot4.jpg"
]
images = [
ByteStream(data=requests.get(url).content, mime_type="image/jpeg")
for url in URLS
]
gemini_generator = VertexAIGeminiGenerator(model="gemini-1.5-flash")
result = gemini_generator.run(parts = ["What can you tell me about these robots?", *images])
for answer in result["replies"]:
print(answer)
Output:
The first image is of C-3PO and R2-D2 from the Star Wars franchise...
The second image is of Maria from the 1927 film Metropolis...
The third image is of Gort from the 1951 film The Day the Earth Stood Still...
The fourth image is of Marvin from the 1977 film The Hitchhiker's Guide to the Galaxy...
For function calling with gemini-pro, refer to the
Colab Notebook.
PaLM API Models
You can leverage PaLM API models text-bison, text-unicorn and text-bison-32k through VertexAITextGenerator for task generation. To use PaLM models, initialize a VertexAITextGenerator with model name.
Here’a an example of using text-unicorn model with VertexAITextGenerator to extract information as a JSON file:
from haystack_integrations.components.generators.google_vertex import VertexAITextGenerator
palm_llm = VertexAITextGenerator(model="text-unicorn")
palm_llm_result = palm_llm.run(
"""Extract the technical specifications from the text below in a JSON format. Valid fields are name, network, ram, processor, storage, and color.
Text: Google Pixel 7, 5G network, 8GB RAM, Tensor G2 processor, 128GB of storage, Lemongrass
JSON:
""")
print(palm_llm_result["replies"][0])
Codey API Models
You can leverage Codey API models, code-bison, code-bison-32k and code-gecko, through VertexAICodeGenerator for code generation. To use Codey models, initialize a VertexAICodeGenerator with model name.
Here’a an example of using code-bison model for code generation:
from haystack_integrations.components.generators.google_vertex import VertexAICodeGenerator
codey_llm = VertexAICodeGenerator(model="code-bison")
codey_llm_result = codey_llm.run("Write a code for calculating fibonacci numbers in JavaScript")
print(codey_llm_result["replies"][0])
Here’a an example of using code-gecko model for code completion:
from haystack_integrations.components.generators.google_vertex import VertexAICodeGenerator
codey_llm = VertexAICodeGenerator(model="code-gecko")
codey_llm_result = codey_llm.run("""function fibonacci(n) {
// Base cases
if (n <= 1) {
return n;
}
""")
print(codey_llm_result["replies"][0])
Imagen API models
You can leverage Imagen models through three components:
VertexAIImageCaptioner, VertexAIImageGenerator and VertexAIImageQA.
Image Generation with imagegeneration
To generate an image, initialize a VertexAIImageGenerator with the imagegeneration. Then, you can run it with a prompt:
import io
import PIL.Image as Image
from haystack_integrations.components.generators.google_verteximport VertexAIImageGenerator
image_generator = VertexAIImageGenerator(model="imagegeneration")
image_generator_result = image_generator.run("magazine style, 4k, photorealistic, modern red armchair, natural lighting")
## (Optional) Save the generated image
image = Image.open(io.BytesIO(image_generator_result["images"][0].data))
image.save("output.png")
Image Captioning with imagetext
To use generate image captions, initialize a VertexAIImageCaptioner with the imagetext model. Then, you can run the VertexAIImageCaptioner with the image that you want to caption:
from haystack_integrations.components.generators.google_vertex import VertexAIImageCaptioner
image_captioner = VertexAIImageCaptioner(model='imagetext')
image = ByteStream.from_file_path("output.png") # you can use the generated image
image_captioner_result = image_captioner.run(image=image)
print(image_captioner_result["captions"])
Visual Question Answering (VQA) with imagetext
To answer questions about an image, initialize a VertexAIImageQA with the imagetext model. Then, you can run it with the image and the question:
from haystack.dataclasses.byte_stream import ByteStream
from haystack_integrations.components.generators.google_vertex import VertexAIImageQA
visual_qa = VertexAIImageQA(model='imagetext')
image = ByteStream.from_file_path("output.png") # you can use the generated image
question = "what's the color of the furniture?"
visual_qa_result = visual_qa.run(image=image,question=question)
print(visual_qa_result["replies"])