not-again-ai 0.4.0__tar.gz → 0.4.1__tar.gz

{not_again_ai-0.4.0 → not_again_ai-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: not-again-ai
-Version: 0.4.0
+Version: 0.4.1
 Summary: Designed to once and for all collect all the little things that come up over and over again in AI projects and put them in one place.
 Home-page: https://github.com/DaveCoDev/not-again-ai
 License: MIT
@@ -79,6 +79,15 @@ The base package includes only functions that have minimal external dependencies
 ## LLM (Large Language Model)
 [README](https://github.com/DaveCoDev/not-again-ai/blob/main/readmes/llm.md)
 
+Supports OpenAI chat completions and text embeddings. Includes functions for creating chat completion prompts, token management, and context management.
+
+One example: 
+```python
+client = openai_client()
+messages = [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Hello!"}]
+response = chat_completion(messages=messages, model="gpt-3.5-turbo", max_tokens=100, client=client)["message"]
+>>> "Hello! How can I help you today?"
+```
 
 ## Statistics
 [README](https://github.com/DaveCoDev/not-again-ai/blob/main/readmes/statistics.md)

{not_again_ai-0.4.0 → not_again_ai-0.4.1}/README.md

@@ -44,6 +44,15 @@ The base package includes only functions that have minimal external dependencies
 ## LLM (Large Language Model)
 [README](https://github.com/DaveCoDev/not-again-ai/blob/main/readmes/llm.md)
 
+Supports OpenAI chat completions and text embeddings. Includes functions for creating chat completion prompts, token management, and context management.
+
+One example: 
+```python
+client = openai_client()
+messages = [{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Hello!"}]
+response = chat_completion(messages=messages, model="gpt-3.5-turbo", max_tokens=100, client=client)["message"]
+>>> "Hello! How can I help you today?"
+```
 
 ## Statistics
 [README](https://github.com/DaveCoDev/not-again-ai/blob/main/readmes/statistics.md)

{not_again_ai-0.4.0 → not_again_ai-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "not-again-ai"
-version = "0.4.0"
+version = "0.4.1"
 description = "Designed to once and for all collect all the little things that come up over and over again in AI projects and put them in one place."
 authors = ["DaveCoDev <dave.co.dev@gmail.com>"]
 license = "MIT"

not_again_ai-0.4.1/src/not_again_ai/llm/embeddings.py

@@ -0,0 +1,62 @@
+from typing import Any
+
+from openai import OpenAI
+
+
+def embed_text(
+    text: str | list[str],
+    client: OpenAI,
+    model: str = "text-embedding-3-large",
+    dimensions: int | None = None,
+    encoding_format: str = "float",
+    **kwargs: Any,
+) -> list[float] | str | list[list[float]] | list[str]:
+    """Generates an embedding vector for a given text using OpenAI's API.
+
+    Args:
+        text (str | list[str]): The input text to be embedded. Each text should not exceed 8191 tokens, which is the max for V2 and V3 models
+        client (OpenAI): The OpenAI client used to interact with the API.
+        model (str, optional): The ID of the model to use for embedding.
+            Defaults to "text-embedding-3-large".
+            Choose from text-embedding-3-small, text-embedding-3-large, text-embedding-ada-002.
+            See https://platform.openai.com/docs/models/embeddings for more details.
+        dimensions (int | None, optional): The number of dimensions for the output embeddings.
+            This is only supported in "text-embedding-3" and later models. Defaults to None.
+        encoding_format (str, optional): The format for the returned embeddings. Can be either "float" or "base64".
+            Defaults to "float".
+
+    Returns:
+        list[float] | str | list[list[float]] | list[str]: The embedding vector represented as a list of floats or base64 encoded string.
+            If multiple text inputs are provided, a list of embedding vectors is returned.
+            The length and format of the vector depend on the model, encoding_format, and dimensions.
+
+    Raises:
+        ValueError: If 'text-embedding-ada-002' model is used and dimensions are specified,
+            as this model does not support specifying dimensions.
+
+    Example:
+        client = OpenAI()
+        embedding = embed_text("Example text", client, model="text-embedding-ada-002")
+    """
+    if model == "text-embedding-ada-002" and dimensions:
+        # text-embedding-ada-002 does not support dimensions
+        raise ValueError("text-embedding-ada-002 does not support dimensions")
+
+    kwargs = {
+        "model": model,
+        "input": text,
+        "encoding_format": encoding_format,
+    }
+    if dimensions:
+        kwargs["dimensions"] = dimensions
+
+    response = client.embeddings.create(**kwargs)
+
+    responses = []
+    for embedding in response.data:
+        responses.append(embedding.embedding)
+
+    if len(responses) == 1:
+        return responses[0]
+
+    return responses