Package bg.codexio.ai.openai.api.sdk.images

Class Images<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>

java.lang.Object

bg.codexio.ai.openai.api.sdk.images.Images<R>

public final class Images<R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest>
extends Object

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, EditImageHttpExecutor and ImageVariationHttpExecutor respectively,
HttpExecutorContext, SdkAuth or leave it to defaults().
Further configuration happens on multiple bypassable stages, whatever is important for specific needs.

Method Summary

Modifier and Type	Method	Description
static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>>	authenticate(HttpExecutorContext context)	Authenticates against OpenAI API with manually supplied ApiCredentials and HttpTimeouts.
static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>>	authenticate(SdkAuth auth)	Authenticates against OpenAI API with an implementation of SdkAuth.
static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>>	defaults()	Authenticates against OpenAPI with the first success from FromEnvironment and FromJson authentication methods.
static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> SimplifiedStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest>>	simply()	Authenticates against OpenAPI with the first success from FromEnvironment and FromJson authentication methods.
static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> SimplifiedStage<R,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest>>	simply(SdkAuth auth)	Authenticates against OpenAI API with an implementation of SdkAuth and preconfigures simple DallE30 powered instance for creating images.
static CreatingActionTypeStage	throughHttp(CreateImageHttpExecutor createExecutor)
static EditingActionTypeStage	throughHttp(EditImageHttpExecutor editExecutor)
static VariatingActionTypeStage	throughHttp(ImageVariationHttpExecutor variationExecutor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

throughHttp

public static CreatingActionTypeStage throughHttp(CreateImageHttpExecutor createExecutor)

Parameters:

createExecutor - Configured CreateImageHttpExecutor with manually set HttpExecutorContext, OkHttpClient and/or ObjectMapper.

Returns:

CreatingActionTypeStage to mark the only possible action in this case - creating

throughHttp

public static EditingActionTypeStage throughHttp(EditImageHttpExecutor editExecutor)

Parameters:

editExecutor - Configured EditImageHttpExecutor with manually set HttpExecutorContext, OkHttpClient and/or ObjectMapper.

Returns:

EditingActionTypeStage to mark the only possible action - editing in this case

throughHttp

public static VariatingActionTypeStage throughHttp(ImageVariationHttpExecutor variationExecutor)

Parameters:

variationExecutor - Configured ImageVariationHttpExecutor with manually set HttpExecutorContext, OkHttpClient and/or ObjectMapper.

Returns:

VariatingActionTypeStage to to mark the only possible action in this case - variating

authenticate

public static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>> authenticate(HttpExecutorContext context)

Authenticates against OpenAI API with manually supplied
ApiCredentials and HttpTimeouts. Mostly used if credentials
are fetched from external source.

Parameters:

context - HttpExecutorContext

Returns:

HttpBuilder so timeouts can be reconfigured and possibly ObjectMapper is supplied.

authenticate

public static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>> authenticate(SdkAuth auth)

Authenticates against OpenAI API with an implementation of SdkAuth.

Parameters:

auth - of type SdkAuth
Allows you to choose from one of the default authentication methods
Options: FromDeveloper, FromJson, FromEnvironment

Returns:

HttpBuilder so timeouts can be reconfigured and possibly ObjectMapper is supplied.

simply

public static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> SimplifiedStage<R,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest>> simply(SdkAuth auth)

Authenticates against OpenAI API with an implementation of SdkAuth and
preconfigures simple DallE30 powered instance for creating images.

Parameters:

auth - of type SdkAuth
Allows you to choose from one of the default authentication methods
Options: FromDeveloper, FromJson, FromEnvironment

Returns:

ImmediateContextStage

simply

public static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> SimplifiedStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest,PromptfulImagesRuntimeSelectionStage<bg.codexio.ai.openai.api.payload.images.request.CreateImageRequest>> simply()

Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods. Preconfigures simple DallE30 powered instance for creating images.

Returns:

ImmediateContextStage

defaults

public static <R extends bg.codexio.ai.openai.api.payload.images.request.ImageRequest> HttpBuilder<ActionTypeStage<R>> defaults()

Authenticates against OpenAPI with the first success from FromEnvironment and FromJson
authentication methods. All other configurations can be manually customized

Returns:

HttpBuilder so timeouts can be reconfigured and possibly ObjectMapper is supplied.