Page cover

Quickstart

Getting started with NeoAthena is incredibly simple:

  1. Create your account - Sign up here

  2. Generate an API key - Find this in your account settings

  3. Upload your first document - Either through the Web UI or using our API/SDK

  4. Start retrieving information - Query your documents using natural language

Using the Python SDK

After completing the steps above, you can immediately start using NeoAthena with just a few lines of code:

Prerequisites

  • You’ll need an API key to get started

  • Python 3.10 or higher installed on your system

Installation

Install our Python package:

pip install neoathena

Quick Implementation

from neoathena import NeoAthenaClient

# Initialize client with your API key
client = NeoAthenaClient(api_key="your-api-key")

# Upload a document to a collection
client.upload_to_collection(
    collection_name="my_first_collection",
    filepath="path/to/document.pdf"
)

# Retrieve information using natural language
results = client.retrieve_from_collection(
    collection_name="my_first_collection",
    query="What are the key points in this document?",
    top_k=3
)

# Print the results
print(results)

Next Steps

  1. For Python library users, refer to the Python SDK Guide for in-depth details on integrating with the neoathena package.

  2. For a detailed API reference, see the API Reference section.

  3. View example implementations for common use cases.

Last updated

Was this helpful?