PkgFoundry
Catalog PyPI
PACKAGE EXPLORERView in registry

adaline-api

PyPI

Adaline API

adalineapiopenapiopenapi-generator
Versions collected1
Direct dependencies6From release 2.2.1
Last observed20 Oct, 19:00 UTC

README

Version 2.2.1 documentation

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

ClassMethodHTTP requestDescription
DatasetsApiadd_dataset_columnsPOST /datasets/{datasetId}/columnsAdd columns to a dataset
DatasetsApiadd_dataset_rowsPOST /datasets/{datasetId}/rowsAdd rows to a dataset
DatasetsApicreate_datasetPOST /datasetsCreate a dataset
DatasetsApidelete_datasetDELETE /datasets/{datasetId}Delete a dataset
DatasetsApidelete_dataset_columnDELETE /datasets/{datasetId}/columns/{columnId}Delete a dataset column
DatasetsApidelete_dataset_rowDELETE /datasets/{datasetId}/rows/{rowId}Delete a dataset row
DatasetsApifetch_dynamic_columnsPOST /datasets/{datasetId}/dynamic-columns/fetchTrigger dynamic column fetch
DatasetsApiget_datasetGET /datasets/{datasetId}Get a dataset
DatasetsApiget_dataset_rowsGET /datasets/{datasetId}/rowsGet dataset rows
DatasetsApilist_datasetsGET /datasetsList datasets
DatasetsApipatch_dataset_rowPATCH /datasets/{datasetId}/rows/{rowId}Update a dataset row
DatasetsApiupdate_datasetPATCH /datasets/{datasetId}Update a dataset
DatasetsApiupdate_dataset_columnPATCH /datasets/{datasetId}/columns/{columnId}Update a dataset column
DeploymentsApiget_deploymentGET /deploymentsRetrieve a specific or latest deployment
EvaluationsApicancel_evaluationPOST /prompts/{promptId}/evaluations/{evaluationId}/cancelCancel an evaluation
EvaluationsApicreate_evaluationPOST /prompts/{promptId}/evaluationsCreate an evaluation
EvaluationsApiget_evaluationGET /prompts/{promptId}/evaluations/{evaluationId}Get an evaluation
EvaluationsApiget_evaluation_resultsGET /prompts/{promptId}/evaluations/{evaluationId}/resultsGet evaluation results
EvaluationsApilist_evaluationsGET /prompts/{promptId}/evaluationsList evaluations
EvaluatorsApicreate_evaluatorPOST /prompts/{promptId}/evaluatorsCreate an evaluator
EvaluatorsApidelete_evaluatorDELETE /prompts/{promptId}/evaluators/{evaluatorId}Delete an evaluator
EvaluatorsApiget_evaluatorGET /prompts/{promptId}/evaluators/{evaluatorId}Get an evaluator
EvaluatorsApilist_evaluatorsGET /prompts/{promptId}/evaluatorsList evaluators
EvaluatorsApiupdate_evaluatorPATCH /prompts/{promptId}/evaluators/{evaluatorId}Update an evaluator
LogsApicreate_log_spanPOST /logs/spanCreate span log
LogsApicreate_log_tracePOST /logs/traceCreate trace log
LogsApilist_logsGET /logsList log traces
LogsApisearch_log_spansPOST /logs/spansSearch spans
LogsApisearch_log_tracesPOST /logs/tracesSearch traces
LogsApiupdate_log_tracePATCH /logs/traceUpdate trace log
ModelsApilist_modelsGET /modelsList models
ProjectsApiget_projectGET /projects/{projectId}Get project
ProjectsApilist_projectsGET /projectsList projects
ProjectsApiupdate_projectPATCH /projects/{projectId}Update project
PromptsApicreate_promptPOST /promptsCreate a prompt
PromptsApidelete_promptDELETE /prompts/{promptId}Delete a prompt
PromptsApiget_playgroundGET /prompts/{promptId}/playgrounds/{playgroundId}Get playground
PromptsApiget_promptGET /prompts/{promptId}Get a prompt
PromptsApiget_prompt_draftGET /prompts/{promptId}/draftGet prompt draft
PromptsApilist_playgroundsGET /prompts/{promptId}/playgroundsList playgrounds
PromptsApilist_promptsGET /promptsList prompts
PromptsApipatch_promptPATCH /prompts/{promptId}Update a prompt
ProvidersApiget_providerGET /providers/{providerId}Get a provider
ProvidersApilist_providersGET /providersList providers

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (API Key)

Author

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
2.2.126 Apr 20266
Sorted by available source dates · UTC

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Repository

PENDING
git_user_id/git_repo_id

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 19:00 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:ddc98e895b7fbae230d4cf235a7b42bf22dbd5290465808ee92bb67c7a737b89