Skip to main content

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

Project description

HireSquire Python SDK

PyPI Version Python Versions License

LangChain tools for HireSquire's AI-powered candidate screening API.

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.0.tar.gz (10.3 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.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hiresquire-1.2.0.tar.gz
  • Upload date:
  • Size: 10.3 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.0.tar.gz
Algorithm Hash digest
SHA256 c5d61b96a8e36149fbf33626562b84122e9f10af92e2f6c830ab077737651532
MD5 83c02ee44b48694830440d1ba8c65ca1
BLAKE2b-256 786e48369ccb2f5c5ed6048bb8f67880ea3807db220e110c951bd8b362a78e24

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hiresquire-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.7 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94e19aa5c849988c2f252d5c19e4e9441fe56eca27133c3338f8648fe12a9d08
MD5 cf25cb9d912b617ca1b7ce3f5c32356e
BLAKE2b-256 e769911355b95c400e570cb3d241f8b0bfb060a5296882236747161e51b212ab

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