agentscope.credentialOpenAICredential
class OpenAICredential(CredentialBase)agentscope/credential/_openai.py:17–90OpenAI 凭证模型。位于 agentscope.credential 包，继承自 CredentialBase。核心成员包括 get_chat_model_class、get_chat_model_classes、get_embedding_model_class、get_tts_model_classes、get_asr_model_classes、get_realtime_model_classes。
The OpenAI credential model. Declared in agentscope.credential. Extends CredentialBase.
属性摘要Attribute Summary
| 属性Attribute | 类型Type | 说明Description | 值Value |
|---|---|---|---|
model_config | — | 模型配置字段。 | ConfigDict(title='OpenAI API') |
type | Literal['openai_credential'] | 类型字段。 | 'openai_credential' |
api_key | SecretStr | OpenAI API 密钥。 | Field(description='The OpenAI API key.') |
organization | str | None | `organization` 字段。 | Field(default=None, description='The OpenAI organization ID.') |
base_url | str | None | 基类 URL字段。 | Field(default=None, description='The base URL for the OpenAI API. Can be used for OpenAI-compatible endpoints.') |
方法摘要Method Summary
| 方法Method | 说明Description |
|---|---|
def get_chat_model_class() -> Type['ChatModelBase'] | 返回OpenAIChatModel 类。 Return the OpenAIChatModel class. |
def get_chat_model_classes() -> list[Type['ChatModelBase']] | 获取 `get_chat_model_classes`。 Return both APIs unless the legacy getter selects a custom model. |
def get_embedding_model_class() -> Type['EmbeddingModelBase'] | 返回OpenAIEmbeddingModel 类。 Return the OpenAIEmbeddingModel class. |
def get_tts_model_classes() -> list[Type['TTSModelBase']] | 获取 `get_tts_model_classes`。 Return the OpenAI TTS model classes. |
def get_asr_model_classes() -> list[Type['ASRModelBase']] | 获取 `get_asr_model_classes`。 Return the OpenAI transcription implementation. |
def get_realtime_model_classes() -> list[Type['RealtimeModelBase']] | 获取 `get_realtime_model_classes`。 Return the OpenAI realtime model classes. |
属性详情Attribute Detail
model_config
= ConfigDict(title='OpenAI API')模型配置字段。
OpenAI API
agentscope/credential/_openai.py:20type
Literal['openai_credential'] = 'openai_credential'类型字段。声明为 Literal['openai_credential']。
The type field.
agentscope/credential/_openai.py:24api_key
SecretStr = Field(description='The OpenAI API key.')OpenAI API 密钥。
The OpenAI API key.
agentscope/credential/_openai.py:27organization
str | None = Field(default=None, description='The OpenAI organization ID.')organization 字段。声明为 str | None。
The OpenAI organization ID.
agentscope/credential/_openai.py:32base_url
str | None = Field(default=None, description='The base URL for the OpenAI API. Can be used for OpenAI-compatible endpoints.')基类 URL字段。声明为 str | None。
The base URL for the OpenAI API.
agentscope/credential/_openai.py:38方法详情Method Detail
get_chat_model_class
def get_chat_model_class() -> Type['ChatModelBase']返回OpenAIChatModel 类。
Return the OpenAIChatModel class.
agentscope/credential/_openai.py:48–52get_chat_model_classes
def get_chat_model_classes() -> list[Type['ChatModelBase']]获取 get_chat_model_classes。
Return both APIs unless the legacy getter selects a custom model.
agentscope/credential/_openai.py:55–62get_embedding_model_class
def get_embedding_model_class() -> Type['EmbeddingModelBase']返回OpenAIEmbeddingModel 类。
Return the OpenAIEmbeddingModel class.
agentscope/credential/_openai.py:65–69get_tts_model_classes
def get_tts_model_classes() -> list[Type['TTSModelBase']]获取 get_tts_model_classes。
Return the OpenAI TTS model classes.
agentscope/credential/_openai.py:72–76get_asr_model_classes
def get_asr_model_classes() -> list[Type['ASRModelBase']]获取 get_asr_model_classes。
Return the OpenAI transcription implementation.
agentscope/credential/_openai.py:79–83get_realtime_model_classes
def get_realtime_model_classes() -> list[Type['RealtimeModelBase']]获取 get_realtime_model_classes。
Return the OpenAI realtime model classes.
agentscope/credential/_openai.py:86–90