Class ZhiPuAiImageApi

java.lang.Object

org.springframework.ai.zhipuai.api.ZhiPuAiImageApi

public class ZhiPuAiImageApi
extends Object

ZhiPuAI Image API.

Since:

1.0.0 M1

Author:

Geng Rong

See Also:

• CogView Images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ZhiPuAiImageApi.Data
static enum	ZhiPuAiImageApi.ImageModel	ZhiPuAI Image API model.
static final record	ZhiPuAiImageApi.ZhiPuAiImageRequest
static final record	ZhiPuAiImageApi.ZhiPuAiImageResponse

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_IMAGE_MODEL

Constructor Summary

Constructors

Constructor	Description
ZhiPuAiImageApi(String zhiPuAiToken)	Create a new ZhiPuAI Image api with base URL set to https://open.bigmodel.cn/api/paas.
ZhiPuAiImageApi(String baseUrl, String zhiPuAiToken, org.springframework.web.client.RestClient.Builder restClientBuilder)	Create a new ZhiPuAI Image API with the provided base URL.
ZhiPuAiImageApi(String baseUrl, String zhiPuAiToken, org.springframework.web.client.RestClient.Builder restClientBuilder, org.springframework.web.client.ResponseErrorHandler responseErrorHandler)	Create a new ZhiPuAI Image API with the provided base URL.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<ZhiPuAiImageApi.ZhiPuAiImageResponse>	createImage(ZhiPuAiImageApi.ZhiPuAiImageRequest zhiPuAiImageRequest)

Methods inherited from class Object

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

Field Details

DEFAULT_IMAGE_MODEL

public static final String DEFAULT_IMAGE_MODEL

Constructor Details

ZhiPuAiImageApi

public ZhiPuAiImageApi(String zhiPuAiToken)

Create a new ZhiPuAI Image api with base URL set to https://open.bigmodel.cn/api/paas.

Parameters:

zhiPuAiToken - ZhiPuAI apiKey.

ZhiPuAiImageApi

public ZhiPuAiImageApi(String baseUrl,
 String zhiPuAiToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

Create a new ZhiPuAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the ZhiPuAI API.

zhiPuAiToken - ZhiPuAI apiKey.

restClientBuilder - the rest client builder to use.

ZhiPuAiImageApi

public ZhiPuAiImageApi(String baseUrl,
 String zhiPuAiToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder,
 org.springframework.web.client.ResponseErrorHandler responseErrorHandler)

Create a new ZhiPuAI Image API with the provided base URL.

Parameters:

baseUrl - the base URL for the ZhiPuAI API.

zhiPuAiToken - ZhiPuAI apiKey.

restClientBuilder - the rest client builder to use.

responseErrorHandler - the response error handler to use.

Method Details

createImage

public org.springframework.http.ResponseEntity<ZhiPuAiImageApi.ZhiPuAiImageResponse> createImage(ZhiPuAiImageApi.ZhiPuAiImageRequest zhiPuAiImageRequest)