opik 1.6.4__py3-none-any.whl → 1.9.71__py3-none-any.whl

{opik-1.6.4.dist-info → opik-1.9.71.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

opik-1.9.71.dist-info/licenses/LICENSE

@@ -0,0 +1,203 @@
+Copyright (c) Comet ML, Inc
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Comet ML, Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

opik/api_objects/prompt/prompt.py

@@ -1,107 +0,0 @@
-import copy
-from typing import Any, Dict, Optional
-
-from opik.rest_api import PromptVersionDetail
-
-from . import prompt_template
-
-
-class Prompt:
-    """
-    Prompt class represents a prompt with a name, prompt text/template and commit hash.
-    """
-
-    def __init__(
-        self,
-        name: str,
-        prompt: str,
-        metadata: Optional[Dict[str, Any]] = None,
-    ) -> None:
-        """
-        Initializes a new instance of the class with the given parameters.
-        Creates a new prompt using the opik client and sets the initial state of the instance attributes based on the created prompt.
-
-        Parameters:
-            name: The name for the prompt.
-            prompt: The template for the prompt.
-        """
-        # We import opik client here to avoid circular import issue.
-        #
-        # Prompt object creation via `Prompt.__init__` is handled via creating a temporary
-        # instance with `client.get_prompt` (which uses `from_fern_prompt_version` classmethod
-        # constructor under the hood) and then copying its attributes to the current class.
-        #
-        # It is done to allow prompt creation both via `Prompt()` and `client.get_prompt()`
-        from opik.api_objects import opik_client
-
-        client = opik_client.get_client_cached()
-
-        new_instance = client.create_prompt(
-            name=name,
-            prompt=prompt,
-            metadata=metadata,
-        )
-
-        # TODO: synchronize names? Template and prompt.
-        # prompt is actually a prompt template.
-        self._template = prompt_template.PromptTemplate(new_instance.prompt)
-        self._name = new_instance.name
-        self._commit = new_instance.commit
-        self._metadata = new_instance.metadata
-
-        self.__internal_api__prompt_id__: str = new_instance.__internal_api__prompt_id__
-        self.__internal_api__version_id__: str = (
-            new_instance.__internal_api__version_id__
-        )
-
-    @property
-    def name(self) -> str:
-        """The name of the prompt."""
-        return self._name
-
-    @property
-    def prompt(self) -> str:
-        """The latest template of the prompt."""
-        return str(self._template)
-
-    @property
-    def commit(self) -> str:
-        """The commit hash of the prompt."""
-        return self._commit
-
-    @property
-    def metadata(self) -> Optional[Dict[str, Any]]:
-        """The metadata dictionary associated with the prompt"""
-        return copy.deepcopy(self._metadata)
-
-    def format(self, **kwargs: Any) -> str:
-        """
-        Replaces placeholders in the template with provided keyword arguments.
-
-        Args:
-            **kwargs: Arbitrary keyword arguments where the key represents the placeholder
-                      in the template and the value is the value to replace the placeholder with.
-
-        Returns:
-            A string with all placeholders replaced by their corresponding values from kwargs.
-        """
-        return self._template.format(**kwargs)
-
-    @classmethod
-    def from_fern_prompt_version(
-        cls,
-        name: str,
-        prompt_version: PromptVersionDetail,
-    ) -> "Prompt":
-        # will not call __init__ to avoid API calls, create new instance with __new__
-        prompt = cls.__new__(cls)
-
-        prompt.__internal_api__version_id__ = prompt_version.id
-        prompt.__internal_api__prompt_id__ = prompt_version.prompt_id
-
-        prompt._name = name
-        prompt._template = prompt_template.PromptTemplate(prompt_version.template)
-        prompt._commit = prompt_version.commit
-        prompt._metadata = prompt_version.metadata
-
-        return prompt

opik/api_objects/prompt/prompt_template.py

@@ -1,35 +0,0 @@
-import re
-from typing import Any, Set
-
-from opik import exceptions
-
-
-class PromptTemplate:
-    def __init__(self, template: str, validate_placeholders: bool = True) -> None:
-        self._template = template
-        self._placeholders = _extract_placeholder_keys(template)
-        self._validate_placeholders = validate_placeholders
-
-    def format(self, **kwargs: Any) -> str:
-        template = self._template
-        placeholders = self._placeholders
-
-        kwargs_keys: Set[str] = set(kwargs.keys())
-
-        if kwargs_keys != placeholders and self._validate_placeholders:
-            raise exceptions.PromptPlaceholdersDontMatchFormatArguments(
-                prompt_placeholders=placeholders, format_arguments=kwargs_keys
-            )
-
-        for key, value in kwargs.items():
-            template = template.replace(f"{{{{{key}}}}}", str(value))
-
-        return template
-
-    def __str__(self) -> str:
-        return self._template
-
-
-def _extract_placeholder_keys(prompt_template: str) -> Set[str]:
-    pattern = r"\{\{(.*?)\}\}"
-    return set(re.findall(pattern, prompt_template))

opik/cli.py

@@ -1,193 +0,0 @@
-"""CLI tool for Opik."""
-
-import logging
-import sys
-from importlib import metadata
-
-import click
-from rich.console import Console
-
-from opik import healthcheck as opik_healthcheck
-from opik.configurator import configure as opik_configure, interactive_helpers
-
-console = Console()
-
-LOGGER = logging.getLogger(__name__)
-
-__version__: str = "0.0.0+dev"
-if __package__:
-    __version__ = metadata.version(__package__)
-
-CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
-
-
-@click.group(invoke_without_command=True, context_settings=CONTEXT_SETTINGS)
-@click.version_option(__version__, *("--version", "-v"))
-def cli() -> None:
-    """CLI tool for Opik."""
-
-
-@cli.command(context_settings={"ignore_unknown_options": True})
-@click.option(
-    "--use_local",
-    "--use-local",
-    is_flag=True,
-    default=False,
-    help="Flag to configure the Opik Python SDK for local Opik deployments.",
-)
-@click.option(
-    "-y",
-    "--yes",
-    is_flag=True,
-    default=False,
-    help="Flag to automatically answer `yes` whenever a user approval might be required",
-)
-def configure(use_local: bool, yes: bool) -> None:
-    """
-    Create a configuration file for the Opik Python SDK, if a configuration file already exists, it will be overwritten.
-    This is also available as a function in the Python SDK.
-    """
-    automatic_approvals = yes
-
-    if use_local:
-        opik_configure.configure(
-            use_local=True, force=True, automatic_approvals=automatic_approvals
-        )
-    else:
-        deployment_type_choice = interactive_helpers.ask_user_for_deployment_type()
-
-        if deployment_type_choice == interactive_helpers.DeploymentType.CLOUD:
-            configurator = opik_configure.OpikConfigurator(
-                url=opik_configure.OPIK_BASE_URL_CLOUD,
-                use_local=False,
-                force=True,
-                self_hosted_comet=False,
-                automatic_approvals=automatic_approvals,
-            )
-        elif deployment_type_choice == interactive_helpers.DeploymentType.SELF_HOSTED:
-            configurator = opik_configure.OpikConfigurator(
-                use_local=False,
-                force=True,
-                self_hosted_comet=True,
-                automatic_approvals=automatic_approvals,
-            )
-        elif deployment_type_choice == interactive_helpers.DeploymentType.LOCAL:
-            configurator = opik_configure.OpikConfigurator(
-                use_local=True,
-                force=True,
-                self_hosted_comet=False,
-                automatic_approvals=automatic_approvals,
-            )
-        else:
-            LOGGER.error("Unknown deployment type was selected. Exiting.")
-            exit(1)
-
-        configurator.configure()
-
-
-@cli.command(context_settings={"ignore_unknown_options": True})
-@click.option(
-    "--ollama",
-    is_flag=True,
-    help="Run as a proxy server for Ollama",
-)
-@click.option(
-    "--ollama-host",
-    default="http://localhost:11434",
-    help="Ollama server URL when using --ollama-proxy",
-    show_default=True,
-)
-@click.option(
-    "--lm-studio",
-    is_flag=True,
-    help="Run as a proxy server for LM Studio",
-)
-@click.option(
-    "--lm-studio-host",
-    default="http://localhost:1234",
-    help="LM Studio server URL when using --lm-studio-proxy",
-    show_default=True,
-)
-@click.option(
-    "--host",
-    default="localhost",
-    help="Host to bind to",
-    show_default=True,
-)
-@click.option(
-    "--port",
-    default=7860,
-    help="Port to bind to",
-    show_default=True,
-)
-def proxy(
-    ollama: bool,
-    ollama_host: str,
-    lm_studio: bool,
-    lm_studio_host: str,
-    host: str,
-    port: int,
-) -> None:
-    """Start the Opik server."""
-    try:
-        import fastapi  # noqa
-        import uvicorn  # noqa
-        import httpx  # noqa
-        import rich  # noqa
-    except ImportError:
-        raise click.ClickException(
-            "Proxy server dependencies not found. Please install them with: pip install opik[proxy]"
-        )
-
-    if not ollama and not lm_studio:
-        click.echo(
-            "Error: Either --ollama or --lm-studio must be specified",
-            err=True,
-        )
-        sys.exit(1)
-
-    if ollama and lm_studio:
-        click.echo("Error: Cannot specify both --ollama and --lm-studio", err=True)
-        sys.exit(1)
-
-    if ollama:
-        llm_server_host = ollama_host
-        llm_server_type = "Ollama"
-    else:  # lm_studio_proxy
-        llm_server_host = lm_studio_host
-        llm_server_type = "LM Studio"
-
-    from opik.forwarding_server.app import create_app
-    from opik.forwarding_server.utils import print_server_startup_message
-    import uvicorn
-
-    app = create_app(llm_server_host)
-    print_server_startup_message(
-        host=host,
-        port=port,
-        llm_server_type=llm_server_type,
-        llm_server_host=llm_server_host,
-    )
-    uvicorn.run(
-        app, host=host, port=port, log_level="error"
-    )  # Reduce uvicorn logging to keep output clean
-
-
-@cli.command(context_settings={"ignore_unknown_options": True})
-@click.option(
-    "--show-installed-packages",
-    is_flag=True,
-    default=False,
-    help="Print the list of installed packages to the console.",
-)
-def healthcheck(show_installed_packages: bool = True) -> None:
-    """
-    Performs a health check of the application, including validation of configuration,
-    verification of library installations, and checking the availability of the backend workspace.
-    Prints all relevant information to assist in debugging and diagnostics.
-    """
-    opik_healthcheck.run(show_installed_packages)
-
-
-if __name__ == "__main__":
-    cli()

opik/evaluation/metrics/models.py

@@ -1,8 +0,0 @@
-import langchain_openai
-from typing import Any
-
-
-def get_chat_model(
-    model_name: str, *args: Any, **kwargs: Any
-) -> langchain_openai.ChatOpenAI:
-    return langchain_openai.ChatOpenAI(name=model_name, *args, **kwargs)

opik/hooks.py

@@ -1,13 +0,0 @@
-import httpx
-from typing import Callable, List
-
-_registered_httpx_client_hooks: List[Callable[[httpx.Client], None]] = []
-
-
-def register_httpx_client_hook(hook: Callable[[httpx.Client], httpx.Client]) -> None:
-    _registered_httpx_client_hooks.append(hook)
-
-
-def run_httpx_client_hooks(client: httpx.Client) -> None:
-    for hook in _registered_httpx_client_hooks:
-        hook(client)

opik/integrations/bedrock/chunks_aggregator.py

@@ -1,55 +0,0 @@
-import logging
-from typing import Any, List, Dict
-
-LOGGER = logging.getLogger(__name__)
-
-
-def aggregate_converse_stream_chunks(items: List[Dict[str, Any]]) -> Dict[str, Any]:
-    """
-    Implementation is based on the following AWS example (see the section `Conversation with streaming example`).
-    https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-examples.html
-    """
-
-    result: Dict[str, Any] = {
-        "output": {"message": {"role": "assistant", "content": [{"text": ""}]}}
-    }
-
-    for event in items:
-        if "messageStart" in event:
-            result["output"]["message"]["role"] = event["messageStart"]["role"]
-
-        if "contentBlockDelta" in event:
-            result["output"]["message"]["content"][0]["text"] += event[
-                "contentBlockDelta"
-            ]["delta"]["text"]
-
-        if "messageStop" in event:
-            result["stopReason"] = event["messageStop"]["stopReason"]
-
-        if "metadata" in event:
-            metadata = event["metadata"]
-            if "usage" in metadata:
-                result["usage"] = metadata["usage"]
-            if "metrics" in event["metadata"]:
-                result["metrics"] = {}
-                result["metrics"]["latencyMs"] = metadata["metrics"]["latencyMs"]
-
-    return result
-
-
-def aggregate_invoke_agent_chunks(items: List[Dict[str, Any]]) -> Dict[str, Any]:
-    """
-    The implementation was supposed to follow Amazon's documentation,
-    https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock-agent-runtime/client/invoke_agent.html
-    but at the time of writing this code, the `completion` payload only contains `chunks` and nothing else.
-    So, a simpler parsing approach was used.
-    """
-    merged_chunks = b""
-
-    for item in items:
-        if "chunk" in item:
-            merged_chunks += item["chunk"]["bytes"]
-
-    result: Dict[str, Any] = {"output": merged_chunks.decode("utf-8")}
-
-    return result

opik/integrations/bedrock/helpers.py

@@ -1,8 +0,0 @@
-from typing import Any, Dict, TypedDict
-
-from botocore import eventstream
-
-
-class ConverseStreamOutput(TypedDict):
-    stream: eventstream.EventStream
-    ResponseMetadata: Dict[str, Any]