Package bg.codexio.ai.openai.api.sdk.images
package bg.codexio.ai.openai.api.sdk.images
-
ClassDescriptionActionTypeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>A stage to choose the Images related action desired Current version includes following possibilities: Creating images Editing images Generating images variationsAIModelStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,
E extends RuntimeSelectionStage> A stage to choose a model supported by /v1/chat/completions model endpoint compatibility .AsyncApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Reactive API to add a final instruction and proceed with the HTTP call.AsyncExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Promise abstraction.ChoicesStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the number of the images generated.Explicit marker action type stage for flows where only creating is possible
E.g.Dalle2SizeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the dimensions of the image generated supported by dall-e-2Dalle3SizeStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the dimensions of the image generated supported by dall-e-3An internal executor used to handle the files downloadExplicit marker action type stage for flows where only editing is possible
E.g.EditingMaskStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to specify the editable areas of the image.FormatStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the format of the response imagesImageConfigurationStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Base for all Image stagesImages<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Entrypoint for Images API, supporting Creating, Editing/a>, and Variating.
The interaction starts by configuring the HTTP connection
either by providing a preconfigured http client -CreateImageHttpExecutor,EditImageHttpExecutorandImageVariationHttpExecutorrespectively,
HttpExecutorContext,SdkAuthor leave it toImages.defaults().ImagesPromptStage<E extends RuntimeExecutor>ImagesTerminalStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> Marker stage for finishing the configurations of the prompt.PromptfulImagesRuntimeSelectionStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Configures how the HTTP client to act.PromptlessImagesRuntimeSelectionStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Configures how the HTTP client to act.QualityStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the quality of the images generated.ReactiveApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Reactive API to add a final instruction and proceed with the HTTP call.ReactiveExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Reactive context to choose if the response image should be automatically downloaded or just delivered.SimplifiedStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A simplified stage where some things such as AI Model Type and creativity are already configured.StyleStage<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest,E extends RuntimeSelectionStage> A stage to choose the style of the images generated.SynchronousApi<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Synchronous API to add a final instruction and proceed with the HTTP call.SynchronousExecutor<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>Synchronous context to choose between raw response, just a simple string answer, or an image downloadExplicit marker action type stage for flows where only creating variations is possible
E.g.