Skip to main content

Smartloop Command Line interface to process documents using LLM

Project description


Use the CLI to upload, manage, and query documents based on fine-tuned LLM models. It uses the smartloop API to manage projects and documents and gives you an easy way to quickly process contents and reason based on it.

PyPI - Version

Requirements

  • Python 3.11

Installation

Install the CLI with the following command:

pip install -U smartloop

Once installed, check that everything is setup correctly:

image

Creating an Account

First create an account using the curl command below, in Linux / macOS / WSL 2.0 / Ubuntu:

curl --location --request PUT 'https://api.smartloop.ai/v1/users' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
  "email": "<string>",
  "password": "<string>",
  "name": "<string>"
}'

You will receive an email with the token that is needed to login into the CLI.

Setup

Login to the CLI in the following way using the token received in email:

smartloop login

This command will prompt you for your token, copy and pase the token that you have received in your email. Next step it to create a project, you can do so with the following command:

smartloop project create --name Lexic

To get the project Id , use the following, the will also show you the currently selected project:

smartloop project list

To delete a project, use:

smartloop project delete --id=project_id

Upload Document

Once the project is created , upload documents from your folder or a specific file, in this case I am uploading the a document describing Microsoft online services form my local machine

smartloop upload --id=<project_id> --path=~/document1.pdf

Select a project

Use the following command to interactively select a project:

smartloop project select

Run It

Finally, once project is selected, document you have uploaded and processed, run the CLI to prompt:

smartloop run

This will bring up the prompt to query your information from your uploaded document

Current project: Microsoft(microsoft-24-07-2024)
Enter message (Ctrl-C to exit): what the SLA for azure open ai
⠋
The SLA (Service Level Agreement) for Azure OpenAI is not explicitly mentioned in the provided text. However, it's possible that the SLA for Azure OpenAI might be similar to the one mentioned below:

"Uptime Percentage"

* Service Credit:
+ < 99.9%: 10%
+ < 99%: 25%
+ < 95%: 100%

Please note that this is not a direct quote from the provided text, but rather an inference based on the format and structure of the SLA mentioned for other Azure services (e.g., SAP HANA on Azure High Availability Pair). To confirm the actual SLA for Azure OpenAI, you should check the official Microsoft documentation or contact their support team.

Enter message (Ctrl-C to exit):

In order to set temperature of your conversation, which ranges from 0.0 to 1.0, use the following command:

smartloop project set --id=project_id --temp=0.3

LLM temperature is a parameter that influences the language model's output, determining whether the output is more random and creative or more predictable.

The higher value tends towards more creative answer

Supported Documents types

  • PDF
  • DOCX
  • TXT
  • CSV (soon)

Contributing

Contributions are welcome! Please create a pull request with your changes.

Contact

If you have any questions or suggestions, please feel free to reach out to hello@smartloop.ai

References

License

This project is licensed under the terms of the MIT license.

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

smartloop-1.1.4.tar.gz (11.0 kB view hashes)

Uploaded Source

Built Distribution

smartloop-1.1.4-py3-none-any.whl (11.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page