Metadata-Version: 2.4
Name: adaline_api
Version: 2.2.1
Summary: Adaline API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: MIT
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Adaline API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: aiohttp>=3.8.4
Requires-Dist: aiohttp-retry>=2.8.3
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# 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](https://openapi-generator.tech) 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:

```sh
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:
```python
import adaline_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import adaline_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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

## Documentation For Models

 - [APICell](docs/APICell.md)
 - [APIColumn](docs/APIColumn.md)
 - [APIColumnDefinition](docs/APIColumnDefinition.md)
 - [APIColumnDefinitionSettings](docs/APIColumnDefinitionSettings.md)
 - [APIColumnDefinitionSettingsBodyTemplate](docs/APIColumnDefinitionSettingsBodyTemplate.md)
 - [APIColumnSettings](docs/APIColumnSettings.md)
 - [APIColumnSettingsBodyTemplate](docs/APIColumnSettingsBodyTemplate.md)
 - [AddDatasetColumnsRequest](docs/AddDatasetColumnsRequest.md)
 - [AddDatasetColumnsRequestColumnsInner](docs/AddDatasetColumnsRequestColumnsInner.md)
 - [AddDatasetColumnsResponse](docs/AddDatasetColumnsResponse.md)
 - [AddDatasetRowsRequest](docs/AddDatasetRowsRequest.md)
 - [AddDatasetRowsResponse](docs/AddDatasetRowsResponse.md)
 - [ApiContent](docs/ApiContent.md)
 - [ApiHttpMethod](docs/ApiHttpMethod.md)
 - [Base64HostedImageContentValue](docs/Base64HostedImageContentValue.md)
 - [Base64HostedPdfContentValue](docs/Base64HostedPdfContentValue.md)
 - [Base64ImageContentValue](docs/Base64ImageContentValue.md)
 - [Base64PdfContentValue](docs/Base64PdfContentValue.md)
 - [BaseEntityIcon](docs/BaseEntityIcon.md)
 - [Cost](docs/Cost.md)
 - [Create](docs/Create.md)
 - [Create1](docs/Create1.md)
 - [CreateDatasetRequest](docs/CreateDatasetRequest.md)
 - [CreateEvaluationRequest](docs/CreateEvaluationRequest.md)
 - [CreateEvaluatorRequest](docs/CreateEvaluatorRequest.md)
 - [CreateLogSpanRequest](docs/CreateLogSpanRequest.md)
 - [CreateLogSpanRequestSpan](docs/CreateLogSpanRequestSpan.md)
 - [CreateLogSpanResponse](docs/CreateLogSpanResponse.md)
 - [CreateLogTraceRequest](docs/CreateLogTraceRequest.md)
 - [CreateLogTraceRequestSpan](docs/CreateLogTraceRequestSpan.md)
 - [CreateLogTraceRequestTrace](docs/CreateLogTraceRequestTrace.md)
 - [CreateLogTraceResponse](docs/CreateLogTraceResponse.md)
 - [CreatePromptRequest](docs/CreatePromptRequest.md)
 - [CreatePromptRequestDraft](docs/CreatePromptRequestDraft.md)
 - [CreateValue](docs/CreateValue.md)
 - [Dataset](docs/Dataset.md)
 - [DatasetCellApiConfig](docs/DatasetCellApiConfig.md)
 - [DatasetCellBase64Image](docs/DatasetCellBase64Image.md)
 - [DatasetCellBase64Pdf](docs/DatasetCellBase64Pdf.md)
 - [DatasetCellInput](docs/DatasetCellInput.md)
 - [DatasetCellModality](docs/DatasetCellModality.md)
 - [DatasetCellPromptRef](docs/DatasetCellPromptRef.md)
 - [DatasetCellResponse](docs/DatasetCellResponse.md)
 - [DatasetCellUrlReference](docs/DatasetCellUrlReference.md)
 - [DatasetColumn](docs/DatasetColumn.md)
 - [DatasetRow](docs/DatasetRow.md)
 - [DatasetRowInput](docs/DatasetRowInput.md)
 - [DatasetSummary](docs/DatasetSummary.md)
 - [Delete](docs/Delete.md)
 - [Delete1](docs/Delete1.md)
 - [Deployment](docs/Deployment.md)
 - [ErrorCell](docs/ErrorCell.md)
 - [ErrorContent](docs/ErrorContent.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [ErrorResponseError](docs/ErrorResponseError.md)
 - [ErrorResponseErrorOneOf](docs/ErrorResponseErrorOneOf.md)
 - [ErrorResponseErrorOneOfDetailsInner](docs/ErrorResponseErrorOneOfDetailsInner.md)
 - [Evaluation](docs/Evaluation.md)
 - [EvaluationMetrics](docs/EvaluationMetrics.md)
 - [EvaluationProgress](docs/EvaluationProgress.md)
 - [EvaluationResult](docs/EvaluationResult.md)
 - [EvaluationResultRow](docs/EvaluationResultRow.md)
 - [EvaluationRunTimeline](docs/EvaluationRunTimeline.md)
 - [EvaluationStatus](docs/EvaluationStatus.md)
 - [Evaluator](docs/Evaluator.md)
 - [EvaluatorComparisonRule](docs/EvaluatorComparisonRule.md)
 - [EvaluatorComparisonRuleValue](docs/EvaluatorComparisonRuleValue.md)
 - [EvaluatorConfig](docs/EvaluatorConfig.md)
 - [EvaluatorListItem](docs/EvaluatorListItem.md)
 - [FetchDynamicColumnsRequest](docs/FetchDynamicColumnsRequest.md)
 - [FetchDynamicColumnsResponse](docs/FetchDynamicColumnsResponse.md)
 - [FetchDynamicColumnsResponseColumnRunsInner](docs/FetchDynamicColumnsResponseColumnRunsInner.md)
 - [FunctionRequestHttp](docs/FunctionRequestHttp.md)
 - [FunctionRequestRetry](docs/FunctionRequestRetry.md)
 - [FunctionSchema](docs/FunctionSchema.md)
 - [GetProviderResponse](docs/GetProviderResponse.md)
 - [ImageCell](docs/ImageCell.md)
 - [ImageCellValue](docs/ImageCellValue.md)
 - [ImageContent](docs/ImageContent.md)
 - [ImageContentValue](docs/ImageContentValue.md)
 - [JavaScript](docs/JavaScript.md)
 - [LLMAsAJudge](docs/LLMAsAJudge.md)
 - [Latency](docs/Latency.md)
 - [ListDatasetRowsResponse](docs/ListDatasetRowsResponse.md)
 - [ListDatasetsResponse](docs/ListDatasetsResponse.md)
 - [ListEvaluationResultsResponse](docs/ListEvaluationResultsResponse.md)
 - [ListEvaluationsResponse](docs/ListEvaluationsResponse.md)
 - [ListEvaluatorsResponse](docs/ListEvaluatorsResponse.md)
 - [ListLogsResponse](docs/ListLogsResponse.md)
 - [ListModelsResponse](docs/ListModelsResponse.md)
 - [ListPlaygroundsResponse](docs/ListPlaygroundsResponse.md)
 - [ListProjectsResponse](docs/ListProjectsResponse.md)
 - [ListPromptsResponse](docs/ListPromptsResponse.md)
 - [ListProvidersResponse](docs/ListProvidersResponse.md)
 - [LogAttributesValue](docs/LogAttributesValue.md)
 - [LogFilterObject](docs/LogFilterObject.md)
 - [LogSpanContent](docs/LogSpanContent.md)
 - [LogSpanEmbeddingsContent](docs/LogSpanEmbeddingsContent.md)
 - [LogSpanFunctionContent](docs/LogSpanFunctionContent.md)
 - [LogSpanGuardrailContent](docs/LogSpanGuardrailContent.md)
 - [LogSpanItem](docs/LogSpanItem.md)
 - [LogSpanModelContent](docs/LogSpanModelContent.md)
 - [LogSpanModelStreamContent](docs/LogSpanModelStreamContent.md)
 - [LogSpanOtherContent](docs/LogSpanOtherContent.md)
 - [LogSpanRetrievalContent](docs/LogSpanRetrievalContent.md)
 - [LogSpanToolContent](docs/LogSpanToolContent.md)
 - [LogSpanVariable](docs/LogSpanVariable.md)
 - [LogSpanVariableValue](docs/LogSpanVariableValue.md)
 - [LogTraceItem](docs/LogTraceItem.md)
 - [MessageContent](docs/MessageContent.md)
 - [MessageRole](docs/MessageRole.md)
 - [Model](docs/Model.md)
 - [PDFCell](docs/PDFCell.md)
 - [PDFCellValue](docs/PDFCellValue.md)
 - [Pagination](docs/Pagination.md)
 - [PatchPromptRequest](docs/PatchPromptRequest.md)
 - [PatchPromptRequestPlaygroundsValue](docs/PatchPromptRequestPlaygroundsValue.md)
 - [PdfContent](docs/PdfContent.md)
 - [PdfContentFile](docs/PdfContentFile.md)
 - [PdfContentValue](docs/PdfContentValue.md)
 - [PlaygroundDetail](docs/PlaygroundDetail.md)
 - [PlaygroundVariable](docs/PlaygroundVariable.md)
 - [Project](docs/Project.md)
 - [Prompt](docs/Prompt.md)
 - [PromptCell](docs/PromptCell.md)
 - [PromptColumn](docs/PromptColumn.md)
 - [PromptColumnDefinition](docs/PromptColumnDefinition.md)
 - [PromptColumnDefinitionSettings](docs/PromptColumnDefinitionSettings.md)
 - [PromptColumnSettings](docs/PromptColumnSettings.md)
 - [PromptConfig](docs/PromptConfig.md)
 - [PromptContent](docs/PromptContent.md)
 - [PromptDraft](docs/PromptDraft.md)
 - [PromptListItem](docs/PromptListItem.md)
 - [PromptMessage](docs/PromptMessage.md)
 - [PromptPlayground](docs/PromptPlayground.md)
 - [PromptSnapshot](docs/PromptSnapshot.md)
 - [PromptSnapshotConfig](docs/PromptSnapshotConfig.md)
 - [PromptVariable](docs/PromptVariable.md)
 - [Provider](docs/Provider.md)
 - [ProviderModelSettingsInner](docs/ProviderModelSettingsInner.md)
 - [ProviderWithModels](docs/ProviderWithModels.md)
 - [ReasoningContent](docs/ReasoningContent.md)
 - [ReasoningContentValue](docs/ReasoningContentValue.md)
 - [ReasoningContentValueUnion](docs/ReasoningContentValueUnion.md)
 - [RedactedReasoningContentValue](docs/RedactedReasoningContentValue.md)
 - [ResponseLength](docs/ResponseLength.md)
 - [SafetyErrorContentValue](docs/SafetyErrorContentValue.md)
 - [SafetyErrorContentValueValue](docs/SafetyErrorContentValueValue.md)
 - [SearchLogSpansRequest](docs/SearchLogSpansRequest.md)
 - [SearchLogTracesRequest](docs/SearchLogTracesRequest.md)
 - [SearchResultContent](docs/SearchResultContent.md)
 - [SearchResultGoogleContentValue](docs/SearchResultGoogleContentValue.md)
 - [SearchResultGoogleContentValueReferencesInner](docs/SearchResultGoogleContentValueReferencesInner.md)
 - [SearchResultGoogleContentValueResponsesInner](docs/SearchResultGoogleContentValueResponsesInner.md)
 - [SearchSpansResponse](docs/SearchSpansResponse.md)
 - [SearchTracesResponse](docs/SearchTracesResponse.md)
 - [SortOrder](docs/SortOrder.md)
 - [StaticColumn](docs/StaticColumn.md)
 - [StaticColumnDefinition](docs/StaticColumnDefinition.md)
 - [SuccessResponse](docs/SuccessResponse.md)
 - [TextCell](docs/TextCell.md)
 - [TextContent](docs/TextContent.md)
 - [TextMatcher](docs/TextMatcher.md)
 - [TextMatcherValue](docs/TextMatcherValue.md)
 - [TextMatcherValueValue](docs/TextMatcherValueValue.md)
 - [ToolCallContent](docs/ToolCallContent.md)
 - [ToolFunction](docs/ToolFunction.md)
 - [ToolFunctionDefinition](docs/ToolFunctionDefinition.md)
 - [ToolResponseContent](docs/ToolResponseContent.md)
 - [ToolResponseContentApiResponse](docs/ToolResponseContentApiResponse.md)
 - [UpdateDatasetColumnRequest](docs/UpdateDatasetColumnRequest.md)
 - [UpdateDatasetColumnRequestSettings](docs/UpdateDatasetColumnRequestSettings.md)
 - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)
 - [UpdateEvaluatorRequest](docs/UpdateEvaluatorRequest.md)
 - [UpdateLogTraceRequest](docs/UpdateLogTraceRequest.md)
 - [UpdateLogTraceRequestAttributeItem](docs/UpdateLogTraceRequestAttributeItem.md)
 - [UpdateLogTraceRequestTagItem](docs/UpdateLogTraceRequestTagItem.md)
 - [UpdateLogTraceRequestTrace](docs/UpdateLogTraceRequestTrace.md)
 - [UpdateLogTraceResponse](docs/UpdateLogTraceResponse.md)
 - [UpdateProjectRequest](docs/UpdateProjectRequest.md)
 - [UrlImageContentValue](docs/UrlImageContentValue.md)
 - [UrlPdfContentValue](docs/UrlPdfContentValue.md)
 - [VariableModality](docs/VariableModality.md)
 - [VariableValue](docs/VariableValue.md)

## Documentation For Authorization

Authentication schemes defined for the API:

### bearerAuth

- **Type**: Bearer authentication (API Key)

## Author

