lionagi 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

lionagi/integrations/openai_/api_endpoints/chat_completions/response/response_body.py

@@ -0,0 +1,99 @@
+from typing import List, Literal, Optional
+
+from pydantic import Field
+
+from ...data_models import OpenAIEndpointResponseBody
+from .choice_models import Choice, ChunkChoice
+from .usage_models import Usage
+
+
+class OpenAIChatCompletionResponseBody(OpenAIEndpointResponseBody):
+    id: str = Field(description="A unique identifier for the chat completion.")
+
+    choices: list[Choice] = Field(
+        description=(
+            "A list of chat completion choices. Can be more than one if n "
+            "is greater than 1."
+        )
+    )
+
+    created: int = Field(
+        description=(
+            "The Unix timestamp (in seconds) of when the chat completion "
+            "was created."
+        )
+    )
+
+    model: str = Field(description="The model used for the chat completion.")
+
+    service_tier: str | None = Field(
+        None,
+        description=(
+            "The service tier used for processing the request. This field is "
+            "only included if the service_tier parameter is specified in the "
+            "request."
+        ),
+    )
+
+    system_fingerprint: str = Field(
+        description=(
+            "This fingerprint represents the backend configuration that the "
+            "model runs with. Can be used in conjunction with the seed "
+            "request parameter to understand when backend changes have been "
+            "made that might impact determinism."
+        )
+    )
+
+    object: Literal["chat.completion"] = Field(
+        description="The object type, which is always chat.completion."
+    )
+
+    usage: Usage = Field(
+        description="Usage statistics for the completion request."
+    )
+
+
+class OpenAIChatCompletionChunkResponseBody(OpenAIEndpointResponseBody):
+    id: str = Field(description="A unique identifier for the chat completion.")
+
+    choices: list[ChunkChoice] = Field(
+        description=(
+            "A list of chat completion choices. Can be more than one if n "
+            "is greater than 1."
+        )
+    )
+
+    created: int = Field(
+        description=(
+            "The Unix timestamp (in seconds) of when the chat completion "
+            "was created."
+        )
+    )
+
+    model: str = Field(description="The model used for the chat completion.")
+
+    service_tier: str | None = Field(
+        None,
+        description=(
+            "The service tier used for processing the request. This field is "
+            "only included if the service_tier parameter is specified in the "
+            "request."
+        ),
+    )
+
+    system_fingerprint: str = Field(
+        description=(
+            "This fingerprint represents the backend configuration that the "
+            "model runs with. Can be used in conjunction with the seed "
+            "request parameter to understand when backend changes have been "
+            "made that might impact determinism."
+        )
+    )
+
+    object: Literal["chat.completion.chunk"] = Field(
+        description="The object type, which is always chat.completion."
+    )
+
+    usage: Usage | None = Field(
+        None, description="Usage statistics for the completion request."
+    )

lionagi/integrations/openai_/api_endpoints/chat_completions/response/types.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class FinishReason(str, Enum):
+    STOP = "stop"
+    LENGTH = "length"
+    CONTENT_FILTER = "content_filter"
+    TOOL_CALLS = "tool_calls"

lionagi/integrations/openai_/api_endpoints/chat_completions/response/usage_models.py

@@ -0,0 +1,24 @@
+from pydantic import BaseModel, Field
+
+
+class CompletionTokensDetails(BaseModel):
+    reasoning_tokens: int = Field(
+        description="Tokens generated by the model for reasoning."
+    )
+
+
+class Usage(BaseModel):
+    completion_tokens: int = Field(
+        description="Number of tokens in the generated completion."
+    )
+
+    prompt_tokens: int = Field(description="Number of tokens in the prompt.")
+
+    total_tokens: int = Field(
+        description="Total number of tokens used in the"
+        " request (prompt + completion)"
+    )
+
+    completion_tokens_details: CompletionTokensDetails = Field(
+        description="Breakdown of tokens used in a completion."
+    )

lionagi/integrations/openai_/api_endpoints/chat_completions/util.py

@@ -0,0 +1,46 @@
+from .request.request_body import OpenAIChatCompletionRequestBody
+
+
+def get_text_messages(request_body: OpenAIChatCompletionRequestBody):
+    messages_list = request_body.model_dump(exclude_unset=True).get("messages")
+    parsed_str = "["
+
+    for msg in messages_list:
+        role = msg.get("role", "")
+        content = msg.get("content", "")
+
+        if isinstance(
+            content, list
+        ):  # Check if content is a list (second example)
+            content_str = []
+            for sub_content in content:
+                if sub_content.get("type") == "text":
+                    content_str.append(f'{sub_content.get("text", "")}')
+            content = " ".join(
+                content_str
+            )  # Combine all sub_content items into a single string
+        parsed_str += f"role: {role} content: {content} "
+
+    parsed_str = parsed_str.strip()  # Remove trailing space
+    parsed_str += "]"
+
+    return parsed_str
+
+
+def get_images(request_body: OpenAIChatCompletionRequestBody):
+    messages_list = request_body.model_dump(exclude_unset=True).get("messages")
+    image_urls = []
+
+    for msg in messages_list:
+        content = msg.get("content", "")
+
+        if isinstance(
+            content, list
+        ):  # Check if content is a list (second example)
+            for sub_content in content:
+                if sub_content.get("type") == "image_url":
+                    image_url = sub_content.get("image_url")
+                    url = image_url.get("url")
+                    detail = image_url.get("detail", "auto")
+                    image_urls.append((url, detail))
+    return image_urls

lionagi/integrations/openai_/api_endpoints/data_models.py

@@ -0,0 +1,23 @@
+from pydantic import BaseModel, ConfigDict
+
+
+class OpenAIEndpointRequestBody(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid", use_enum_values=True, validate_assignment=True
+    )
+
+
+class OpenAIEndpointResponseBody(BaseModel):
+    model_config = ConfigDict(use_enum_values=True, validate_assignment=True)
+
+
+class OpenAIEndpointQueryParam(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid", use_enum_values=True, validate_assignment=True
+    )
+
+
+class OpenAIEndpointPathParam(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid", use_enum_values=True, validate_assignment=True
+    )

lionagi/integrations/openai_/api_endpoints/embeddings/__init__.py

@@ -0,0 +1,3 @@
+from .request_body import OpenAIEmbeddingRequestBody
+
+__all__ = [OpenAIEmbeddingRequestBody]

lionagi/integrations/openai_/api_endpoints/embeddings/request_body.py

@@ -0,0 +1,79 @@
+from typing import List, Literal, Optional, Union
+
+from pydantic import ConfigDict, Field, model_validator
+
+from ..data_models import OpenAIEndpointRequestBody
+
+InputType = Union[str, list[str], list[int], list[list[int]]]
+EncodingFormat = Literal["float", "base64"]
+
+
+class OpenAIEmbeddingRequestBody(OpenAIEndpointRequestBody):
+    input: InputType = Field(
+        description=(
+            "Input text to embed, encoded as a string or array of tokens. "
+            "To embed multiple inputs in a single request, pass an array of "
+            "strings or array of token arrays. The input must not exceed "
+            "the max input tokens for the model (8192 tokens for "
+            "text-embedding-ada-002), cannot be an empty string, and any "
+            "array must be 2048 dimensions or less."
+        ),
+    )
+
+    model: str = Field(
+        description=(
+            "ID of the model to use. You can use the List models API to see "
+            "all of your available models, or see our Model overview for "
+            "descriptions of them."
+        ),
+    )
+
+    encoding_format: EncodingFormat | None = Field(
+        "float",
+        description=(
+            "The format to return the embeddings in. Can be either `float` "
+            "or `base64`."
+        ),
+    )
+
+    dimensions: int | None = Field(
+        None,
+        description=(
+            "The number of dimensions the resulting output embeddings "
+            "should have. Only supported in `text-embedding-3` and later "
+            "models."
+        ),
+    )
+
+    user: str | None = Field(
+        None,
+        description=(
+            "A unique identifier representing your end-user, which can help "
+            "OpenAI to monitor and detect abuse."
+        ),
+    )
+
+    @model_validator(mode="after")
+    def validate_input(self) -> "OpenAIEmbeddingRequestBody":
+        if isinstance(self.input, str) and self.input.strip() == "":
+            raise ValueError("Input cannot be an empty string.")
+        if isinstance(self.input, list):
+            if len(self.input) == 0:
+                raise ValueError("Input array cannot be empty.")
+            if isinstance(self.input[0], list) and len(self.input) > 2048:
+                raise ValueError(
+                    "Input array must be 2048 dimensions or less."
+                )
+        return self
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "input": "The food was delicious and the waiter...",
+                "model": "text-embedding-ada-002",
+                "encoding_format": "float",
+                "dimensions": None,
+                "user": "user123",
+            }
+        }
+    )

lionagi/integrations/openai_/api_endpoints/embeddings/response_body.py

@@ -0,0 +1,67 @@
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from ..data_models import OpenAIEndpointResponseBody
+
+
+class EmbeddingObject(BaseModel):
+    index: int = Field(
+        description="The index of the embedding in the list of embeddings."
+    )
+
+    embedding: list[float] = Field(
+        description=(
+            "The embedding vector, which is a list of floats. The length of "
+            "vector depends on the model as listed in the embedding guide."
+        ),
+    )
+
+    object: Literal["embedding"] = Field(
+        "embedding",
+        description='The object type, which is always "embedding".',
+    )
+
+
+class Usage(BaseModel):
+    prompt_tokens: int = Field(description="Number of tokens in the prompt.")
+
+    total_tokens: int = Field(
+        description="Total number of tokens used in "
+        "the request (prompt + completion)"
+    )
+
+
+class OpenAIEmbeddingResponseBody(OpenAIEndpointResponseBody):
+    object: Literal["list"] = Field(
+        description='The object type, which is always "list" for embeddings.'
+    )
+    data: list[EmbeddingObject] = Field(
+        description="The list of embedding objects."
+    )
+    model: str = Field(
+        description="The ID of the model used to generate the embeddings."
+    )
+    usage: Usage = Field(description="The usage statistics for the request.")
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "example": {
+                "object": "list",
+                "data": [
+                    {
+                        "index": 0,
+                        "embedding": [
+                            0.0023064255,
+                            -0.009327292,
+                            ...,
+                            -0.0028842222,
+                        ],
+                        "object": "embedding",
+                    }
+                ],
+                "model": "text-embedding-ada-002",
+                "usage": {"prompt_tokens": 8, "total_tokens": 8},
+            }
+        }
+    )

lionagi/integrations/openai_/api_endpoints/files/__init__.py

@@ -0,0 +1,11 @@
+from .delete_file import OpenAIDeleteFilePathParam
+from .list_files import OpenAIListFilesQueryParam
+from .retrieve_file import OpenAIRetrieveFilePathParam
+from .upload_file import OpenAIUploadFileRequestBody
+
+__all__ = [
+    "OpenAIUploadFileRequestBody",
+    "OpenAIListFilesQueryParam",
+    "OpenAIRetrieveFilePathParam",
+    "OpenAIDeleteFilePathParam",
+]

lionagi/integrations/openai_/api_endpoints/files/delete_file.py

@@ -0,0 +1,20 @@
+from pydantic import Field
+
+from ..data_models import OpenAIEndpointPathParam, OpenAIEndpointResponseBody
+
+
+class OpenAIDeleteFilePathParam(OpenAIEndpointPathParam):
+    file_id: str = Field(
+        description="The ID of the file to use for this request."
+    )
+
+
+class OpenAIDeleteFileResponseBody(OpenAIEndpointResponseBody):
+    id: str = Field(
+        description="The file identifier, which can be referenced "
+        "in the API endpoints.",
+    )
+
+    object: str = Field(description="The object type, which is always file.")
+
+    deleted: bool = Field(description="The deletion status")

lionagi/integrations/openai_/api_endpoints/files/file_models.py

@@ -0,0 +1,56 @@
+from enum import Enum
+
+from pydantic import Field
+
+from ..data_models import OpenAIEndpointResponseBody
+
+
+class Purpose(str, Enum):
+    ASSISTANTS = "assistants"
+    ASSISTANTS_OUTPUT = "assistants_output"
+    VISION = "vision"
+    BATCH = "batch"
+    BATCH_OUTPUT = "batch_output"
+    FINE_TUNE = "fine-tune"
+    FINE_TUNE_RESULTS = "fine-tune-results"
+
+
+class Status(str, Enum):
+    UPLOADED = "uploaded"
+    PROCESSED = "processed"
+    ERROR = "error"
+
+
+class OpenAIFileResponseBody(OpenAIEndpointResponseBody):
+    id: str = Field(
+        description="The file identifier, which can be "
+        "referenced in the API endpoints.",
+    )
+
+    bytes: int = Field(description="The size of the file, in bytes.")
+
+    created_at: int = Field(
+        description="The Unix timestamp (in seconds) for "
+        "when the file was created.",
+    )
+
+    filename: str = Field(description="The name of the file.")
+
+    object: str = Field(description="The object type, which is always file.")
+
+    purpose: Purpose = Field(description="The intended purpose of the file.")
+
+    status: Status = Field(
+        None,
+        description="The current status of the file, which can be "
+        "either uploaded, processed, or error.",
+        deprecated=True,
+    )
+
+    status_details: str | None = Field(
+        None,
+        description="For details on why a fine-tuning training "
+        "file failed validation, "
+        "see the error field on fine_tuning.job.",
+        deprecated=True,
+    )

lionagi/integrations/openai_/api_endpoints/files/list_files.py

@@ -0,0 +1,27 @@
+from typing import List, Literal, Optional
+
+from pydantic import Field
+
+from ..data_models import OpenAIEndpointQueryParam, OpenAIEndpointResponseBody
+from .file_models import OpenAIFileResponseBody
+
+
+class OpenAIListFilesQueryParam(OpenAIEndpointQueryParam):
+    purpose: str | None = Field(
+        description="Only return files with the given purpose."
+    )
+
+
+class OpenAIListFilesResponseBody(OpenAIEndpointResponseBody):
+    data: list[OpenAIFileResponseBody] = Field(
+        description="The list of file objects."
+    )
+
+    object: Literal["list"] = Field(
+        description='The object type, which is always "list".'
+    )
+
+    has_more: bool = Field(
+        description="Whether there are more results"
+        " available after this batch."
+    )

lionagi/integrations/openai_/api_endpoints/files/retrieve_file.py

@@ -0,0 +1,9 @@
+from pydantic import Field
+
+from ..data_models import OpenAIEndpointPathParam
+
+
+class OpenAIRetrieveFilePathParam(OpenAIEndpointPathParam):
+    file_id: str = Field(
+        description="The ID of the file to use for this request."
+    )

lionagi/integrations/openai_/api_endpoints/files/upload_file.py

@@ -0,0 +1,38 @@
+from enum import Enum
+from typing import IO
+
+from pydantic import ConfigDict, Field, field_validator
+
+from ..data_models import OpenAIEndpointRequestBody
+
+
+class Purpose(str, Enum):
+    ASSISTANT = "assistant"
+    VISION = "vision"
+    BATCH = "batch"
+    FINE_TUNE = "fine-tune"
+
+
+class OpenAIUploadFileRequestBody(OpenAIEndpointRequestBody):
+    file: str | IO = Field(
+        description="The File object (not file name) to be uploaded."
+    )
+
+    purpose: Purpose = Field(
+        description="The intended purpose of the uploaded file."
+    )
+
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    @field_validator("file")
+    @classmethod
+    def get_file_object(cls, value):
+        if isinstance(value, str):
+            value = open(value, "rb")
+        return value
+
+    def __del__(self):
+        # Ensure the file is closed when the object is destroyed
+        file_obj = self.__dict__.get("file")
+        if file_obj and not file_obj.closed:
+            file_obj.close()

lionagi/integrations/openai_/api_endpoints/fine_tuning/__init__.py

@@ -0,0 +1,37 @@
+from .cancel_jobs import OpenAICancelFineTuningPathParam
+from .create_jobs import (
+    Hyperparameters,
+    Integration,
+    OpenAICreateFineTuningJobRequestBody,
+    Wandb,
+)
+from .list_fine_tuning_checkpoints import (
+    OpenAIListFineTuningCheckpointsPathParam,
+    OpenAIListFineTuningCheckpointsQueryParam,
+)
+from .list_fine_tuning_events import (
+    OpenAIListFineTuningEventsPathParam,
+    OpenAIListFineTuningEventsQueryParam,
+)
+from .list_fine_tuning_jobs import OpenAIListFineTuningJobsQueryParam
+from .retrieve_jobs import OpenAIRetrieveFineTuningJobPathParam
+from .training_format import (
+    OpenAIChatModelTrainingFormat,
+    OpenAICompletionsModelTrainingFormat,
+)
+
+__all__ = [
+    "OpenAICreateFineTuningJobRequestBody",
+    "Hyperparameters",
+    "Integration",
+    "Wandb",
+    "OpenAIListFineTuningJobsQueryParam",
+    "OpenAIListFineTuningEventsPathParam",
+    "OpenAIListFineTuningEventsQueryParam",
+    "OpenAIListFineTuningCheckpointsPathParam",
+    "OpenAIListFineTuningCheckpointsQueryParam",
+    "OpenAIRetrieveFineTuningJobPathParam",
+    "OpenAICancelFineTuningPathParam",
+    "OpenAIChatModelTrainingFormat",
+    "OpenAICompletionsModelTrainingFormat",
+]

lionagi/integrations/openai_/api_endpoints/fine_tuning/cancel_jobs.py

@@ -0,0 +1,9 @@
+from pydantic import Field
+
+from ..data_models import OpenAIEndpointPathParam
+
+
+class OpenAICancelFineTuningPathParam(OpenAIEndpointPathParam):
+    fine_tuning_job_id: str = Field(
+        description="The ID of the fine-tuning job to get events for."
+    )