api.md

Ee

Projects

Annotations

Types:

from lilypad.types.ee.projects import (
    AnnotationPublic,
    EvaluationType,
    Label,
    AnnotationCreateResponse,
    AnnotationListResponse,
    AnnotationDeleteResponse,
)

Methods:

• client.ee.projects.annotations.create(project_uuid, **params) -> AnnotationCreateResponse
• client.ee.projects.annotations.update(annotation_uuid, *, project_uuid, **params) -> AnnotationPublic
• client.ee.projects.annotations.list(project_uuid) -> AnnotationListResponse
• client.ee.projects.annotations.delete(annotation_uuid, *, project_uuid) -> AnnotationDeleteResponse

Functions

Types:

from lilypad.types.ee.projects import (
    FunctionGetAnnotationMetricsResponse,
    FunctionGetAnnotationsResponse,
    FunctionRunPlaygroundResponse,
)

Methods:

• client.ee.projects.functions.get_annotation_metrics(function_uuid, *, project_uuid) -> FunctionGetAnnotationMetricsResponse
• client.ee.projects.functions.get_annotations(function_uuid, *, project_uuid) -> FunctionGetAnnotationsResponse
• client.ee.projects.functions.run_playground(function_uuid, *, project_uuid, **params) -> FunctionRunPlaygroundResponse

Spans

Types:

from lilypad.types.ee.projects import SpanGenerateAnnotationResponse

Methods:

• client.ee.projects.spans.generate_annotation(span_uuid, *, project_uuid) -> object

Organizations

Types:

from lilypad.types.ee import OrganizationGetLicenseResponse

Methods:

• client.ee.organizations.get_license() -> OrganizationGetLicenseResponse

UserOrganizations

Types:

from lilypad.types.ee import (
    UserOrganizationTable,
    UserRole,
    UserOrganizationDeleteResponse,
    UserOrganizationGetUserOrganizationsResponse,
    UserOrganizationGetUsersResponse,
)

Methods:

• client.ee.user_organizations.create(**params) -> UserPublic
• client.ee.user_organizations.update(user_organization_uuid, **params) -> UserOrganizationTable
• client.ee.user_organizations.delete(user_organization_uuid) -> UserOrganizationDeleteResponse
• client.ee.user_organizations.get_user_organizations() -> UserOrganizationGetUserOrganizationsResponse
• client.ee.user_organizations.get_users() -> UserOrganizationGetUsersResponse

APIKeys

Types:

from lilypad.types import APIKeyCreateResponse, APIKeyListResponse, APIKeyDeleteResponse

Methods:

• client.api_keys.create(**params) -> str
• client.api_keys.list() -> APIKeyListResponse
• client.api_keys.delete(api_key_uuid) -> APIKeyDeleteResponse

Projects

Types:

from lilypad.types import (
    FunctionCreate,
    ProjectCreate,
    ProjectPublic,
    ProjectListResponse,
    ProjectDeleteResponse,
    ProjectRetrieveTagsResponse,
)

Methods:

• client.projects.create(**params) -> ProjectPublic
• client.projects.retrieve(project_uuid) -> ProjectPublic
• client.projects.update(project_uuid, **params) -> ProjectPublic
• client.projects.list() -> ProjectListResponse
• client.projects.delete(project_uuid) -> ProjectDeleteResponse
• client.projects.create_versioned_function(path_project_uuid, **params) -> FunctionPublic
• client.projects.retrieve_tags(project_uuid) -> ProjectRetrieveTagsResponse

Functions

Types:

from lilypad.types.projects import (
    FunctionListResponse,
    FunctionArchiveResponse,
    FunctionArchiveByNameResponse,
)

Methods:

• client.projects.functions.create(path_project_uuid, **params) -> FunctionPublic
• client.projects.functions.retrieve(function_uuid, *, project_uuid) -> FunctionPublic
• client.projects.functions.update(function_uuid, *, project_uuid) -> FunctionPublic
• client.projects.functions.list(project_uuid) -> FunctionListResponse
• client.projects.functions.archive(function_uuid, *, project_uuid) -> FunctionArchiveResponse
• client.projects.functions.archive_by_name(function_name, *, project_uuid) -> FunctionArchiveByNameResponse
• client.projects.functions.retrieve_by_hash(function_hash, *, project_uuid) -> FunctionPublic

Name

Types:

from lilypad.types.projects.functions import (
    CommonCallParams,
    FunctionPublic,
    NameRetrieveByNameResponse,
)

Methods:

• client.projects.functions.name.retrieve_by_name(function_name, *, project_uuid) -> NameRetrieveByNameResponse
• client.projects.functions.name.retrieve_by_version(version_num, *, project_uuid, function_name) -> FunctionPublic
• client.projects.functions.name.retrieve_deployed(function_name, *, project_uuid) -> FunctionPublic

Metadata

Names

Types:

from lilypad.types.projects.functions.metadata import (
    NameListResponse,
    NameListLatestVersionsResponse,
)

Methods:

• client.projects.functions.metadata.names.list(project_uuid) -> NameListResponse
• client.projects.functions.metadata.names.list_latest_versions(project_uuid) -> NameListLatestVersionsResponse

Spans

Types:

from lilypad.types.projects.functions import (
    AggregateMetrics,
    SpanPublic,
    TimeFrame,
    SpanListResponse,
    SpanListAggregatesResponse,
)

Methods:

• client.projects.functions.spans.list(function_uuid, *, project_uuid) -> SpanListResponse
• client.projects.functions.spans.list_aggregates(function_uuid, *, project_uuid, **params) -> SpanListAggregatesResponse

Spans

Types:

from lilypad.types.projects import SpanListResponse, SpanDeleteResponse, SpanListAggregatesResponse

Methods:

• client.projects.spans.retrieve(span_id, *, project_uuid) -> SpanMoreDetails
• client.projects.spans.list(project_uuid, **params) -> SpanListResponse
• client.projects.spans.delete(span_uuid, *, project_uuid) -> SpanDeleteResponse
• client.projects.spans.list_aggregates(project_uuid, **params) -> SpanListAggregatesResponse
• client.projects.spans.update_tags(span_uuid, **params) -> SpanPublic

Traces

Types:

from lilypad.types.projects import TraceCreateResponse, TraceListResponse

Methods:

• client.projects.traces.create(project_uuid) -> TraceCreateResponse
• client.projects.traces.list(project_uuid) -> TraceListResponse

Environments

Types:

from lilypad.types.projects import DeploymentPublic, EnvironmentRetrieveDeploymentHistoryResponse

Methods:

• client.projects.environments.deploy(environment_uuid, *, project_uuid, **params) -> DeploymentPublic
• client.projects.environments.retrieve_active_deployment(environment_uuid, *, project_uuid) -> DeploymentPublic
• client.projects.environments.retrieve_active_function(environment_uuid, *, project_uuid) -> FunctionPublic
• client.projects.environments.retrieve_deployment_history(environment_uuid, *, project_uuid) -> EnvironmentRetrieveDeploymentHistoryResponse

OrganizationsInvites

Types:

from lilypad.types import (
    OrganizationInvite,
    OrganizationsInviteListResponse,
    OrganizationsInviteDeleteResponse,
)

Methods:

• client.organizations_invites.create(**params) -> OrganizationInvite
• client.organizations_invites.retrieve(invite_token) -> OrganizationInvite
• client.organizations_invites.list() -> OrganizationsInviteListResponse
• client.organizations_invites.delete(organization_invite_uuid) -> OrganizationsInviteDeleteResponse

Spans

Types:

from lilypad.types import SpanMoreDetails, SpanListCommentsResponse

Methods:

• client.spans.retrieve(span_uuid) -> SpanMoreDetails
• client.spans.update(span_uuid, **params) -> SpanPublic
• client.spans.list_comments(span_uuid) -> SpanListCommentsResponse

Auth

GitHub

Types:

from lilypad.types.auth import UserPublic

Methods:

• client.auth.github.callback(**params) -> UserPublic

Google

Methods:

• client.auth.google.callback(**params) -> UserPublic

Users

Methods:

• client.users.update_active_organization(active_organization_uuid) -> UserPublic
• client.users.update_keys(**params) -> UserPublic

CurrentUser

Methods:

• client.current_user.retrieve() -> UserPublic

Organizations

Types:

from lilypad.types import OrganizationPublic

Methods:

• client.organizations.create(**params) -> OrganizationPublic
• client.organizations.update(**params) -> OrganizationPublic
• client.organizations.delete() -> UserPublic

ExternalAPIKeys

Types:

from lilypad.types import (
    ExternalAPIKeyPublic,
    ExternalAPIKeyListResponse,
    ExternalAPIKeyDeleteResponse,
)

Methods:

• client.external_api_keys.create(**params) -> ExternalAPIKeyPublic
• client.external_api_keys.retrieve(service_name) -> ExternalAPIKeyPublic
• client.external_api_keys.update(service_name, **params) -> ExternalAPIKeyPublic
• client.external_api_keys.list() -> ExternalAPIKeyListResponse
• client.external_api_keys.delete(service_name) -> ExternalAPIKeyDeleteResponse

Environments

Types:

from lilypad.types import EnvironmentPublic, EnvironmentListResponse, EnvironmentDeleteResponse

Methods:

• client.environments.create(**params) -> EnvironmentPublic
• client.environments.retrieve(environment_uuid) -> EnvironmentPublic
• client.environments.list() -> EnvironmentListResponse
• client.environments.delete(environment_uuid) -> EnvironmentDeleteResponse

Settings

Types:

from lilypad.types import SettingRetrieveResponse

Methods:

• client.settings.retrieve() -> SettingRetrieveResponse

UserConsents

Types:

from lilypad.types import UserConsentCreateResponse, UserConsentUpdateResponse

Methods:

• client.user_consents.create(**params) -> UserConsentCreateResponse
• client.user_consents.update(user_consent_uuid, **params) -> UserConsentUpdateResponse

Tags

Types:

from lilypad.types import (
    TagCreateResponse,
    TagRetrieveResponse,
    TagUpdateResponse,
    TagListResponse,
    TagDeleteResponse,
)

Methods:

• client.tags.create(**params) -> TagCreateResponse
• client.tags.retrieve(tag_uuid) -> TagRetrieveResponse
• client.tags.update(tag_uuid, **params) -> TagUpdateResponse
• client.tags.list() -> TagListResponse
• client.tags.delete(tag_uuid) -> TagDeleteResponse

Comments

Types:

from lilypad.types import (
    CommentCreateResponse,
    CommentRetrieveResponse,
    CommentUpdateResponse,
    CommentListResponse,
    CommentDeleteResponse,
)

Methods:

• client.comments.create(**params) -> CommentCreateResponse
• client.comments.retrieve(comment_uuid) -> CommentRetrieveResponse
• client.comments.update(comment_uuid, **params) -> CommentUpdateResponse
• client.comments.list() -> CommentListResponse
• client.comments.delete(comment_uuid) -> CommentDeleteResponse