llama-index-packs-sentence-window-retriever

v0.3.0

llama-index packs sentence_window_retriever integration For more information about how to use this package see README

Latest version published 2 months ago

License: MIT

PyPI

GitHub

Package Health Score

48 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Limited

Popularity

Small

GitHub Stars: 3.43K
Forks: 728
Contributors: -

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package llama-index-packs-sentence-window-retriever, we found that it has been starred 3,428 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 22, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like llama-index-packs-sentence-window-retriever is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

archived

Commit Frequency

Open Issues: 83
Open PR: 15
Last Release: 2 months ago
Last Commit: 8 months ago

Further analysis of the maintenance status of llama-index-packs-sentence-window-retriever based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that llama-index-packs-sentence-window-retriever demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like llama-index-packs-sentence-window-retriever is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: <4.0,>=3.8.1

Age: 9 months
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 6
Maintainers: 1
Wheels: OS Independent

Readme

Sentence Window Retriever

This LlamaPack provides an example of our sentence window retriever.

This specific template shows the e2e process of building this. It loads a document, chunks it up, adds surrounding context as metadata to each chunk, and during retrieval inserts the context back into each chunk for response synthesis.

Check out the notebook here.

CLI Usage

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

llamaindex-cli download-llamapack SentenceWindowRetrieverPack --download-dir ./sentence_window_retriever_pack

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

Code Usage

You can download the pack to a the ./sentence_window_retriever_pack directory:

from llama_index.core.llama_pack import download_llama_pack

# download and install dependencies
SentenceWindowRetrieverPack = download_llama_pack(
    "SentenceWindowRetrieverPack", "./sentence_window_retriever_pack"
)

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

Then, you can set up the pack like so:

# create the pack
# get documents from any data loader
sentence_window_retriever_pack = SentenceWindowRetrieverPack(
    documents,
)

The run() function is a light wrapper around query_engine.query().

response = sentence_window_retriever_pack.run(
    "Tell me a bout a Music celebritiy."
)

You can also use modules individually.

# get the sentence vector index
index = sentence_window_retriever_pack.sentence_index

# get the node parser
node_parser = sentence_window_retriever_pack.node_parser

# get the metadata replacement postprocessor
postprocessor = sentence_window_retriever_pack.postprocessor

# get the query engine
query_engine = sentence_window_retriever_pack.query_engine

FAQs

What is llama-index-packs-sentence-window-retriever?

llama-index packs sentence_window_retriever integration. Visit Snyk Advisor to see a full health score report for llama-index-packs-sentence-window-retriever, including popularity, security, maintenance & community analysis.

Is llama-index-packs-sentence-window-retriever popular?

The python package llama-index-packs-sentence-window-retriever receives a total of 206 weekly downloads. As such, llama-index-packs-sentence-window-retriever popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is llama-index-packs-sentence-window-retriever well maintained?

We found indications that llama-index-packs-sentence-window-retriever is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is llama-index-packs-sentence-window-retriever safe to use?

The python package llama-index-packs-sentence-window-retriever was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 October-2024, at 17:10 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP