Skip to main content

A comprehensive SDK for standardizing, processing, embedding, and retrieving data for AI applications

Project description

AI Data SDK by Zeebee

A comprehensive SDK for standardizing, processing, embedding, and retrieving data for AI applications.

Features

  • Text embedding generation
  • Semantic search with filtering
  • PII detection and masking/anonymization
  • User feedback submission
  • IP allowlist management (admin only)

Installation

pip install ai-data-sdk-zeebee==0.1.3

Usage

Initialize Client

from ai_data_sdk import AIDataClient

# Initialize with your API key
client = AIDataClient(api_key="your_api_key_here")

Generate Embeddings

# Generate embeddings for a list of texts
texts = [
    "AI Data SDK helps standardize data for AI applications.",
    "The embedding module converts text into vector representations."
]

# Optional metadata for each text
metadata = [
    {"source": "documentation", "category": "overview"},
    {"source": "documentation", "category": "technical"}
]

result = client.create_embeddings(
    texts=texts,
    model="text-embedding-3-small",
    normalize=True,
    metadata=metadata
)

Search for Similar Documents

# Basic search with query text
search_result = client.search(query="How do machines learn from data?")

# Search with vector embedding
embedding = [0.1, 0.2, 0.3, ...]  # Your embedding vector
search_result = client.search(embedding=embedding, top_k=5)

# Advanced search with filters
filters = {
    "category": "technology",
    "rating": {"$gt": 4.5}
}

search_result = client.search(
    query="neural networks",
    filters=filters,
    top_k=10
)

Detect and Mask PII

# Basic PII detection
text = "My email is john.doe@example.com and my phone is 555-123-4567."
result = client.detect_pii(
    text=text,
    pii_types=["email", "phone"]
)

# PII detection with masking
result = client.detect_pii(
    text=text,
    pii_types=["email", "phone"],
    mask_pii=True,
    mask_type="type",
    preserve_length=False,
    resolve_overlaps=True
)

# Advanced PII anonymization
result = client.anonymize_pii(
    text=text,
    pii_types=["email", "phone", "name"],
    consistent_replacements=True,
    resolve_overlaps=True
)

Submit Feedback

feedback = client.submit_feedback(
    query_id="q_12345",
    result_id="doc_1",
    rating=4,
    comments="Very relevant result, but missing some details."
)

Error Handling

from ai_data_sdk import APIError, AuthenticationError, InvalidRequestError, RateLimitError

try:
    result = client.create_embeddings(texts)
except AuthenticationError:
    print("Authentication failed. Check your API key.")
except InvalidRequestError as e:
    print(f"Invalid request: {e}")
except RateLimitError:
    print("Rate limit exceeded. Please try again later.")
except APIError as e:
    print(f"API error: {e}")

Documentation

For full documentation, visit https://ai-data-sdk.readthedocs.io/

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

ai_data_sdk_zeebee-0.1.3.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

ai_data_sdk_zeebee-0.1.3-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_data_sdk_zeebee-0.1.3.tar.gz.

File metadata

  • Download URL: ai_data_sdk_zeebee-0.1.3.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for ai_data_sdk_zeebee-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8aec0f20606797eadd12fad81f2f9a5b711658eb9e9d55bb62824f1a08c329f7
MD5 e52681a6c9a0274f71640738082f309a
BLAKE2b-256 1ae2726293314b50730ecfe52e986bb8acd1195cdc76b68d98c2133a36f3d1b8

See more details on using hashes here.

File details

Details for the file ai_data_sdk_zeebee-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_data_sdk_zeebee-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ed66e4c823ea6ebfd110e8b1a92ddd498e1b278a9e5170192dfbaeef8a4b22ce
MD5 25c7721ba6bc11084443dac92a5b0b0d
BLAKE2b-256 7331673c51893312c1c09baff3224b696e75d2dc778668bb122eb0813d33dc21

See more details on using hashes here.

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