qianfan

library0.4.12.3pypypi✓ verified 88d ago

The Qianfan Python SDK provides a convenient way to interact with Baidu Wenxin Qianfan Large Model Platform. It supports various AI capabilities including chat completion, text completion, embeddings, text-to-image, and more. The library is actively maintained, with frequent releases across Python, Go, and JavaScript, ensuring up-to-date access to Qianfan services.

llm-agents ai-ml aws

pip install qianfan

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · QIANFAN

qianfan

llm-agentspythonv0.4.12.3

Install

10.2s avg

Import

1596ms

Disk

92MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.4.12.3 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 1.662s · 90.9MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 10.2s · import 1.530s · 93MB

92MB installed

● package 92MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ChatCompletion

✓ from qianfan import ChatCompletion

✗ from qianfan.chat import ChatCompletion

Top-level import for core client classes is preferred.

Completion

✓ from qianfan import Completion

Embedding

✓ from qianfan import Embedding

QfMessages

✓ from qianfan import QfMessages

✗ from qianfan import Messages

Use `QfMessages` for defining chat message roles and content, `Messages` might be deprecated or internal in some contexts.

This quickstart demonstrates how to perform a simple chat completion using the `qianfan` SDK. It initializes a `ChatCompletion` client, constructs messages using `QfMessages`, and sends a request to the ERNIE-Bot-4 model. Ensure your `QIANFAN_AK` and `QIANFAN_SK` environment variables are set for authentication.

import os from qianfan import ChatCompletion, QfMessages # Set your Baidu Cloud API Key and Secret Key as environment variables # or pass them directly to the client constructor. # os.environ["QIANFAN_AK"] = "YOUR_AK" # os.environ["QIANFAN_SK"] = "YOUR_SK" ak = os.environ.get("QIANFAN_AK", "") sk = os.environ.get("QIANFAN_SK", "") if not ak or not sk: print("Please set QIANFAN_AK and QIANFAN_SK environment variables.") else: chat_comp = ChatCompletion(ak=ak, sk=sk) messages = [ QfMessages(role="user", content="Hello, how are you?") ] try: response = chat_comp.do( model="ERNIE-Bot-4", # Or another available chat model like 'ERNIE-Bot-turbo' messages=messages, stream=False ) if response and response.result: print(f"Qianfan response: {response.result}") else: print("No valid response from Qianfan.") except Exception as e: print(f"An error occurred: {e}")

Debug

Known issues

gotchaAuthentication requires 'QIANFAN_AK' and 'QIANFAN_SK' environment variables. If these are not set, the SDK client must be initialized by passing `ak` and `sk` keyword arguments directly, otherwise API calls will fail.

fix

Set `QIANFAN_AK` and `QIANFAN_SK` in your environment, or initialize clients like `ChatCompletion(ak="YOUR_AK", sk="YOUR_SK")`.

affects: All versions

breakingAs of v0.4.12.3, the SDK removed the forced lowercase conversion of model names. This means you must now use the exact case-sensitive model names as specified in the Qianfan documentation (e.g., 'ERNIE-Bot-4' instead of 'ernie-bot-4').

fix

Always use the official, case-sensitive model names provided by Qianfan, e.g., `model="ERNIE-Bot-4"`.

affects: >=0.4.12.3

gotchaWhen using streaming (`stream=True`), the `do()` method returns an iterable. You must iterate over the response to receive partial results. Not iterating will result in no output.

fix

Process streaming responses with a loop: `for chunk in chat_comp.do(..., stream=True): print(chunk.result)`.

affects: All versions

gotchaSome error messages from the Qianfan API might be returned in Chinese, which can be challenging for non-Chinese speakers to debug directly. Refer to the official documentation for common error codes.

fix

Translate error messages or consult the Baidu Qianfan API documentation for known error codes and their English descriptions.

affects: All versions

Errors

Common errors & fixes

qianfan.common.exception.APIErrorCode: ErrorCode=2, ErrorMsg=Authentication failed: The Access Key or Secret Key is invalid.

The `QIANFAN_AK` or `QIANFAN_SK` environment variables are missing, incorrect, or not loaded, or `ak`/`sk` were not passed during client initialization.

fix

Verify that `QIANFAN_AK` and `QIANFAN_SK` environment variables are correctly set and valid, or explicitly pass `ak` and `sk` to the client constructor, e.g., `ChatCompletion(ak='YOUR_AK', sk='YOUR_SK')`.

ImportError: cannot import name 'ChatCompletion' from 'qianfan'

This usually means the `qianfan` package is not installed, or you are running an outdated version that doesn't expose `ChatCompletion` at the top level, or there's a typo in the import.

fix

Ensure `qianfan` is installed (`pip install qianfan`) and up-to-date (`pip install --upgrade qianfan`). Verify the import statement for typos, it should be `from qianfan import ChatCompletion`.

qianfan.common.exception.APIErrorCode: ErrorCode=17, ErrorMsg=The provided model name is invalid.

The specified model name is either incorrect, misspelled, not supported by your account, or uses incorrect casing (e.g., 'ernie-bot' instead of 'ERNIE-Bot').

fix

Check the official Qianfan documentation for the exact, case-sensitive names of available models. Ensure the model is enabled for your account. For versions >=0.4.12.3, pay close attention to model name casing.

TypeError: do() got an unexpected keyword argument 'stream'

You might be calling a method (e.g., for embeddings or non-streaming completion) that does not support the `stream` parameter, or using an older client version that doesn't support streaming for that specific API.

fix

Remove the `stream=...` parameter if the API endpoint does not support streaming (e.g., embedding generation). For chat/completion APIs that do support streaming, ensure your `qianfan` SDK version is up-to-date and the `stream` parameter is used correctly for that specific model.

Upgrade

Version history

0.4.12.3latest on PyPI · released Feb 7, 2025

Audit

Dependencies

No dependency data recorded yet.

Agent activity

57 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/baidubce/bce-qianfan-sdk ↗

packagehttps://pypi.org/project/qianfan/ ↗

homepagehttps://cloud.baidu.com/product/wenxinworkshop ↗

docshttps://qianfan.readthedocs.io/en/stable/README.html ↗