ai-hedge-fund custom API setup

Updated 2026-09-05

Provider selection endpoint configuration سے پہلے آتی ہے۔ Current model factory اور registry follow کریں، پھر data، agent output اور evaluation کو الگ stages میں validate کریں۔

Current application path identify کریں

Current ai-hedge-fund application کے لیے OPENAI_API_BASE set کرنے سے پہلے model کا registry provider confirm کریں۔ Revision fc1bf250 میں client factory hedge_fund/llm/client.py میں ہے اور ساتھ والی registry پڑھتی ہے۔ صرف src/llm/models.py والے پرانے tutorials دوسرے application path کی بات کرتے ہیں۔ Checkout pin کریں اور current factory import کرنے والا entrypoint استعمال کریں۔ نیچے provider preflight سے شروع کریں، پھر complete research cycle کے لیے financial data جمع کرنے سے پہلے project client exercise کریں۔

Base URL set کرنے سے پہلے provider resolve کریں

make_llm chosen model identifier سے provider منتخب کرتا ہے۔ اس کی OpenAI branch OPENAI_API_BASE کو ChatOpenAI میں pass کرتی اور متعلقہ API key پڑھتی ہے۔ Reviewed source میں unknown identifier Anthropic transport پر fall back کرتا ہے، اس لیے صرف OpenAI base URL export کرنا کافی نہیں۔ پہلے confirm کریں exact endpoint model ID OpenAI کے تحت registered ہے۔ یہاں OpenAI transport adapter identify کرتا ہے، underlying model vendor certify نہیں۔ Global registry entry بدلنے سے پہلے اس کے تمام workflows سمجھیں۔

SettingPurposeCheck
HEDGE_FUND_LLM_MODELExact model ID منتخب کریںRegistry intended provider resolve کرے
OPENAI_API_BASEOpenAI transport endpoint override کریںOpenAI branch پر apply ہو
OPENAI_API_KEYاس transport کو authenticate کریںClient process کے لیے available ہو
api_models.jsonModel IDs کو providers سے map کریںCurrent path hedge_fund/llm/ ہے

Request کیے بغیر configuration inspect کریں

اگر local registry مختلف transport منتخب کرے تو client construction سے پہلے example fail کریں۔ RESEARCH_MODEL_ID کو ایسے catalog ID پر set کریں جس کی application registration review ہو چکی ہو۔ Absent ہو تو existing display_name، model_name اور provider fields کے ساتھ local registry row جان بوجھ کر add کریں اور unrelated entries محفوظ رکھیں۔ Placeholder supported model claim نہیں۔ Key environment یا secret store سے دیں۔ یہ preflight صرف selection check ہے؛ network access، account entitlement، structured output یا research quality establish نہیں کرتی۔

import os
from hedge_fund.llm.registry import provider_for

model = os.environ["RESEARCH_MODEL_ID"]
if provider_for(model) != "OpenAI":
    raise RuntimeError("MODEL_TRANSPORT_MISMATCH")
os.environ["HEDGE_FUND_LLM_MODEL"] = model
os.environ["OPENAI_API_BASE"] = "https://api.apisrouter.com/v1"
assert os.environ["OPENAI_API_KEY"]
# Selection check only; no make_llm() or model request.

Proposed model route trace کریں

Registry resolution کے بعد model route شروع ہوتی ہے۔ Application کو financial data client، universe definition اور explicit research date پھر بھی چاہیے۔ Gateway key Financial Datasets credential یا market data redistribute کرنے کا right نہیں۔ Company identifiers، currency اور timestamp semantics independently validate کریں۔ Cross-listed company میں واضح کریں analysis issuer، local share class یا depositary receipt کے بارے میں ہے۔ Model-request evidence کو provider-data evidence سے الگ رکھیں تاکہ missing financial series LLM problem نہ سمجھی جائے۔

Model registry selection کے بعد ai-hedge-fund OpenAI transport route۔ai-hedge-fund routes through OpenAI registry provider + OPENAI_API_BASE to the APIsRouter gateway (api.apisrouter.com/v1), which fans out to: Registered research model.ai-hedge-fundviaOpenAI registryprovider +OPENAI_API_BASEAPIsRouterapi.apisrouter.com/v1Registered research model
Provider selection کے بعد documented client route۔ Financial data اپنا client استعمال کرتی ہے۔

Parsed decisions کو data کی طرح validate کریں

Reviewed factory provider clients کو complete(system, user) method کے پیچھے wrap کرتی ہے۔ اس کا response text automatically valid research result نہیں۔ JSON parse، abstention handling اور outputs combine کرنے والی agent layer inspect کریں۔ Response nonempty مگر malformed، contradictory یا inputs سے unsupported ہو سکتی ہے۔ Raw redacted response اور parsed object ایک request record میں رکھیں۔ Reassuring sentence match کرنے کے بجائے expected fields اور allowed states validate کریں۔ Missing یا rejected result unavailable رہے، neutral signal بن کر portfolio aggregation میں خاموشی سے داخل نہ ہو۔

import os
from hedge_fund.llm.client import make_llm, extract_json
from hedge_fund.llm.registry import provider_for

model = os.environ["HEDGE_FUND_LLM_MODEL"]
assert provider_for(model) == "OpenAI"
client = make_llm(model=model)
result = extract_json(client.complete(
    "Return a JSON object with a boolean ready field.",
    "Set ready to true.",
))
assert result.get("ready") is True
# This request tests the client and parser, not financial research.

پہلا research cycle چھوٹا اور reviewable رکھیں

Authorized client test کے بعد ایک issuer اور licensed یا public evidence والا bounded question چنیں۔ Required tools نے expected company اور period واپس کیے یا نہیں confirm کریں، پھر generated explanation کو original documents سے compare کریں۔ Initial run read-only رکھیں اور explicit human review step رکھیں۔ Output میں supporting اور opposing evidence، missing data اور assumptions اور calculations کا فرق دیکھیں۔ Analyst role یا investing style کا نام اس بات کا evidence نہیں کہ generated reasoning کسی real person کے methods یا judgment کو reproduce کرتی ہے۔

Backtest evidence independent رکھیں

Application research cycle finish کر دے تب بھی historical evaluation invalid ہو سکتی ہے۔ Publication timestamps، revised data، surviving-company selection اور historical prompts میں current news کے استعمال کو inspect کریں۔ Prompt یا strategy settings iterate کرنے سے پہلے development، validation اور held-out periods الگ کریں۔ Benchmark، transaction-cost assumptions اور ہر attempted configuration save کریں۔ ایک ہی test period کی بنیاد پر prompt چنتے رہنا اسے development data بنا دیتا ہے۔ Illustrative return سے results table بھرنے کے بجائے incomplete evaluation honestly report کریں۔

Failures اور total research spend control کریں

Job level پر model calls، retries، parsing failures، financial-data charges اور local computation count کریں۔ Endpoint timeout میں usage reconcile ہونے تک billing unknown رہ سکتی ہے۔ Transient transport failures fixed budget کے اندر retry کریں؛ authentication یا provider-selection failures کو unchanged retry نہ کریں۔ Failed stage اور sanitized error review کے لیے available رکھیں۔ Generic gateway hello transport isolate کرنے میں مدد دے سکتی ہے مگر adapter behavior صرف project client tests کرتا ہے۔ Model candidates compare کرتے وقت source packet، roles اور output acceptance criteria constant رکھیں۔

Evidence اور limitations

Current factory اور registry کا review 5 ستمبر 2026 کو fc1bf250 پر ہوا۔ Examples source-backed templates ہیں؛ اس guide کے لیے APIsRouter request یا full research cycle execute نہیں ہوا۔ دوسرے gateways کے earlier calls اس integration کو establish نہیں کرتے۔ Environment validate کرتے وقت client، data-tool اور complete-artifact results الگ رکھیں۔

عمومی سوالات

میرا custom ID Anthropic key کیوں مانگتا ہے؟

Reviewed factory میں unregistered model ID Anthropic پر fall back کرتا ہے۔ Client construction سے پہلے provider_for(model) اور current hedge_fund/llm/api_models.json registry چیک کریں۔

کیا OPENAI_API_BASE ہر provider کو reroute کرتا ہے؟

نہیں۔ یہ OpenAI client branch میں پڑتا ہے۔ دوسرے registry providers اپنے clients اور مختلف settings استعمال کر سکتے ہیں۔

کون سے registry fields relevant ہیں؟

Reviewed registry display_name، model_name اور provider پڑھتی ہے۔ Exact endpoint ID محفوظ کریں اور transport جان بوجھ کر منتخب کریں۔

کیا application menu میں model ہونے سے endpoint access ثابت ہے؟

نہیں۔ Chosen endpoint سے exact ID اور account access چیک کریں۔ Application registry client selection طے کرتی ہے، gateway catalog نہیں۔

Client JSON واپس کرے تو کیا چیک کروں؟

Financial-data tools، agent output schema، abstention behavior اور final evidence-linked research artifact کو bounded task پر validate کریں۔

کیا output سے order automatically place کر سکتا ہوں؟

یہ guide research configuration cover کرتی ہے۔ Order authorization، limits، reconciliation اور operational review separately validated execution system کے کام ہیں۔