Adaline API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for adaline-akshay from gravatar.com adaline-akshay

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

adaline-api

Public API for managing Adaline projects, prompts, datasets, evaluators, evaluations, providers, models, and deployments.

Generated from Zod schemas — this spec is the single source of truth.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.0
  • Package version: 1.0.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import adaline_api

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import adaline_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import adaline_api
from adaline_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.adaline.ai/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = adaline_api.Configuration(
    host = "https://api.adaline.ai/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): bearerAuth
configuration = adaline_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with adaline_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = adaline_api.DatasetsApi(api_client)
    dataset_id = 'dataset_id_example' # str | 
    add_dataset_columns_request = adaline_api.AddDatasetColumnsRequest() # AddDatasetColumnsRequest |  (optional)

    try:
        # Add columns to a dataset
        api_response = await api_instance.add_dataset_columns(dataset_id, add_dataset_columns_request=add_dataset_columns_request)
        print("The response of DatasetsApi->add_dataset_columns:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DatasetsApi->add_dataset_columns: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.adaline.ai/v2

Class Method HTTP request Description
DatasetsApi add_dataset_columns POST /datasets/{datasetId}/columns Add columns to a dataset
DatasetsApi add_dataset_rows POST /datasets/{datasetId}/rows Add rows to a dataset
DatasetsApi create_dataset POST /datasets Create a dataset
DatasetsApi delete_dataset DELETE /datasets/{datasetId} Delete a dataset
DatasetsApi delete_dataset_column DELETE /datasets/{datasetId}/columns/{columnId} Delete a dataset column
DatasetsApi delete_dataset_row DELETE /datasets/{datasetId}/rows/{rowId} Delete a dataset row
DatasetsApi fetch_dynamic_columns POST /datasets/{datasetId}/dynamic-columns/fetch Trigger dynamic column fetch
DatasetsApi get_dataset GET /datasets/{datasetId} Get a dataset
DatasetsApi get_dataset_rows GET /datasets/{datasetId}/rows Get dataset rows
DatasetsApi list_datasets GET /datasets List datasets
DatasetsApi patch_dataset_row PATCH /datasets/{datasetId}/rows/{rowId} Update a dataset row
DatasetsApi update_dataset PATCH /datasets/{datasetId} Update a dataset
DatasetsApi update_dataset_column PATCH /datasets/{datasetId}/columns/{columnId} Update a dataset column
DeploymentsApi get_deployment GET /deployments Retrieve a specific or latest deployment
EvaluationsApi cancel_evaluation POST /prompts/{promptId}/evaluations/{evaluationId}/cancel Cancel an evaluation
EvaluationsApi create_evaluation POST /prompts/{promptId}/evaluations Create an evaluation
EvaluationsApi get_evaluation GET /prompts/{promptId}/evaluations/{evaluationId} Get an evaluation
EvaluationsApi get_evaluation_results GET /prompts/{promptId}/evaluations/{evaluationId}/results Get evaluation results
EvaluationsApi list_evaluations GET /prompts/{promptId}/evaluations List evaluations
EvaluatorsApi create_evaluator POST /prompts/{promptId}/evaluators Create an evaluator
EvaluatorsApi delete_evaluator DELETE /prompts/{promptId}/evaluators/{evaluatorId} Delete an evaluator
EvaluatorsApi get_evaluator GET /prompts/{promptId}/evaluators/{evaluatorId} Get an evaluator
EvaluatorsApi list_evaluators GET /prompts/{promptId}/evaluators List evaluators
EvaluatorsApi update_evaluator PATCH /prompts/{promptId}/evaluators/{evaluatorId} Update an evaluator
LogsApi create_log_span POST /logs/span Create span log
LogsApi create_log_trace POST /logs/trace Create trace log
LogsApi list_logs GET /logs List log traces
LogsApi search_log_spans POST /logs/spans Search spans
LogsApi search_log_traces POST /logs/traces Search traces
LogsApi update_log_trace PATCH /logs/trace Update trace log
ModelsApi list_models GET /models List models
ProjectsApi get_project GET /projects/{projectId} Get project
ProjectsApi list_projects GET /projects List projects
ProjectsApi update_project PATCH /projects/{projectId} Update project
PromptsApi create_prompt POST /prompts Create a prompt
PromptsApi delete_prompt DELETE /prompts/{promptId} Delete a prompt
PromptsApi get_playground GET /prompts/{promptId}/playgrounds/{playgroundId} Get playground
PromptsApi get_prompt GET /prompts/{promptId} Get a prompt
PromptsApi get_prompt_draft GET /prompts/{promptId}/draft Get prompt draft
PromptsApi list_playgrounds GET /prompts/{promptId}/playgrounds List playgrounds
PromptsApi list_prompts GET /prompts List prompts
PromptsApi patch_prompt PATCH /prompts/{promptId} Update a prompt
ProvidersApi get_provider GET /providers/{providerId} Get a provider
ProvidersApi list_providers GET /providers List providers

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (API Key)

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for adaline-akshay from gravatar.com adaline-akshay

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

2.2.1

This version

2.2.0

2.1.1

2.1.0

2.0.0

1.0.1

1.0.0 yanked

Reason this release was yanked:

Bad initial release, do not use, update coming soon

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adaline_api-2.2.0.tar.gz (109.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adaline_api-2.2.0-py3-none-any.whl (353.1 kB view details)

Uploaded Python 3

File details

Details for the file adaline_api-2.2.0.tar.gz.

File metadata

  • Download URL: adaline_api-2.2.0.tar.gz
  • Upload date:
  • Size: 109.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for adaline_api-2.2.0.tar.gz
Algorithm Hash digest
SHA256 3fe9929750a25c6e58bb9f174b302d9e3a2a85f8f9fa1523d30abfa4ab61bc0c
MD5 003aada15f56cbd92e9a5d5e9eaab562
BLAKE2b-256 edc8e5608251db8549c26439bf848cf2d1e0a70f927b477a2bdf09225fab31e8

See more details on using hashes here.

File details

Details for the file adaline_api-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: adaline_api-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 353.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for adaline_api-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11ea539e80d0549dad209ae6a2f82a978924b9e37f0f146c09ca1155e0f17276
MD5 92a18d7372bfe59ef75fb0ebb8d7387e
BLAKE2b-256 df17ad1feb36b2dba82f91524e391d4cc6fc1688e2b892d13929a3cb6603af3e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page