splunk-ao 0.1.0__py3-none-any.whl

splunk_ao/README_API_CLIENT.md

@@ -0,0 +1,107 @@
+# Splunk AO API client
+
+A client library for accessing the Splunk AO platform API
+
+## Usage
+
+This is the low-level client generated from the platform API schema. It does
+not read `SPLUNK_AO_*` environment variables or perform deployment-aware
+configuration. Most applications should use the public Splunk AO SDK APIs,
+which configure authentication and endpoints automatically.
+
+When using the generated client directly, provide its base URL and any
+required authentication headers explicitly:
+
+```python
+from splunk_ao.resources.client import Client
+
+client = Client(
+    base_url="https://your-splunk-ao-instance",
+    headers={"your-auth-header": "your-token"},
+)
+```
+
+Now call your endpoint and use your models:
+
+```python
+from splunk_ao.resources.models import MyDataModel
+from splunk_ao.resources.api.my_tag import get_my_data_model
+from splunk_ao.resources.types import Response
+
+my_data: MyDataModel = get_my_data_model.sync(client=client)
+# or if you need more info (e.g. status_code)
+response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from splunk_ao.resources.models import MyDataModel
+from splunk_ao.resources.api.my_tag import get_my_data_model
+from splunk_ao.resources.types import Response
+
+my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+# or if you need more info (e.g. status_code)
+response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = Client(
+    base_url="https://your-splunk-ao-instance",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = Client(base_url="https://your-splunk-ao-instance", verify_ssl=False)
+```
+
+Things to know:
+
+1. Every path/method combo becomes a Python module with four functions:
+
+   1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+   1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+   1. `asyncio`: Like `sync` but async instead of blocking
+   1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `splunk_ao.api.default`
+
+## Advanced customizations
+
+There are more settings on the `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from splunk_ao.resources.client import Client
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+client = Client(
+    base_url="https://your-splunk-ao-instance",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from splunk_ao.resources.client import Client
+
+client = Client(base_url="https://your-splunk-ao-instance")
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url=base_url, proxies="http://localhost:8030"))
+```

splunk_ao/__future__/__init__.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from galileo_core.schemas.logging.llm import MessageRole
+from galileo_core.schemas.logging.step import StepType
+from splunk_ao.collaborator import Collaborator, CollaboratorRole
+from splunk_ao.configuration import Configuration
+from splunk_ao.dataset import Dataset
+from splunk_ao.experiment import Experiment
+from splunk_ao.integration import Integration
+from splunk_ao.agent_stream import AgentStream
+from splunk_ao.evaluator import BuiltInEvaluators, CodeEvaluator, Evaluator, LlmEvaluator, LocalEvaluator, SplunkAOEvaluator
+from splunk_ao.model import Model
+from splunk_ao.project import Project
+from splunk_ao.prompt import Prompt
+from splunk_ao.schema.message import Message
+from splunk_ao.search import RecordType
+from splunk_ao.shared.exceptions import (
+    APIError,
+    ConfigurationError,
+    ResourceConflictError,
+    ResourceNotFoundError,
+    SplunkAOFutureError,
+    ValidationError,
+)
+from splunk_ao.utils.log_config import enable_console_logging
+
+__all__ = [
+    "APIError",
+    "AgentStream",
+    "BuiltInEvaluators",
+    "CodeEvaluator",
+    "Collaborator",
+    "CollaboratorRole",
+    "Configuration",
+    "ConfigurationError",
+    "Dataset",
+    "Evaluator",
+    "Experiment",
+    "Integration",
+    "LlmEvaluator",
+    "LocalEvaluator",
+    "Message",
+    "MessageRole",
+    "Model",
+    "Project",
+    "Prompt",
+    "RecordType",
+    "ResourceConflictError",
+    "ResourceNotFoundError",
+    "SplunkAOEvaluator",
+    "SplunkAOFutureError",
+    "StepType",
+    "ValidationError",
+    "enable_console_logging",
+]

splunk_ao/__future__/collaborator.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.collaborator instead of splunk_ao.__future__.collaborator."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.collaborator is deprecated. Use splunk_ao.collaborator instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.collaborator import Collaborator, CollaboratorRole  # noqa: E402
+
+__all__ = ["Collaborator", "CollaboratorRole"]

splunk_ao/__future__/configuration.py

@@ -0,0 +1,29 @@
+"""Deprecated: use splunk_ao.configuration instead of splunk_ao.__future__.configuration."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.configuration is deprecated. Use splunk_ao.configuration instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.configuration import (  # noqa: E402
+    _CONFIGURATION_KEYS,
+    _KEYS_BY_NAME,
+    VALID_LOG_LEVELS,
+    ConfigKey,
+    Configuration,
+    ConfigurationMeta,
+    parse_log_level,
+)
+
+__all__ = [
+    "VALID_LOG_LEVELS",
+    "_CONFIGURATION_KEYS",
+    "_KEYS_BY_NAME",
+    "ConfigKey",
+    "Configuration",
+    "ConfigurationMeta",
+    "parse_log_level",
+]

splunk_ao/__future__/dataset.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.dataset instead of splunk_ao.__future__.dataset."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.dataset is deprecated. Use splunk_ao.dataset instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.dataset import Dataset  # noqa: E402
+
+__all__ = ["Dataset"]

splunk_ao/__future__/experiment.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.experiment instead of splunk_ao.__future__.experiment."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.experiment is deprecated. Use splunk_ao.experiment instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.experiment import Experiment  # noqa: E402
+
+__all__ = ["Experiment"]

splunk_ao/__future__/integration.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.integration instead of splunk_ao.__future__.integration."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.integration is deprecated. Use splunk_ao.integration instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.integration import Integration  # noqa: E402
+
+__all__ = ["Integration"]

splunk_ao/__future__/model.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.model instead of splunk_ao.__future__.model."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.model is deprecated. Use splunk_ao.model instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.model import Model  # noqa: E402
+
+__all__ = ["Model"]

splunk_ao/__future__/project.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.project instead of splunk_ao.__future__.project."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.project is deprecated. Use splunk_ao.project instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.project import Project  # noqa: E402
+
+__all__ = ["Project"]

splunk_ao/__future__/prompt.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.prompt instead of splunk_ao.__future__.prompt."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.prompt is deprecated. Use splunk_ao.prompt instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.prompt import Prompt, PromptVersion, _parse_template_to_messages  # noqa: E402
+
+__all__ = ["Prompt", "PromptVersion", "_parse_template_to_messages"]

splunk_ao/__future__/provider.py

@@ -0,0 +1,31 @@
+"""Deprecated: use splunk_ao.provider instead of splunk_ao.__future__.provider."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.provider is deprecated. Use splunk_ao.provider instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.provider import (  # noqa: E402
+    AnthropicProvider,
+    AzureProvider,
+    BedrockProvider,
+    GenericProvider,
+    Model,
+    OpenAIProvider,
+    Provider,
+    UnconfiguredProvider,
+)
+
+__all__ = [
+    "AnthropicProvider",
+    "AzureProvider",
+    "BedrockProvider",
+    "GenericProvider",
+    "Model",
+    "OpenAIProvider",
+    "Provider",
+    "UnconfiguredProvider",
+]

splunk_ao/__future__/shared/__init__.py

@@ -0,0 +1,6 @@
+"""Re-export from splunk_ao.shared — will be deprecated once all __future__ modules are migrated."""
+
+from splunk_ao.shared.filter import boolean, date, number, text
+from splunk_ao.shared.sort import sort
+
+__all__ = ["boolean", "date", "number", "sort", "text"]

splunk_ao/__future__/shared/base.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.shared.base instead of splunk_ao.__future__.shared.base."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.base is deprecated. Use splunk_ao.shared.base instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.base import StateManagementMixin, SyncState  # noqa: E402
+
+__all__ = ["StateManagementMixin", "SyncState"]

splunk_ao/__future__/shared/column.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.shared.column instead of splunk_ao.__future__.shared.column."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.column is deprecated. Use splunk_ao.shared.column instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.column import Column, ColumnCollection, _unwrap_unset  # noqa: E402
+
+__all__ = ["Column", "ColumnCollection", "_unwrap_unset"]

splunk_ao/__future__/shared/exceptions.py

@@ -0,0 +1,31 @@
+"""Deprecated: use splunk_ao.shared.exceptions instead of splunk_ao.__future__.shared.exceptions."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.exceptions is deprecated. Use splunk_ao.shared.exceptions instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.exceptions import (  # noqa: E402
+    APIError,
+    ConfigurationError,
+    IntegrationNotConfiguredError,
+    ResourceConflictError,
+    ResourceNotFoundError,
+    SplunkAOFutureError,
+    SyncError,
+    ValidationError,
+)
+
+__all__ = [
+    "APIError",
+    "ConfigurationError",
+    "IntegrationNotConfiguredError",
+    "ResourceConflictError",
+    "ResourceNotFoundError",
+    "SplunkAOFutureError",
+    "SyncError",
+    "ValidationError",
+]

splunk_ao/__future__/shared/experiment_result.py

@@ -0,0 +1,18 @@
+"""Deprecated: use splunk_ao.shared.experiment_result instead of splunk_ao.__future__.shared.experiment_result."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.experiment_result is deprecated. "
+    "Use splunk_ao.shared.experiment_result instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.experiment_result import (  # noqa: E402
+    ExperimentPhaseInfo,
+    ExperimentRunResult,
+    ExperimentStatusInfo,
+)
+
+__all__ = ["ExperimentPhaseInfo", "ExperimentRunResult", "ExperimentStatusInfo"]

splunk_ao/__future__/shared/filter.py

@@ -0,0 +1,23 @@
+"""Deprecated: use splunk_ao.shared.filter instead of splunk_ao.__future__.shared.filter."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.filter is deprecated. Use splunk_ao.shared.filter instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.filter import (  # noqa: E402
+    BooleanFilter,
+    DateFilter,
+    Filter,
+    NumberFilter,
+    TextFilter,
+    boolean,
+    date,
+    number,
+    text,
+)
+
+__all__ = ["BooleanFilter", "DateFilter", "Filter", "NumberFilter", "TextFilter", "boolean", "date", "number", "text"]

splunk_ao/__future__/shared/query_result.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.shared.query_result instead of splunk_ao.__future__.shared.query_result."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.query_result is deprecated. Use splunk_ao.shared.query_result instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.query_result import QueryResult, _flatten_dict  # noqa: E402
+
+__all__ = ["QueryResult", "_flatten_dict"]

splunk_ao/__future__/shared/sort.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.shared.sort instead of splunk_ao.__future__.shared.sort."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.sort is deprecated. Use splunk_ao.shared.sort instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.sort import Sort, sort  # noqa: E402
+
+__all__ = ["Sort", "sort"]

splunk_ao/__future__/shared/utils.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.shared.utils instead of splunk_ao.__future__.shared.utils."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.shared.utils is deprecated. Use splunk_ao.shared.utils instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.shared.utils import classproperty  # noqa: E402
+
+__all__ = ["classproperty"]

splunk_ao/__future__/types.py

@@ -0,0 +1,13 @@
+"""Deprecated: use splunk_ao.types instead of splunk_ao.__future__.types."""
+
+import warnings
+
+warnings.warn(
+    "Importing from splunk_ao.__future__.types is deprecated. Use splunk_ao.types instead.",
+    DeprecationWarning,
+    stacklevel=2,
+)
+
+from splunk_ao.types import MetricSpec  # noqa: E402
+
+__all__ = ["MetricSpec"]