Foundation Models Image Generation API, gRPC: ImageGenerationAsyncService.Generate
A method for generating an image based on a textual description.
gRPC request
rpc Generate (ImageGenerationRequest) returns (operation.Operation)
ImageGenerationRequest
{
"modelUri": "string",
"messages": [
{
"text": "string",
"weight": "double"
}
],
"generationOptions": {
"mimeType": "string",
"seed": "int64",
"aspectRatio": {
"widthRatio": "int64",
"heightRatio": "int64"
}
}
}
Request for the service to generate an image.
For examples of usage, see step-by-step guide.
Field |
Description |
modelUri |
string The model URI to be used for image generation. |
messages[] |
A list of messages representing the context for the image generation model. |
generationOptions |
Image generation options. |
Message
The text descriptions and weights that the model uses to generate an image.
Field |
Description |
text |
string Text describing the image. |
weight |
double Message weight. Negative values indicate negative messages. |
ImageGenerationOptions
Field |
Description |
mimeType |
string The MIME type |
seed |
int64 Seed for image generation. It serves as a starting point for image generation from noise. |
aspectRatio |
Aspect ratio of generated image. |
AspectRatio
Field |
Description |
widthRatio |
int64 Weight of width in image. |
heightRatio |
int64 Weight of height in image. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"image": "bytes",
"modelVersion": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
ImageGenerationResponse
Response containing generated image.
Field |
Description |
image |
bytes The image is serialized as an array of bytes encoded in Base64 |
modelVersion |
string The model version changes with each new releases. |