Įdiekite Python SDK
Šiame puslapyje
Įdiekite Python SDK
openai Python SDK yra oficiali biblioteka sąveikai su API. Šioje pamokoje parodysime, kaip ją įdiegti, ir sukursime tvarkingą projekto struktūrą, kurią naudosite visame kurse.
Būtinos sąlygos ir diegimas
Jums reikia Python 3.10 arba naujesnės versijos – tai minimalus reikalavimas openai SDK (3.42.1 versija, 2026 m. lapkričio 2 d. duomenimis iš PyPI), paketų tvarkyklės (pip arba uv) ir API rakto, kurį gavote ankstesnėje pamokoje. Pirmiausia patikrinkite savo interpretatorių, nes kūrimo kompiuteriuose dažnai būna kelios versijos:
python --version
# Python 3.12.4
Diegimui užtenka vienos komandos: pip install openai, arba uv pip install openai, jei naudojate uv (ji veikia žymiai greičiau). Tačiau įpraskite dirbti virtualioje aplinkoje. Tai apsaugo nuo situacijos, kai po šešių mėnesių paaiškėja, jog dviem projektams reikia nesuderinamų tos pačios bibliotekos versijų.
# Sukurti virtualią aplinką
python -m venv .venv
# Aktyvuoti (Linux/macOS)
source .venv/bin/activate
# Aktyvuoti (Windows)
.venv\Scripts\activate
# Įdiegti SDK
pip install openai
Beveik kiekviename projekte atsiranda du pagalbininkai, kuriuos verta įdiegti kartu su SDK. Pydantic padeda apibrėžti schemas struktūrizuotai išvestiai (tai pamatysite vėliau), o python-dotenv įkelia .env failą į aplinkos kintamuosius.
# Įdiegti su Pydantic duomenų klasių palaikymu
pip install openai pydantic
# Įdiegti su python-dotenv aplinkos kintamiesiems
pip install openai python-dotenv
Galiausiai patikrinkite, ar importas veikia, ir užsirašykite įdiegtą versiją. Tai pirmoji informacija, kurią reikia pateikti atidarant pagalbos užklausą.
import openai
print(f"OpenAI SDK version: {openai.__version__}")
# Output: OpenAI SDK version: 1.68.0 (or newer)
Vienas klientas visiems API
SDK sukasi apie vieną kliento objektą, kuris per pomodulius atveria visą platformą. Norėdami pereiti nuo teksto generavimo prie įterpinių (embeddings) ar moderavimo, jums nereikia kurti jokių naujų instancijų.
from openai import OpenAI
client = OpenAI()
# Responses API (tekstas, funkcijų kvietimas, struktūrizuota išvestis)
client.responses.create(...)
# Chat Completions API (senesnė versija)
client.chat.completions.create(...)
# Įterpiniai (Embeddings)
client.embeddings.create(...)
# Vaizdai
client.images.generate(...)
# Garso įrašai
client.audio.transcriptions.create(...)
client.audio.speech.create(...)
# Moderavimas
client.moderations.create(...)
Konfigūruokite klientą savo kontekstui
Numatytieji SDK nustatymai tinka eksperimentams, tačiau nepakanka web aplikacijoms. Numatytoji laiko riba (timeout) yra dešimt minučių: HTTP API, kuris turi atsakyti per kelias sekundes, tai reiškia, kad įstrigęs užklausimas per ilgai užima darbuotoją. Sumažinkite šį laiką ir padidinkite automatinių bandymų skaičių, kuris pagal nutylėjimą yra du.
from openai import OpenAI
client = OpenAI(
timeout=60.0, # 60 sekundžių (numatyta: 10 minučių)
max_retries=3, # 3 bandymai esant klaidai (numatyta: 2)
)
Parametras base_url sprendžia kitą poreikį: nukreipti užklausas per korporacinį proxy, kuris registruoja išeinantį srautą, arba į servisą, teikiantį suderinamą API.
# Naudinga korporaciniams proxy arba suderinamiems API
client = OpenAI(
base_url="https://your-proxy.company.com/v1"
)
Galiausiai, jei jūsų aplikacija remiasi asyncio – FastAPI, aiohttp ir pan. – naudokite AsyncOpenAI. Sinchroninis klientas blokuotų įvykių ciklą generavimo metu, taip paneigdamas asinchroninio kodo privalumus.
from openai import AsyncOpenAI
async_client = AsyncOpenAI()
# Naudojimas su await
import asyncio
async def main():
response = await async_client.responses.create(
model="gpt-5.6-terra",
input="Hello!"
)
print(response.output_text)
asyncio.run(main())
# Output: Hello! How can I help you today?
Organizuokite savo projektą
Iš pat pradžių pasirinkite organizaciją, kuri atskiria kliento konfigūraciją nuo likusio kodo. Tai išvengia dešimčių OpenAI() kvietimų išbarstymo po visą projektą, kurių kiekvienas turi savo nustatymus.
my-project/
├── .env # API raktas (NIKADA neįkelkite į git)
├── .gitignore # Įtraukia .env
├── requirements.txt # Priklausomybės
├── src/
│ ├── __init__.py
│ ├── client.py # OpenAI kliento konfigūracija
│ └── main.py # Įvesties taškas
└── tests/
└── test_api.py
Failas src/client.py centralizuoja kliento fabriką: tą dieną, kai pakeisite laiko ribą arba pridėsite proxy, jums reikės modifikuoti tik vieną vietą.
from openai import OpenAI
from dotenv import load_dotenv
load_dotenv()
def get_client() -> OpenAI:
"""Grąžina sukonfigūruotą OpenAI klientą."""
return OpenAI(
max_retries=3,
timeout=30.0
)
O requirements.txt fiksuoja minimalias tikėtinas versijas:
openai>=1.60.0
python-dotenv>=1.0.0
pydantic>=2.0.0
Trys dažnos klaidos
ModuleNotFoundError klaida dėl openai beveik visada rodo neaktyvią virtualią aplinką arba kitokią nei ta, kurioje įdiegėte paketą. Raskite faktiškai naudojamą interpretatorių naudodami which python (Linux ir macOS) arba where python (Windows), tada iš naujo įdiekite su pip install --upgrade openai. AuthenticationError rodo problemą su aplinkos kintamuoju: atspausdinkite os.environ.get("OPENAI_API_KEY", "NOT DEFINED"), kad atmestumėte abejones – .env failas neįkeliamas, jei prieš kuriant klientą nebuvo iškviesta load_dotenv(). Galiausiai, klaida dėl nežinomo parametro dažniausiai reiškia, kad SDK yra per sena naudojamai funkcijai: tai išsprendžia pip install --upgrade openai.
Svarbiausi punktai
- Įdiekite SDK komanda
pip install openaivirtualioje aplinkoje OpenAI()klientas yra įvesties taškas visiems API- Asinchroninėms aplikacijoms naudokite
AsyncOpenAI() - Konfigūruokite laiko ribas ir bandymų skaičių pagal savo poreikius
- Organizuokite projektą naudodami
.envfailą ir centralizuotą klientą