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
- APICell
- APIColumn
- APIColumnDefinition
- APIColumnDefinitionSettings
- APIColumnDefinitionSettingsBodyTemplate
- APIColumnSettings
- APIColumnSettingsBodyTemplate
- AddDatasetColumnsRequest
- AddDatasetColumnsRequestColumnsInner
- AddDatasetColumnsResponse
- AddDatasetRowsRequest
- AddDatasetRowsResponse
- ApiContent
- ApiHttpMethod
- Base64HostedImageContentValue
- Base64HostedPdfContentValue
- Base64ImageContentValue
- Base64PdfContentValue
- BaseEntityIcon
- Cost
- Create
- Create1
- CreateDatasetRequest
- CreateEvaluationRequest
- CreateEvaluatorRequest
- CreateLogSpanRequest
- CreateLogSpanRequestSpan
- CreateLogSpanResponse
- CreateLogTraceRequest
- CreateLogTraceRequestSpan
- CreateLogTraceRequestTrace
- CreateLogTraceResponse
- CreatePromptRequest
- CreatePromptRequestDraft
- CreateValue
- Dataset
- DatasetCellApiConfig
- DatasetCellBase64Image
- DatasetCellBase64Pdf
- DatasetCellInput
- DatasetCellModality
- DatasetCellPromptRef
- DatasetCellResponse
- DatasetCellUrlReference
- DatasetColumn
- DatasetRow
- DatasetRowInput
- DatasetSummary
- Delete
- Delete1
- Deployment
- ErrorCell
- ErrorContent
- ErrorResponse
- ErrorResponseError
- ErrorResponseErrorOneOf
- ErrorResponseErrorOneOfDetailsInner
- Evaluation
- EvaluationMetrics
- EvaluationProgress
- EvaluationResult
- EvaluationResultRow
- EvaluationRunTimeline
- EvaluationStatus
- Evaluator
- EvaluatorComparisonRule
- EvaluatorComparisonRuleValue
- EvaluatorConfig
- EvaluatorListItem
- FetchDynamicColumnsRequest
- FetchDynamicColumnsResponse
- FetchDynamicColumnsResponseColumnRunsInner
- FunctionRequestHttp
- FunctionRequestRetry
- FunctionSchema
- GetProviderResponse
- ImageCell
- ImageCellValue
- ImageContent
- ImageContentValue
- JavaScript
- LLMAsAJudge
- Latency
- ListDatasetRowsResponse
- ListDatasetsResponse
- ListEvaluationResultsResponse
- ListEvaluationsResponse
- ListEvaluatorsResponse
- ListLogsResponse
- ListModelsResponse
- ListPlaygroundsResponse
- ListProjectsResponse
- ListPromptsResponse
- ListProvidersResponse
- LogAttributesValue
- LogFilterObject
- LogSpanContent
- LogSpanEmbeddingsContent
- LogSpanFunctionContent
- LogSpanGuardrailContent
- LogSpanItem
- LogSpanModelContent
- LogSpanModelStreamContent
- LogSpanOtherContent
- LogSpanRetrievalContent
- LogSpanToolContent
- LogSpanVariable
- LogSpanVariableValue
- LogTraceItem
- MessageContent
- MessageRole
- Model
- PDFCell
- PDFCellValue
- Pagination
- PatchPromptRequest
- PatchPromptRequestPlaygroundsValue
- PdfContent
- PdfContentFile
- PdfContentValue
- PlaygroundDetail
- PlaygroundVariable
- Project
- Prompt
- PromptCell
- PromptColumn
- PromptColumnDefinition
- PromptColumnDefinitionSettings
- PromptColumnSettings
- PromptConfig
- PromptContent
- PromptDraft
- PromptListItem
- PromptMessage
- PromptPlayground
- PromptSnapshot
- PromptSnapshotConfig
- PromptVariable
- Provider
- ProviderModelSettingsInner
- ProviderWithModels
- ReasoningContent
- ReasoningContentValue
- ReasoningContentValueUnion
- RedactedReasoningContentValue
- ResponseLength
- SafetyErrorContentValue
- SafetyErrorContentValueValue
- SearchLogSpansRequest
- SearchLogTracesRequest
- SearchResultContent
- SearchResultGoogleContentValue
- SearchResultGoogleContentValueReferencesInner
- SearchResultGoogleContentValueResponsesInner
- SearchSpansResponse
- SearchTracesResponse
- SortOrder
- StaticColumn
- StaticColumnDefinition
- SuccessResponse
- TextCell
- TextContent
- TextMatcher
- TextMatcherValue
- TextMatcherValueValue
- ToolCallContent
- ToolFunction
- ToolFunctionDefinition
- ToolResponseContent
- ToolResponseContentApiResponse
- UpdateDatasetColumnRequest
- UpdateDatasetColumnRequestSettings
- UpdateDatasetRequest
- UpdateEvaluatorRequest
- UpdateLogTraceRequest
- UpdateLogTraceRequestAttributeItem
- UpdateLogTraceRequestTagItem
- UpdateLogTraceRequestTrace
- UpdateLogTraceResponse
- UpdateProjectRequest
- UrlImageContentValue
- UrlPdfContentValue
- VariableModality
- VariableValue
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication (API Key)
Author
Metadata
Release files for adaline-api 2.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| adaline_api-2.2.1.tar.gz | 109.9 kB | Without provenance | Details for adaline_api-2.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| adaline_api-2.2.1-py3-none-any.whl | Python 3 | none | any | Details for adaline_api-2.2.1-py3-none-any.whl |
Total release size: 463.0 kB
Release files / adaline_api-2.2.1.tar.gz
| Download URL | adaline_api-2.2.1.tar.gz |
|---|---|
| Size | 109.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2166d55f4afbc0814cfbdd0b25d8f7416d653201e517e7c0d7610d5d3d27f16f
|
|
BLAKE2b-256 checksum How to use checksums |
e9c8445839d9f6eb706b994cb5297f47efbf1d7e81a1c77a8c3878d572ba4070
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Release files / adaline_api-2.2.1-py3-none-any.whl
| Download URL | adaline_api-2.2.1-py3-none-any.whl |
|---|---|
| Size | 353.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b9e1c79d4717516478a8c9770662d8d85bcbf86c172d52e7d0a5da6669a80c1d
|
|
BLAKE2b-256 checksum How to use checksums |
b672998a5a2c3ae4808c6825a8ad9b6488106e2e16b493f488056b1a2eb70b99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.15
|
Security for adaline-api 2.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.