Metadata-Version: 2.1
Name: arcee-py
Version: 0.0.7
Summary: Python client for Arcee platform
Home-page: https://arcee.ai/
Author: Arcee
Author-email: jacob@arcee.ai
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: black ==22.3.0 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'

# Arcee

The Arcee client for executing domain-adpated language model routines

## Installation

```
pip install arcee-py
```

## Authenticating

In bash:

```
export ARCEE_API_KEY=********
```

In notebook:

```
import os
os.environ["ARCEE_API_KEY"] = "********"
```

## Upload Context

Upload context for your domain adapted langauge model to draw from.

```
import arcee
arcee.upload_context("my_context", name="[name]", document_text="[text]")
```

## Train Retriever

Train a retriever to retrieve relevant documents for a given query.

```
import arcee
arcee.train_retriever("my_retriever", context_name="my_context")
```

Retriever training stands up a new index for your context. Future context uploads will flow into this index.

## Retrieve Documents

Retrieve documents for a given query.

```
import arcee
retriever = arcee.get_retriever("my_retriever")
retriever.retrieve("my query")
```


