Skip to main content

A library for semantic search in local environment

Project description

Forcolate Library

Build status Docs status Version Python Version Downloads License

Explore FORcolate docs »

AI search is like a box of FORcolates. You never know what you're gonna get.

Forcolate is a versatile library designed to enhance semantic search capabilities, in particular in a setting where it is deployed locally (and not in a cloud environment). It offers a suite of tools that facilitate efficient and intelligent search functionalities, making it easier to find relevant information within large datasets.

Features

  • Semantic Search Utilities wrapper: Utilize advanced semantic search algorithms to retrieve relevant information based on context and meaning, rather than simple keyword matching.
  • Outlook Email Search: Integrate semantic search with Microsoft Outlook using the Win32 API to search through emails intelligently.

Installation

To install the Forcolate library, use the following command:

pip install forcolate

Usage

Semantic Search for Outlook Emails

The Forcolate library includes a tool for performing semantic search on Outlook emails using the Win32 API. Below is an example of how to use this tool:

from forcolate import process_outlook_emails

save_directory = "path/to/save/directory"
query = "your search query"

file_paths = process_outlook_emails(save_directory, threshold, query, limit)
print(file_paths)

Contributing

Contributions to the Forcolate library are welcome! If you have ideas for new features, improvements, or bug fixes, please open an issue or submit a pull request.

Acknowledgement

This project received funding from the French ”IA Cluster” program within the Artificial and Natural Intelligence Toulouse Institute (ANITI) and from the "France 2030" program within IRT Saint Exupery. The authors gratefully acknowledge the support of the FOR projects.

License

This project is licensed under the MIT License. See the 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

forcolate-0.1.8.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

forcolate-0.1.8-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file forcolate-0.1.8.tar.gz.

File metadata

  • Download URL: forcolate-0.1.8.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for forcolate-0.1.8.tar.gz
Algorithm Hash digest
SHA256 2ea4b1bf5b8f41a40100f29e5f0cf1e5502b7939ce9fb4ae81ebfc9f82539aba
MD5 6519457019bb115e2d733c0635d1f014
BLAKE2b-256 62d917dfb012ebdaaf96a63d5c80b2f398f106b4af0c0177f22e5c8e5f0400fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for forcolate-0.1.8.tar.gz:

Publisher: publish.yml on FOR-sight-ai/FORcolate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file forcolate-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: forcolate-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for forcolate-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0395bcc3ac18e7dd7a9fac0fe8cee34bf569db54b8d21c1537ffe559ce305155
MD5 6eeb9b1ceb6ba181e1dfab0edbd38665
BLAKE2b-256 1cfe3406cb1d2263a1b55dc48746b95739447d1fcefd319d083f78df4c1e04d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for forcolate-0.1.8-py3-none-any.whl:

Publisher: publish.yml on FOR-sight-ai/FORcolate

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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