Skip to main content

In-process SDK runtime for agent-search

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 agent_search import advanced_rag, build_langfuse_callback
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 = build_langfuse_callback(sampling_key="customer-123")

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 you omit it, SDK does not trace the run.

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.7.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.7-py3-none-any.whl (97.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: agent_search_core-0.1.7.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.7.tar.gz
Algorithm Hash digest
SHA256 c38d1045b8f38e687fde0f6a9667f5ebef3fba8ca225803a2c2b3cea0959963f
MD5 ce56c7f9fb1eb448e93d272d71e20d20
BLAKE2b-256 bc24e85dc8bca48d64ac005b501c952dc000c7e1186c87b87cf6539be7ab46ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for agent_search_core-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 13e0f7720129e57bc1e9e1a5616a9e80820bb9062b533aba9dfc0c5b63b482bf
MD5 7e765d6b64b5f56d45a1c0837f27c3f4
BLAKE2b-256 d57bd676aecf047d35e4eec63415d7541629f8ad467925fa2603e275c21d32ee

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