Document streaming methods in protobuf.

This commit is contained in:
2023-04-23 14:28:20 -07:00
parent b063d91b1e
commit d24d299a7d

View File

@ -270,12 +270,28 @@ message GenerateImagesResponse {
repeated uint32 seeds = 2; repeated uint32 seeds = 2;
} }
/**
* Represents a progress update for an image generation batch.
*/
message GenerateImagesBatchProgressUpdate { message GenerateImagesBatchProgressUpdate {
/**
* The percentage of this batch that is complete.
*/
float percentage_complete = 1; float percentage_complete = 1;
} }
/**
* Represents a completion of an image generation batch.
*/
message GenerateImagesBatchCompletedUpdate { message GenerateImagesBatchCompletedUpdate {
/**
* The generated images from this batch.
*/
repeated Image images = 1; repeated Image images = 1;
/**
* The seed for this batch.
*/
uint32 seed = 2; uint32 seed = 2;
} }
@ -283,10 +299,23 @@ message GenerateImagesBatchCompletedUpdate {
* Represents a continuous update from an image generation stream. * Represents a continuous update from an image generation stream.
*/ */
message GenerateImagesStreamUpdate { message GenerateImagesStreamUpdate {
/**
* The current batch number that is processing.
*/
uint32 current_batch = 1; uint32 current_batch = 1;
/**
* An update to the image generation pipeline.
*/
oneof update { oneof update {
/**
* Batch progress update.
*/
GenerateImagesBatchProgressUpdate batch_progress = 2; GenerateImagesBatchProgressUpdate batch_progress = 2;
/**
* Batch completion update.
*/
GenerateImagesBatchCompletedUpdate batch_completed = 3; GenerateImagesBatchCompletedUpdate batch_completed = 3;
} }
@ -302,5 +331,8 @@ service ImageGenerationService {
*/ */
rpc GenerateImages(GenerateImagesRequest) returns (GenerateImagesResponse); rpc GenerateImages(GenerateImagesRequest) returns (GenerateImagesResponse);
/**
* Generates images using a loaded model, providing updates along the way.
*/
rpc GenerateImagesStreaming(GenerateImagesRequest) returns (stream GenerateImagesStreamUpdate); rpc GenerateImagesStreaming(GenerateImagesRequest) returns (stream GenerateImagesStreamUpdate);
} }