llama-index-packs-resume-screener


Namellama-index-packs-resume-screener JSON
Version 0.1.3 PyPI version JSON
download
home_page
Summaryllama-index packs resume_screener integration
upload_time2024-02-22 01:34:13
maintainerDisiok
docs_urlNone
authorYour Name
requires_python>=3.8.1,<4.0
licenseMIT
keywords document pdf resume structured output
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Resumer Screener Pack

This LlamaPack loads a resume file, and review it against a user specified job description and screening criteria.

## CLI Usage

You can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:

```bash
llamaindex-cli download-llamapack ResumeScreenerPack --download-dir ./resume_screener_pack
```

You can then inspect the files at `./resume_screener_pack` and use them as a template for your own project!

## Code Usage

You can download the pack to a `./resume_screener_pack` directory:

```python
from llama_index.core.llama_pack import download_llama_pack

# download and install dependencies
ResumeScreenerPack = download_llama_pack(
    "ResumeScreenerPack", "./resume_screener_pack"
)
```

From here, you can use the pack, or inspect and modify the pack in `./resume_screener_pack`.

Then, you can set up the pack like so:

```python
# create the pack
resume_screener = ResumeScreenerPack(
    job_description="<general job description>",
    criteria=["<job criterion>", "<another job criterion>"],
)
```

```python
response = resume_screener.run(resume_path="resume.pdf")
print(response.overall_decision)
```

The `response` will be a pydantic model with the following schema

```python
class CriteriaDecision(BaseModel):
    """The decision made based on a single criteria"""

    decision: Field(
        type=bool, description="The decision made based on the criteria"
    )
    reasoning: Field(type=str, description="The reasoning behind the decision")


class ResumeScreenerDecision(BaseModel):
    """The decision made by the resume screener"""

    criteria_decisions: Field(
        type=List[CriteriaDecision],
        description="The decisions made based on the criteria",
    )
    overall_reasoning: Field(
        type=str, description="The reasoning behind the overall decision"
    )
    overall_decision: Field(
        type=bool,
        description="The overall decision made based on the criteria",
    )
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "llama-index-packs-resume-screener",
    "maintainer": "Disiok",
    "docs_url": null,
    "requires_python": ">=3.8.1,<4.0",
    "maintainer_email": "",
    "keywords": "document,pdf,resume,structured output",
    "author": "Your Name",
    "author_email": "you@example.com",
    "download_url": "https://files.pythonhosted.org/packages/80/9d/7ea6bc3b93ba26d0ad45e739ebfeee78a923d5cc5317456e146ec84a24e9/llama_index_packs_resume_screener-0.1.3.tar.gz",
    "platform": null,
    "description": "# Resumer Screener Pack\n\nThis LlamaPack loads a resume file, and review it against a user specified job description and screening criteria.\n\n## CLI Usage\n\nYou can download llamapacks directly using `llamaindex-cli`, which comes installed with the `llama-index` python package:\n\n```bash\nllamaindex-cli download-llamapack ResumeScreenerPack --download-dir ./resume_screener_pack\n```\n\nYou can then inspect the files at `./resume_screener_pack` and use them as a template for your own project!\n\n## Code Usage\n\nYou can download the pack to a `./resume_screener_pack` directory:\n\n```python\nfrom llama_index.core.llama_pack import download_llama_pack\n\n# download and install dependencies\nResumeScreenerPack = download_llama_pack(\n    \"ResumeScreenerPack\", \"./resume_screener_pack\"\n)\n```\n\nFrom here, you can use the pack, or inspect and modify the pack in `./resume_screener_pack`.\n\nThen, you can set up the pack like so:\n\n```python\n# create the pack\nresume_screener = ResumeScreenerPack(\n    job_description=\"<general job description>\",\n    criteria=[\"<job criterion>\", \"<another job criterion>\"],\n)\n```\n\n```python\nresponse = resume_screener.run(resume_path=\"resume.pdf\")\nprint(response.overall_decision)\n```\n\nThe `response` will be a pydantic model with the following schema\n\n```python\nclass CriteriaDecision(BaseModel):\n    \"\"\"The decision made based on a single criteria\"\"\"\n\n    decision: Field(\n        type=bool, description=\"The decision made based on the criteria\"\n    )\n    reasoning: Field(type=str, description=\"The reasoning behind the decision\")\n\n\nclass ResumeScreenerDecision(BaseModel):\n    \"\"\"The decision made by the resume screener\"\"\"\n\n    criteria_decisions: Field(\n        type=List[CriteriaDecision],\n        description=\"The decisions made based on the criteria\",\n    )\n    overall_reasoning: Field(\n        type=str, description=\"The reasoning behind the overall decision\"\n    )\n    overall_decision: Field(\n        type=bool,\n        description=\"The overall decision made based on the criteria\",\n    )\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "llama-index packs resume_screener integration",
    "version": "0.1.3",
    "project_urls": null,
    "split_keywords": [
        "document",
        "pdf",
        "resume",
        "structured output"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "258df3e0931f9e2a3b16aa2fcf5e9e074c1289a2602b5b4d10974b0473137708",
                "md5": "9e5b8bcbffb3d5fe0fd3868b6556123b",
                "sha256": "d4f69f57104598d01bad363ee426ed6afeb6e1c71a2798c40d2855d99ce26e6c"
            },
            "downloads": -1,
            "filename": "llama_index_packs_resume_screener-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9e5b8bcbffb3d5fe0fd3868b6556123b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.1,<4.0",
            "size": 3436,
            "upload_time": "2024-02-22T01:34:12",
            "upload_time_iso_8601": "2024-02-22T01:34:12.500375Z",
            "url": "https://files.pythonhosted.org/packages/25/8d/f3e0931f9e2a3b16aa2fcf5e9e074c1289a2602b5b4d10974b0473137708/llama_index_packs_resume_screener-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "809d7ea6bc3b93ba26d0ad45e739ebfeee78a923d5cc5317456e146ec84a24e9",
                "md5": "3dd346b70cd93dae4acd5d191da74ade",
                "sha256": "2a5aa109e4c5ea77cf5060ee0fb87d6339a741d7420ba50ebfd5fb4388f6278d"
            },
            "downloads": -1,
            "filename": "llama_index_packs_resume_screener-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "3dd346b70cd93dae4acd5d191da74ade",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.1,<4.0",
            "size": 3036,
            "upload_time": "2024-02-22T01:34:13",
            "upload_time_iso_8601": "2024-02-22T01:34:13.907819Z",
            "url": "https://files.pythonhosted.org/packages/80/9d/7ea6bc3b93ba26d0ad45e739ebfeee78a923d5cc5317456e146ec84a24e9/llama_index_packs_resume_screener-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-22 01:34:13",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "llama-index-packs-resume-screener"
}
        
Elapsed time: 0.19770s