Skip to main content

HireSquire SDK - AI-powered candidate screening for agents and humans

Project description

HireSquire Python SDK

PyPI Version Python Versions License

Python SDK for HireSquire's AI-powered candidate screening API. Includes native LangChain and AutoGen integration.

Installation

pip install hiresquire

Quick Start

Option 1: Client Class (Recommended)

from hiresquire import HireSquire

client = HireSquire("YOUR_API_TOKEN")

# Submit and wait automatically
job = client.screen(
    title="Senior Python Developer", 
    description="Looking for experienced Python developer with Django experience...",
    resumes=["./resumes/john_doe.pdf", "./resumes/jane_smith.pdf"]
)

# Get results when complete
results = client.wait_for_completion(job["job_id"])

for candidate in results["candidates"]:
    print(f"{candidate['name']}: {candidate['score']}/100")

Option 2: Direct Function Calls

from hiresquire import create_screening_job, get_screening_status, get_screening_results

# Submit a screening job
result = create_screening_job(
    title="Senior Python Developer",
    description="Looking for experienced Python developer with Django experience...",
    resumes=[
        {"filename": "john_doe.pdf", "content": "John Doe\n5 years Python experience..."}
    ]
)
job_id = result["job_id"]

# Poll for completion
status = get_screening_status(job_id=job_id)
while status["status"] == "processing":
    time.sleep(3)
    status = get_screening_status(job_id=job_id)

# Get results
results = get_screening_results(job_id=job_id)
for candidate in results["candidates"]:
    print(f"{candidate['name']}: {candidate['score']}/100")

Environment Variables

Set these before using the SDK:

export HIRESQUIRE_API_TOKEN="your_api_token_here"
export HIRESQUIRE_BASE_URL="https://api.hiresquireai.com/api/v1"  # optional

LangChain Integration

from langchain.agents import AgentExecutor, create_openai_functions_agent
from langchain_openai import ChatOpenAI
from hiresquire import get_hiresquire_tools

llm = ChatOpenAI(temperature=0)
tools = get_hiresquire_tools()

agent = create_openai_functions_agent(llm, tools)
executor = AgentExecutor(agent=agent, tools=tools, verbose=True)

# Use in an agent
result = executor.invoke({
    "input": "Submit a screening job for a Python developer and find candidates with score > 80"
})

Available Tools

Tool Description
create_screening_job Submit a new screening job
get_screening_status Check job status
get_screening_results Get completed job results
wait_for_screening_completion Poll until job completes
generate_candidate_email Generate outreach email
get_candidates_by_score Filter candidates by score
enable_auto_reload Enable automatic credit reloading
disable_auto_reload Disable automatic credit reloading
get_credit_balance Check current credit balance
estimate_screening_cost Estimate cost for N candidates

API Documentation

Full API documentation available at: https://hiresquireai.com/docs/api

License

MIT License - see LICENSE file for details.

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

hiresquire-1.2.1.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

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

hiresquire-1.2.1-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file hiresquire-1.2.1.tar.gz.

File metadata

  • Download URL: hiresquire-1.2.1.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for hiresquire-1.2.1.tar.gz
Algorithm Hash digest
SHA256 1d9e69c000b297be4b7195e8d4f057b44629a333291eda9a8e3ef376b0acec0b
MD5 05088c1a3505d7eedc19115b9c79c5a1
BLAKE2b-256 d8270c6cdff8ae30f0dd544616f3f7f5305cc68df20fd5278b4754849e5e032b

See more details on using hashes here.

File details

Details for the file hiresquire-1.2.1-py3-none-any.whl.

File metadata

  • Download URL: hiresquire-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for hiresquire-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e997185102e870fcbd594d3e60c9bbdf8fe853be49132eb67b1e863a0a9d762d
MD5 5babe45fc590f17e5f821a28fa0275a9
BLAKE2b-256 78d025774f3257e35eaef8289f7cc2ecde056935f9f78401fa30066a0c9544af

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