xiangxin-sdk 0.1.0__tar.gz

xiangxin_sdk-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+.venv/
+__pycache__/
+*.pyc
+dist/
+.pytest_cache/

xiangxin_sdk-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

xiangxin_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.5
+Name: xiangxin-sdk
+Version: 0.1.0
+Summary: 象信 AI 官方 Python SDK —— 调用象信一号系统一模型（System One API）
+Project-URL: Homepage, https://xiangxinai.cn
+Project-URL: Documentation, https://docs.xiangxinai.cn/sdk/python
+Project-URL: Console, https://console.xiangxinai.cn
+Author-email: 象信AI <wanglei@xiangxinai.cn>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: classification,llm,sdk,system-one,xiangxin
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.6
+Requires-Dist: typing-extensions>=4.7
+Description-Content-Type: text/markdown
+
+# 象信 AI Python SDK
+
+`xiangxin-sdk` 是 [象信 AI](https://xiangxinai.cn) 的官方 Python SDK，用于调用**象信一号**系统一模型。
+
+象信一号不生成文本：你给它一段**状态（state）**和一组**带类型的问题**，它一次前向就返回带校准概率的结构化答案。问题有三种原语：
+
+| 原语 | 用途 | 答案字段 |
+|---|---|---|
+| `Noul` | 是非题 | `.noul`：成立的概率 0–1 |
+| `Choice` | 单选题（≤ 255 个选项） | `.choice`、`.probabilities`、`.confidence` |
+| `Score` | 打分题（2–10 档有序量表） | `.score`（期望分）、`.probabilities`、`.legend`、`.confidence` |
+
+- 同步 / 异步两套客户端，接口一致
+- 完整类型标注（`py.typed`），基于 pydantic v2 与 httpx
+- 自动重试（429 / 529 / 5xx，遵守 `retry-after`）、超时、日志
+- 要求 Python ≥ 3.10
+
+## 安装
+
+```bash
+pip install xiangxin-sdk
+# 或
+uv add xiangxin-sdk
+```
+
+## 快速开始
+
+先在 [控制台](https://console.xiangxinai.cn/keys) 创建 API 密钥，并设置环境变量：
+
+```bash
+export XIANGXIN_API_KEY="sk-xx-..."
+```
+
+```python
+from xiangxin import Choice, Noul, Score, XiangxinClient
+
+client = XiangxinClient()  # 自动读取 XIANGXIN_API_KEY
+
+resp = client.system_one(
+    state="我这个月被重复扣费了两次，客服三天都没回复，请尽快处理！",
+    questions={
+        "is_urgent": Noul(instructions="这张工单是否需要当天处理？"),
+        "department": Choice(
+            instructions="应分派到哪个部门？",
+            criteria={
+                "billing": "扣费、发票、退款",
+                "technical": "报错、故障、无法登录",
+                "sales": "购买咨询、套餐升级",
+            },
+        ),
+        "frustration": Score(
+            instructions="用户的情绪有多激动？",
+            criteria=["平静", "不满", "非常愤怒"],
+        ),
+    },
+)
+
+print(resp.answers["is_urgent"].noul)          # 0.95
+print(resp.answers["department"].choice)       # "billing"
+print(resp.answers["department"].confidence)   # 0.81
+print(resp.answers["frustration"].score)       # 1.05
+print(resp.usage.input_tokens, resp.model)     # 296 xiangxin-1.0.0
+```
+
+也可以按类型分组读取：`resp.nouls`、`resp.choices`、`resp.scores`。
+
+### 用字典写问题
+
+问题对象与普通字典完全等价，可以混用：
+
+```python
+client.system_one(
+    state={"标题": "无法登录", "正文": "输入验证码后一直转圈"},
+    questions={
+        "is_bug": {"type": "noul", "instructions": "这是产品缺陷吗？"},
+        "severity": Score(instructions="严重程度", criteria=["轻微", "一般", "严重"]),
+    },
+)
+```
+
+`state`、`instructions` 以及各选项的描述都可以是文本、JSON 对象或数组。
+
+### 异步客户端
+
+```python
+import asyncio
+from xiangxin import AsyncXiangxinClient, Noul
+
+async def main() -> None:
+    async with AsyncXiangxinClient() as client:
+        resp = await client.system_one(
+            state="这家店的发货速度太慢了",
+            questions={"negative": Noul(instructions="这是负面评价吗？")},
+        )
+        print(resp.answers["negative"].noul)
+
+asyncio.run(main())
+```
+
+### 带类型的响应模型
+
+继承 `SystemOneResponse`，声明与问题同名的字段，即可获得类型检查与补全：
+
+```python
+from xiangxin import ChoiceAnswer, NoulAnswer, SystemOneResponse
+
+class Ticket(SystemOneResponse):
+    is_urgent: NoulAnswer
+    department: ChoiceAnswer
+
+t = client.system_one(state, questions, response_model=Ticket)
+t.is_urgent.noul, t.department.choice
+```
+
+## 模型
+
+```python
+for m in client.models.list().models:
+    print(m.name, m.description, m.release_date)
+```
+
+默认模型为 `xiangxin-latest`。可在创建客户端时指定 `model=`，或在单次调用时传入 `model=` 覆盖。
+
+## 读取响应头与原始响应
+
+```python
+resp = client.system_one(state, questions)
+resp.request_id          # x-request-id
+resp.model_ms            # 模型耗时（毫秒）
+resp.total_ms            # 总耗时（毫秒）
+resp.raw_http_response   # httpx.Response
+
+raw = client.with_raw_response.system_one(state, questions)
+raw.status_code, raw.headers["x-xiangxin-model-ms"]
+resp = raw.parse()
+```
+
+## 错误处理
+
+所有异常都继承自 `XiangxinError`：
+
+| 异常 | 状态码 | 场景 |
+|---|---|---|
+| `AuthenticationError` | 401 | API 密钥缺失、无效或已禁用 |
+| `InsufficientBalanceError` | 402 | 余额不足，请到控制台充值 |
+| `NotFoundError` | 404 | 模型不存在 |
+| `UnprocessableEntityError` | 422 | 请求校验失败（选项过多、超出 token 上限等） |
+| `RateLimitError` | 429 | 超出速率限制（`.retry_after` 为建议等待秒数） |
+| `OverloadedError` | 529 | 服务过载，稍后重试 |
+| `InternalServerError` | 其他 5xx | 服务端错误 |
+| `APIConnectionError` / `APITimeoutError` | — | 网络错误 / 超时 |
+
+```python
+from xiangxin import APIError, InsufficientBalanceError
+
+try:
+    client.system_one(state, questions)
+except InsufficientBalanceError:
+    print("余额不足，请充值")
+except APIError as e:
+    print(e.status_code, e.detail, e.request_id)
+```
+
+## 重试与超时
+
+默认对 429、529、500、502、503、504 以及连接错误 / 超时重试 2 次，指数退避加抖动；服务端返回 `retry-after` 时按其等待。422 等客户端错误不会重试。
+
+```python
+from xiangxin import RetryPolicy, XiangxinClient
+
+client = XiangxinClient(
+    timeout=10.0,                                   # 单次 HTTP 超时（秒），默认 30
+    retry=RetryPolicy(max_retries=4, backoff_max=4.0),
+)
+client.system_one(state, questions, retry=RetryPolicy(max_retries=0), timeout=5.0)  # 单次覆盖
+```
+
+## 日志
+
+SDK 使用名为 `xiangxin` 的 logger。`info` 级别每个请求输出一行摘要，`debug` 级别额外输出请求 / 响应头与正文（`Authorization` 等敏感头会被隐去，正文不会）。
+
+```python
+import logging
+logging.getLogger("xiangxin").setLevel(logging.INFO)
+```
+
+或在导入 SDK 前设置 `XIANGXIN_LOG=debug|info|warning|error|off`。
+
+## 环境变量
+
+| 变量 | 作用 | 默认值 |
+|---|---|---|
+| `XIANGXIN_API_KEY` | API 密钥（必填） | — |
+| `XIANGXIN_BASE_URL` | API 根地址 | `https://api.xiangxinai.cn` |
+| `XIANGXIN_DEFAULT_MODEL` | 默认模型 | `xiangxin-latest` |
+| `XIANGXIN_LOG` | 日志级别 | 不设置 |
+
+显式传入的参数优先于环境变量。
+
+## 开发
+
+```bash
+uv sync
+uv run pytest
+```
+
+更多文档见 <https://docs.xiangxinai.cn>。

xiangxin_sdk-0.1.0/README.md

@@ -0,0 +1,207 @@
+# 象信 AI Python SDK
+
+`xiangxin-sdk` 是 [象信 AI](https://xiangxinai.cn) 的官方 Python SDK，用于调用**象信一号**系统一模型。
+
+象信一号不生成文本：你给它一段**状态（state）**和一组**带类型的问题**，它一次前向就返回带校准概率的结构化答案。问题有三种原语：
+
+| 原语 | 用途 | 答案字段 |
+|---|---|---|
+| `Noul` | 是非题 | `.noul`：成立的概率 0–1 |
+| `Choice` | 单选题（≤ 255 个选项） | `.choice`、`.probabilities`、`.confidence` |
+| `Score` | 打分题（2–10 档有序量表） | `.score`（期望分）、`.probabilities`、`.legend`、`.confidence` |
+
+- 同步 / 异步两套客户端，接口一致
+- 完整类型标注（`py.typed`），基于 pydantic v2 与 httpx
+- 自动重试（429 / 529 / 5xx，遵守 `retry-after`）、超时、日志
+- 要求 Python ≥ 3.10
+
+## 安装
+
+```bash
+pip install xiangxin-sdk
+# 或
+uv add xiangxin-sdk
+```
+
+## 快速开始
+
+先在 [控制台](https://console.xiangxinai.cn/keys) 创建 API 密钥，并设置环境变量：
+
+```bash
+export XIANGXIN_API_KEY="sk-xx-..."
+```
+
+```python
+from xiangxin import Choice, Noul, Score, XiangxinClient
+
+client = XiangxinClient()  # 自动读取 XIANGXIN_API_KEY
+
+resp = client.system_one(
+    state="我这个月被重复扣费了两次，客服三天都没回复，请尽快处理！",
+    questions={
+        "is_urgent": Noul(instructions="这张工单是否需要当天处理？"),
+        "department": Choice(
+            instructions="应分派到哪个部门？",
+            criteria={
+                "billing": "扣费、发票、退款",
+                "technical": "报错、故障、无法登录",
+                "sales": "购买咨询、套餐升级",
+            },
+        ),
+        "frustration": Score(
+            instructions="用户的情绪有多激动？",
+            criteria=["平静", "不满", "非常愤怒"],
+        ),
+    },
+)
+
+print(resp.answers["is_urgent"].noul)          # 0.95
+print(resp.answers["department"].choice)       # "billing"
+print(resp.answers["department"].confidence)   # 0.81
+print(resp.answers["frustration"].score)       # 1.05
+print(resp.usage.input_tokens, resp.model)     # 296 xiangxin-1.0.0
+```
+
+也可以按类型分组读取：`resp.nouls`、`resp.choices`、`resp.scores`。
+
+### 用字典写问题
+
+问题对象与普通字典完全等价，可以混用：
+
+```python
+client.system_one(
+    state={"标题": "无法登录", "正文": "输入验证码后一直转圈"},
+    questions={
+        "is_bug": {"type": "noul", "instructions": "这是产品缺陷吗？"},
+        "severity": Score(instructions="严重程度", criteria=["轻微", "一般", "严重"]),
+    },
+)
+```
+
+`state`、`instructions` 以及各选项的描述都可以是文本、JSON 对象或数组。
+
+### 异步客户端
+
+```python
+import asyncio
+from xiangxin import AsyncXiangxinClient, Noul
+
+async def main() -> None:
+    async with AsyncXiangxinClient() as client:
+        resp = await client.system_one(
+            state="这家店的发货速度太慢了",
+            questions={"negative": Noul(instructions="这是负面评价吗？")},
+        )
+        print(resp.answers["negative"].noul)
+
+asyncio.run(main())
+```
+
+### 带类型的响应模型
+
+继承 `SystemOneResponse`，声明与问题同名的字段，即可获得类型检查与补全：
+
+```python
+from xiangxin import ChoiceAnswer, NoulAnswer, SystemOneResponse
+
+class Ticket(SystemOneResponse):
+    is_urgent: NoulAnswer
+    department: ChoiceAnswer
+
+t = client.system_one(state, questions, response_model=Ticket)
+t.is_urgent.noul, t.department.choice
+```
+
+## 模型
+
+```python
+for m in client.models.list().models:
+    print(m.name, m.description, m.release_date)
+```
+
+默认模型为 `xiangxin-latest`。可在创建客户端时指定 `model=`，或在单次调用时传入 `model=` 覆盖。
+
+## 读取响应头与原始响应
+
+```python
+resp = client.system_one(state, questions)
+resp.request_id          # x-request-id
+resp.model_ms            # 模型耗时（毫秒）
+resp.total_ms            # 总耗时（毫秒）
+resp.raw_http_response   # httpx.Response
+
+raw = client.with_raw_response.system_one(state, questions)
+raw.status_code, raw.headers["x-xiangxin-model-ms"]
+resp = raw.parse()
+```
+
+## 错误处理
+
+所有异常都继承自 `XiangxinError`：
+
+| 异常 | 状态码 | 场景 |
+|---|---|---|
+| `AuthenticationError` | 401 | API 密钥缺失、无效或已禁用 |
+| `InsufficientBalanceError` | 402 | 余额不足，请到控制台充值 |
+| `NotFoundError` | 404 | 模型不存在 |
+| `UnprocessableEntityError` | 422 | 请求校验失败（选项过多、超出 token 上限等） |
+| `RateLimitError` | 429 | 超出速率限制（`.retry_after` 为建议等待秒数） |
+| `OverloadedError` | 529 | 服务过载，稍后重试 |
+| `InternalServerError` | 其他 5xx | 服务端错误 |
+| `APIConnectionError` / `APITimeoutError` | — | 网络错误 / 超时 |
+
+```python
+from xiangxin import APIError, InsufficientBalanceError
+
+try:
+    client.system_one(state, questions)
+except InsufficientBalanceError:
+    print("余额不足，请充值")
+except APIError as e:
+    print(e.status_code, e.detail, e.request_id)
+```
+
+## 重试与超时
+
+默认对 429、529、500、502、503、504 以及连接错误 / 超时重试 2 次，指数退避加抖动；服务端返回 `retry-after` 时按其等待。422 等客户端错误不会重试。
+
+```python
+from xiangxin import RetryPolicy, XiangxinClient
+
+client = XiangxinClient(
+    timeout=10.0,                                   # 单次 HTTP 超时（秒），默认 30
+    retry=RetryPolicy(max_retries=4, backoff_max=4.0),
+)
+client.system_one(state, questions, retry=RetryPolicy(max_retries=0), timeout=5.0)  # 单次覆盖
+```
+
+## 日志
+
+SDK 使用名为 `xiangxin` 的 logger。`info` 级别每个请求输出一行摘要，`debug` 级别额外输出请求 / 响应头与正文（`Authorization` 等敏感头会被隐去，正文不会）。
+
+```python
+import logging
+logging.getLogger("xiangxin").setLevel(logging.INFO)
+```
+
+或在导入 SDK 前设置 `XIANGXIN_LOG=debug|info|warning|error|off`。
+
+## 环境变量
+
+| 变量 | 作用 | 默认值 |
+|---|---|---|
+| `XIANGXIN_API_KEY` | API 密钥（必填） | — |
+| `XIANGXIN_BASE_URL` | API 根地址 | `https://api.xiangxinai.cn` |
+| `XIANGXIN_DEFAULT_MODEL` | 默认模型 | `xiangxin-latest` |
+| `XIANGXIN_LOG` | 日志级别 | 不设置 |
+
+显式传入的参数优先于环境变量。
+
+## 开发
+
+```bash
+uv sync
+uv run pytest
+```
+
+更多文档见 <https://docs.xiangxinai.cn>。