外观

象信控制台
API 参考

常量

Python SDK 公开的环境变量名与客户端默认值。

常量 ​

xiangxin.constants ​

公开的环境变量名与客户端默认值。优先级为：构造参数 > 环境变量 > 默认值；值为空或只有空白的环境变量视为未设置。

python
from xiangxin import constants

print(constants.DEFAULT_BASE_URL)   # https://api.xiangxinai.cn

API_KEY_ENV ​

模块属性

python
API_KEY_ENV = 'XIANGXIN_API_KEY'

API 密钥所在的环境变量。未显式传入 api_key 时读取。

BASE_URL_ENV ​

模块属性

python
BASE_URL_ENV = 'XIANGXIN_BASE_URL'

API 根地址所在的环境变量。未显式传入 base_url 时读取。

DEFAULT_MODEL_ENV ​

模块属性

python
DEFAULT_MODEL_ENV = 'XIANGXIN_DEFAULT_MODEL'

默认模型所在的环境变量。未显式传入 model 时读取。

LOG_ENV ​

模块属性

python
LOG_ENV = 'XIANGXIN_LOG'

日志级别所在的环境变量：debug、info、warning、error 或 off。在 import xiangxin 时生效一次。

DEFAULT_BASE_URL ​

模块属性

python
DEFAULT_BASE_URL = 'https://api.xiangxinai.cn'

默认的 API 根地址。

DEFAULT_MODEL ​

模块属性

python
DEFAULT_MODEL = 'xiangxin-latest'

默认模型名。这是一个别名，当前指向 xiangxin-1.0.0，见模型。

DEFAULT_TIMEOUT ​

模块属性

python
DEFAULT_TIMEOUT = 30.0

单次 HTTP 操作的默认超时（秒）。

REQUEST_ID_HEADER ​

模块属性

python
REQUEST_ID_HEADER = 'x-request-id'

携带请求 ID 的响应头，可通过响应或异常的 request_id 属性读取。

MODEL_MS_HEADER ​

模块属性

python
MODEL_MS_HEADER = 'x-xiangxin-model-ms'

携带模型推理耗时（毫秒）的响应头，对应 SystemOneResponse.model_ms。

TOTAL_MS_HEADER ​

模块属性

python
TOTAL_MS_HEADER = 'x-xiangxin-total-ms'

携带网关总耗时（毫秒）的响应头，对应 SystemOneResponse.total_ms。

其他默认值 ​

重试相关的默认值定义在 RetryPolicy 上：默认重试 2 次，可重试状态码为 xiangxin.retries.DEFAULT_RETRY_STATUSES，即 {429, 500, 502, 503, 504, 529}，单次调用总预算 60 秒。

SDK 版本号为 xiangxin.__version__，每个请求都带有 User-Agent: xiangxin-python/<版本号>。