Skip to main content

In-process SDK runtime for agent-search with optional callback-driven Langfuse tracing

Project description

agent-search core SDK

In-process Python SDK for agent-search. This package lets you call the runtime directly inside your own app.

The SDK always requires both:

  • A chat model (e.g. langchain_openai.ChatOpenAI)
  • A vector store that implements similarity_search(query, k, filter=None)

It does not auto-build these dependencies for you.

Install (PyPI)

python3.11 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install agent-search-core
python -c "import agent_search; print(agent_search.__file__)"

Quick start

from langchain_openai import ChatOpenAI
from langfuse.langchain import CallbackHandler
from agent_search import advanced_rag
from agent_search.vectorstore.langchain_adapter import LangChainVectorStoreAdapter

vector_store = LangChainVectorStoreAdapter(your_langchain_vector_store)
model = ChatOpenAI(model="gpt-4.1-mini", temperature=0.0)
langfuse_callback = CallbackHandler(
    public_key="...",
    secret_key="...",
    host="https://cloud.langfuse.com",
)

response = advanced_rag(
    "What is pgvector?",
    vector_store=vector_store,
    model=model,
    langfuse_callback=langfuse_callback,
)
print(response.output)

Requirements

  • Python >=3.11,<3.14
  • A compatible vector store and chat model as shown above.

Build

cd sdk/core
python -m build

Runtime API surface

Primary functions exposed by agent_search:

  • advanced_rag
  • build_langfuse_callback
  • run
  • run_async
  • get_run_status
  • cancel_run

run(...) remains available as a compatibility alias and delegates to advanced_rag(...).

Tracing behavior for advanced_rag(...):

  • If you pass langfuse_callback=..., SDK uses that callback for run tracing.
  • If langfuse_callback is omitted, SDK does not trace the run.
  • langfuse_settings is deprecated and ignored by advanced_rag(...); pass an explicit callback instead.

advanced_rag(...) output schema:

RuntimeAgentRunResponse(
  main_question: str,
  sub_qa: list[SubQuestionAnswer],
  output: str,
  final_citations: list[CitationSourceRow],
)

Config and errors exposed by agent_search:

  • RuntimeConfig, RuntimeTimeoutConfig, RuntimeRetrievalConfig, RuntimeRerankConfig
  • SDKError, SDKConfigurationError, SDKRetrievalError, SDKModelError, SDKTimeoutError

Vector store compatibility

Runtime SDK expects similarity_search(query, k, filter=None). For LangChain-backed stores, use:

  • agent_search.vectorstore.langchain_adapter.LangChainVectorStoreAdapter

Notes

  • For the full app (API, DB, UI), run this repo with Docker Compose.
  • For SDK-only use, install from PyPI and supply your own model + vector store.

Release guidance

Use the repository release script from project root:

./scripts/release_sdk.sh

The release script verifies the built wheel includes the agent_search package before upload.

Publish flow (requires TWINE_API_TOKEN):

PUBLISH=1 TWINE_API_TOKEN=*** ./scripts/release_sdk.sh

Tag format used by CI release workflow:

  • agent-search-core-v<version>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agent_search_core-0.1.9.tar.gz (71.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agent_search_core-0.1.9-py3-none-any.whl (97.6 kB view details)

Uploaded Python 3

File details

Details for the file agent_search_core-0.1.9.tar.gz.

File metadata

  • Download URL: agent_search_core-0.1.9.tar.gz
  • Upload date:
  • Size: 71.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.13

File hashes

Hashes for agent_search_core-0.1.9.tar.gz
Algorithm Hash digest
SHA256 a11bceefb692451be585646225507607b5080a1b90dea6cda2cc0817ab507703
MD5 cac73248bddd227337999fcbf0851671
BLAKE2b-256 60df17f2046829c7b41eb377e926768073737d73ce894b5c63b58da35e237a72

See more details on using hashes here.

File details

Details for the file agent_search_core-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_search_core-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 d12d75dba17785c8e397baf8e5d1b05886cce1a6fe540471e92e4fa4c9f6ca6e
MD5 07e88de7be4ce52e31ef8963a5097854
BLAKE2b-256 48b8a16e1ac1854b9d99d9539d6b145349198d475ef7a5a7fe90120db491cdfe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page