类class io.agentscope.extensions.model.openaiofficial.credential 2.x

OpenAIOfficialCredential

@JsonIgnoreProperties(ignoreUnknown = true) @JsonPropertyOrder({"id", "type", "api_key", "organization", "base_url"}) public final class OpenAIOfficialCredential extends CredentialBase

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:28–127

用于OpenAI 官方 SDK 提供者的凭证。位于 io.agentscope.extensions.model.openaiofficial.credential 包，继承自 CredentialBase。核心成员包括 getType、getApiKey、getOrganization、getBaseUrl、getChatModelClass、toString。

Credential for the OpenAI official SDK provider.

嵌套类摘要Nested Class Summary

类Class	类型Kind	说明Description
`Builder`	类class	构建器，用于构建并配置目标实例。 A class in io.agentscope.extensions.model.openaiofficial.credential that talks to model services and returns generated or embedded output.

字段摘要Field Summary

字段Field	类型Type	说明Description
`TYPE` staticfinal	String	类型字段。 The TYPE field.

方法摘要Method Summary

方法Method	说明Description
`public String getType()`	获取类型。 Returns the type.
`public String getApiKey()`	获取API 键。 Returns the api key.
`public String getOrganization()`	获取 `getOrganization`。 Returns the organization.
`public String getBaseUrl()`	获取基类 URL。 Returns the base url.
`public Class<? extends` `ChatModelBase> getChatModelClass()`	获取聊天模型类。 Returns the chat model class.
`public String toString()`	返回 `toString` 结果。 Returns the to string.
`public static` `Builder builder()` static	返回构建器实例。 Returns the builder.

字段详情Field Detail

TYPE

public static final String TYPE

staticfinal

类型字段。声明为 public static final String TYPE。

The TYPE field.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:32

方法详情Method Detail

getType

public String getType()

获取类型。

Returns the type.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:55–58

getApiKey

public String getApiKey()

获取API 键。

Returns the api key.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:60–63

getOrganization

public String getOrganization()

获取 getOrganization。

Returns the organization.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:65–68

getBaseUrl

public String getBaseUrl()

获取基类 URL。

Returns the base url.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:70–73

getChatModelClass

public Class<? extends ChatModelBase> getChatModelClass()

获取聊天模型类。

Returns the chat model class.

返回Returns Class<? extends ChatModelBase>

返回类。Returns class.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:75–78

toString

public String toString()

返回 toString 结果。

Returns the to string.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:80–89

builder

public static Builder builder()

static

返回构建器实例。

Returns the builder.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/extensions/model/openaiofficial/credential/OpenAIOfficialCredential.java:91–93

嵌套类详情Nested Class Detail

Builder

public static final class Builder

构建器，用于构建并配置目标实例。位于 io.agentscope.extensions.model.openaiofficial.credential 包。核心成员包括 id、apiKey、organization、baseUrl、build。

A class in io.agentscope.extensions.model.openaiofficial.credential that talks to model services and returns generated or embedded output. Declared in io.agentscope.extensions.model.openaiofficial.credential.

继承成员Inherited Members

继承自Methods inherited from CredentialBase

getId, listModels