Dearbhú uirlisí sa SDK
Ar an leathanach seo
Dearbhú uirlisí sa SDK
Is iad na huirlisí cumais chruinne do ghníomhaire. Gan uirlisí, ní féidir le gníomhaire ach téacs a ghiniúint; le huirlisí, is féidir leis bunachair shonraí a chuardach, APIanna a ghlaoch, agus ríomhphoist a sheoladh. Caithfidh tú iad a dhearbhú i gceart, áfach, toisc nach mbaineann cáilíocht uirlise lena cód amháin—braitheann sí freisin ar chomh maith agus a thuigeann an tsamhail í.
An maisitheoir @function_tool
Is é an maisitheoir @function_tool an bealach is simplí chun uirlis a chruthú, rud a thiontaíonn gnáthfheidhm Python ina chumas is féidir leis an ngníomhaire a ghlaoch.
from agents import function_tool
@function_tool
def search_customer(email: str) -> str:
"""Search for a customer by email address in the database.
Args:
email: The customer's email address to search for.
"""
# In production: call your database
customers = {
"[email protected]": {"name": "Alice Dupont", "plan": "Pro", "since": "2024"},
"[email protected]": {"name": "Bob Martin", "plan": "Starter", "since": "2025"},
}
customer = customers.get(email)
if customer:
return f"Customer found: {customer['name']}, plan {customer['plan']}, customer since {customer['since']}"
return f"No customer found with email {email}"
Ní dhéantar aon rud a dhearbhú faoi dhó: úsáideann an SDK ainm na feidhme mar ainm na huirlise, an docstring mar chur síos, agus na leideanna cineáil chun an scéima JSON do pharaiméadair a ghiniúint. Le focal eile, níl an docstring ina thrácht do do chomhghleacaithe a thuilleadh; is é an téacs é a léann an tsamhail chun cinneadh a dhéanamh an bhfuil an fheidhm seo le glaoch nó nach bhfuil. Má bhíonn an docstring doiléir, beidh na glaonna neamhchruinn.
Ainm agus cur síos a shaincheapadh
Nuair a leanann ainm do fheidhme coinbhinsiúin inmheánacha seachas loighic ghnó, is féidir leat a shaincheapadh cad a fheiceann an tsamhail.
@function_tool(
name_override="search_crm",
description_override="Search for a customer in the CRM by email, name, or account number."
)
def search_customer(identifier: str) -> str:
"""Search for a customer."""
# ...
return "Result"
Cineálacha paraiméadar a dtacaítear leo
Chomh maith le cineálacha dúchasacha Python, glacann an SDK le samhlacha Pydantic. Nuair a ghlacann uirlis le trí pharaiméadar nó níos mó, grúpáil iad: beidh an scéima níos inléite don tsamhail, agus cosnóidh an bailíochtú tú ó luachanna as an ngnáth.
from pydantic import BaseModel, Field
from typing import Optional
from agents import function_tool
class SearchFilter(BaseModel):
category: str = Field(description="Product category")
max_price: Optional[float] = Field(None, description="Maximum price in euros")
in_stock: bool = Field(True, description="Only products in stock")
@function_tool
def search_products(filter: SearchFilter) -> str:
"""Search for products based on specified criteria."""
results = []
# Search logic using filter.category, filter.max_price, etc.
return f"Found {len(results)} products in {filter.category}"
Déanann samhlacha Pydantic ionchuir a bhailíochtú go huathoibríoch agus soláthraíonn siad cur síosanna saibhre, réimse ar réimse, don tsamhail.
Torthaí struchtúrtha a thabhairt ar ais
Tugann uirlis teaghrán ar ais i gcónaí. Nuair a bhíonn struchtúr le do chuid sonraí—métricí iolracha, liosta, cineálacha measctha—sreangaigh é mar JSON seachas abairt a chumadh: léifidh an tsamhail na heochracha i bhfad níos iontaofa ná téacs saor.
import json
from agents import function_tool
@function_tool
def get_sales_stats(month: str, year: int) -> str:
"""Retrieve sales statistics for a given month."""
stats = {
"month": month,
"year": year,
"revenue": 145000,
"sales_count": 342,
"avg_basket": 423.98,
"top_products": ["Laptop Pro", "Tablet Air", "Monitor 4K"]
}
return json.dumps(stats, ensure_ascii=False, indent=2)
Uirlisí óstáilte ag OpenAI
Chomh maith le do fheidhmeanna saincheaptha, soláthraíonn an SDK rochtain ar uirlisí a bhainistíonn OpenAI agus a ritheann ar thaobh na hardáine.
from agents import Agent, WebSearchTool, FileSearchTool, CodeInterpreterTool
agent = Agent(
name="General-purpose assistant",
instructions="You are an assistant capable of searching the web, analyzing files, and executing code.",
tools=[
WebSearchTool(),
FileSearchTool(
vector_store_ids=["vs_abc123"],
max_num_results=10,
),
CodeInterpreterTool(tool_config={"type": "code_interpreter", "container": {"type": "auto"}}),
],
)
Ligeann WebSearchTool don ghníomhaire an t-idirlíon a chuardach i bhfíor-am agus ní éilíonn sé aon chumraíocht. Déanann FileSearchTool cuardach seimeantach ar do chuid comhad ach glacann sé le réamhshocrú: caithfidh tú siopa veicteoire a chruthú trí API OpenAI agus do dhoiciméid a uaslódáil chuige—sin an fáth a bhfuil vs_abc123 curtha ar fáil mar pharaiméadar. Ligeann CodeInterpreterTool don ghníomhaire cód Python a scríobh agus a fhorghníomhú i gcoimeádán leithlisithe, rud a fhágann gurb é an rogha is fearr é chun anailís sonraí a dhéanamh agus cairteacha a ghiniúint. Éilíonn sé tool_config a shonraíonn an coimeádán seo: cruthaíonn {"type": "auto"} é ar éileamh (diúltaíonn an SDK openai-agents do CodeInterpreterTool() gan é).
Uirlisí saincheaptha agus óstáilte a chomhcheangal
Tá an fhíorchumhacht sa chomhcheangal. Teastaíonn ó anailísí airgeadais do chuid sonraí inmheánacha, cumais ríomhaireachta, agus comhthéacs margaidh: trí fhoinse nach gcumhdaíonn aon uirlis amháin.
agent = Agent(
name="Financial analyst",
instructions="""You are a financial analyst.
Use internal tools to retrieve data,
the code interpreter to analyze it,
and web search for market context.""",
tools=[
get_sales_stats,
search_customer,
WebSearchTool(),
CodeInterpreterTool(tool_config={"type": "code_interpreter", "container": {"type": "auto"}}),
],
)
Tabhair faoi deara conas a shonraíonn na treoracha cén fáth a bhfuil gach teaghlach uirlisí ann. Gan an soiléireacht seo, bíonn gníomhaire le ceithre huirlis leathbharraithe, bainfidh sé triail as dhó cheann gan ghá, agus méadaíonn sé an moill gan chúis ar bith.
Príomhphointí
- Tiontaíonn
@function_toolfeidhm Python ina huirlis gníomhaire - Gineann an docstring agus na leideanna cineáil an scéima JSON go huathoibríoch
- Úsáid Pydantic do pharaiméadair chasta le bailíochtú
- Tugann uirlisí teaghráin ar ais i gcónaí (JSON má tá struchtúr ann)
- Comhcheangail do chuid uirlisí saincheaptha le WebSearchTool, FileSearchTool, agus CodeInterpreterTool