Suiteáil an Python SDK
Ar an leathanach seo
Suiteáil an Python SDK
Is é an Python SDK openai an leabharlann oifigiúil chun idirghníomhú leis an API. Sa cheacht seo, déanfaidh tú an tsuiteáil agus socraíoch tú struchtúr glan tionscadail a úsáidfidh tú ar feadh an chuid eile den chúrsa.
Réamhriachtanais agus Suiteáil
Tá Python 3.10 nó níos nuaí uait—é seo an t-íosleibhéal a éilíonn an SDK openai (leagan 3.42.1 ón 2 Samhain 2026, de réir PyPI)—bainisteoir pacáistí (pip nó uv), agus an eochair API a fuair tú sa cheacht roimhe seo. Tosaigh trí do léirmhínitheoir a dheimhniú, ós rud é go mbíonn leaganacha iolracha ar mheaisíní forbartha go minic:
python --version
# Python 3.12.4
Ní gá ach ordú amháin chun an tsuiteáil a dhéanamh: pip install openai, nó uv pip install openai má úsáideann tú uv, atá i bhfad níos tapúla. Mar sin féin, déan cleachtas de bheith ag obair laistigh de thimpeallacht fhíorúil. Cuireann sé seo cosc ar an gcás coitianta ina bhfaigheann tú amach, sé mhí ina dhiaidh sin, go n-éilíonn dhá thionscadal leaganacha neamh-chomhoiriúnacha den leabharlann céanna.
# Cruthaigh timpeallacht fhíorúil
python -m venv .venv
# Gníomhachtaigh (Linux/macOS)
source .venv/bin/activate
# Gníomhachtaigh (Windows)
.venv\Scripts\activate
# Suiteáil an SDK
pip install openai
Tá beirt chomhpháirtithe le feiceáil i mbeagnach gach tionscadal agus is fiú iad a shuiteáil in éineacht leis an SDK. Cabhraíonn Pydantic le scéimreanna a shainiú d’Aschur Struchtúrtha, rud a fheicfidh tú níos déanaí; lódálann python-dotenv an comhad .env isteach in athróga timpeallachta.
# Suiteáil le tacaíocht do dataclasses Pydantic
pip install openai pydantic
# Suiteáil le python-dotenv d'athróga timpeallachta
pip install openai python-dotenv
Ar deireadh, fíoraigh go n-oibríonn an t-allmhairiú agus tabhair faoi deara an leagan suiteáilte. Seo an chéad píosa faisnéise le soláthar má osclaíonn tú ticéad tacaíochta.
import openai
print(f"OpenAI SDK version: {openai.__version__}")
# Output: OpenAI SDK version: 1.68.0 (or newer)
Aon Chliaint Amháin, Gach API
Baineann an SDK le hoibiacht chliainte amháin a nochtann an t-ardán iomlán trí fhomhodúil. Ní gá duit aon rud nua a chur ar bun chun aistriú ó ghiniúint téacs go leabaithe nó modhnú.
from openai import OpenAI
client = OpenAI()
# Responses API (téacs, glao feidhme, aschur struchtúrtha)
client.responses.create(...)
# Chat Completions API (seanbhunaithe)
client.chat.completions.create(...)
# Leabaithe
client.embeddings.create(...)
# Íomhánna
client.images.generate(...)
# Fuaim
client.audio.transcriptions.create(...)
client.audio.speech.create(...)
# Modhnú
client.moderations.create(...)
Cumraigh an Cliant do do Chomhthéacs
Oibríonn réamhshocruithe an SDK d’fhíorú, ach teipeann orthu d’fheidhmchláir ghréasáin. Is é an t-am teorainn réamhshocraithe ná deich nóiméad: in API HTTP ar a bhfuiltear ag súil go bhfreagrófar laistigh de shoicindí, ciallaíonn sé seo go gcoimeádann iarratas greamaithe oibrí i bhfad ró-fhada. Laghdaigh é, agus méadaigh líon na n-iarrachtaí uathoibríocha, atá dhá cheann de réir réamhshocraithe.
from openai import OpenAI
client = OpenAI(
timeout=60.0, # 60 soicind (réamhshocrú: 10 nóiméad)
max_retries=3, # 3 iarracht ar earráid (réamhshocrú: 2)
)
Freagraíonn an paraiméadar base_url do riachtanas eile: glaonna a ródú trí sheachfhreastalaí corparáideach a dhéanann logáil ar thrácht amach, nó chuig seirbhís a nochtann API comhoiriúnach.
# Úsáideach do sheachfhreastalaithe corparáideacha nó APIanna comhoiriúnacha
client = OpenAI(
base_url="https://your-proxy.company.com/v1"
)
Ar deireadh, má bhraitheann d’fheidhmchlár ar asyncio—FastAPI, aiohttp, agus a leithéidí—úsáid AsyncOpenAI. Chuirfeadh an cliant sioncronach bac ar an lúb imeachta le linn na giniúna, rud a chuirfeadh ar ceal tairbhí an chóid neamhshioncronaigh.
from openai import AsyncOpenAI
async_client = AsyncOpenAI()
# Úsáid le 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?
Struchtúraigh do Thionscadal
Glac le heagrú a aonraíonn cumraíocht an chliaint ón gcuid eile de do chód ón tús. Seachnaíonn sé seo scaipeadh deichní OpenAI() ar fud do thionscadail, gach ceann acu lena shocruithe féin.
my-project/
├── .env # Eochair API (NÁ déan é a chur faoi git riamh)
├── .gitignore # Áirítear .env
├── requirements.txt # Spleáchais
├── src/
│ ├── __init__.py
│ ├── client.py # Cumraíocht chliaint OpenAI
│ └── main.py # Pointe iontrála
└── tests/
└── test_api.py
Láraíonn an comhad src/client.py an monarcha cliant: an lá a athraíonn tú an t-am teorainn nó a chuireann tú seachfhreastalaí leis, ní gá duit ach áit amháin a mhodhnú.
from openai import OpenAI
from dotenv import load_dotenv
load_dotenv()
def get_client() -> OpenAI:
"""Filleann sé cliant OpenAI cumraithe."""
return OpenAI(
max_retries=3,
timeout=30.0
)
Agus pinneann requirements.txt na leaganacha íosta a bhfuiltear ag súil leo:
openai>=1.60.0
python-dotenv>=1.0.0
pydantic>=2.0.0
Trí Theip Choitianta
Is minic a chiallaíonn ModuleNotFoundError ar openai go bhfuil timpeallacht fhíorúil neamhghníomhach ann, nó ceann atá difriúil ón áit ar shuiteáil tú an pacáiste. Aimsigh an léirmhínitheoir atá in úsáid i ndáiríre le which python ar Linux agus macOS, nó where python ar Windows, ansin déan athshuiteáil le pip install --upgrade openai. Léiríonn AuthenticationError fadhb leis an athróg timpeallachta: priontáil os.environ.get("OPENAI_API_KEY", "NOT DEFINED") chun fadhbanna a dhíbirt—ní lódáiltear an comhad .env mura nglaofar load_dotenv() sula ndéantar an cliant a chur ar bun. Ar deireadh, is gnách go léiríonn earráid maidir le paraiméadar anaithnid go bhfuil an SDK ró-shean don ghné atá á húsáid agat: réitíonn pip install --upgrade openai é seo.
Príomhphointí
- Suiteáil an SDK le
pip install openailaistigh de thimpeallacht fhíorúil - Is é an cliant
OpenAI()an pointe iontrála do gach API - Úsáid
AsyncOpenAI()d’fheidhmchláir neamhshioncronacha - Cumraigh am teorainn agus iarrachtaí athfhillteacha bunaithe ar do riachtanais
- Struchtúraigh do thionscadal le comhad
.envagus cliant láraithe