adaline-api 1.0.0
Adaline API - Auto-generated Python client for the Adaline platform
License: MIT
Requires Python: >=3.9
Keywords: adaline, sdk, api, ai, llm, OpenAPI

# adaline-api
API for managing Adaline deployments, logs, and core type definitions.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.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 (JWT): 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.DefaultApi(api_client)
    prompt_id = 'prompt_id_example' # str | The unique identifier of the prompt. Required for both specific and latest deployment retrieval.
    deployment_id = 'deployment_id_example' # str | The unique identifier of the deployment. Set to 'latest' to retrieve the latest deployment in the given environment.
    deployment_environment_id = 'deployment_environment_id_example' # str | The unique identifier of the deployment environment. Required when retrieving the latest deployment (deploymentId=latest). (optional)

    try:
        # Retrieve a specific or latest deployment
        api_response = await api_instance.deployments_get(prompt_id, deployment_id, deployment_environment_id=deployment_environment_id)
        print("The response of DefaultApi->deployments_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->deployments_get: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**deployments_get**](docs/DefaultApi.md#deployments_get) | **GET** /deployments | Retrieve a specific or latest deployment
*DefaultApi* | [**logs_span_post**](docs/DefaultApi.md#logs_span_post) | **POST** /logs/span | Create span log
*DefaultApi* | [**logs_trace_patch**](docs/DefaultApi.md#logs_trace_patch) | **PATCH** /logs/trace | Update trace log
*DefaultApi* | [**logs_trace_post**](docs/DefaultApi.md#logs_trace_post) | **POST** /logs/trace | Create trace log


## Documentation For Models

 - [Base64ImageContentValue](docs/Base64ImageContentValue.md)
 - [Base64PdfContentValue](docs/Base64PdfContentValue.md)
 - [BaseEntity](docs/BaseEntity.md)
 - [Content](docs/Content.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)
 - [Deployment](docs/Deployment.md)
 - [DeploymentPrompt](docs/DeploymentPrompt.md)
 - [DeploymentPromptConfig](docs/DeploymentPromptConfig.md)
 - [DeploymentPromptVariables](docs/DeploymentPromptVariables.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [Function](docs/Function.md)
 - [FunctionParameter](docs/FunctionParameter.md)
 - [FunctionParameters](docs/FunctionParameters.md)
 - [FunctionRequestHttp](docs/FunctionRequestHttp.md)
 - [FunctionRequestRetry](docs/FunctionRequestRetry.md)
 - [FunctionTool](docs/FunctionTool.md)
 - [FunctionToolDefinition](docs/FunctionToolDefinition.md)
 - [ImageContent](docs/ImageContent.md)
 - [ImageContentValue](docs/ImageContentValue.md)
 - [LogAttributesValue](docs/LogAttributesValue.md)
 - [LogFeedbackComment](docs/LogFeedbackComment.md)
 - [LogSpanContent](docs/LogSpanContent.md)
 - [LogSpanEmbeddingsContent](docs/LogSpanEmbeddingsContent.md)
 - [LogSpanEvent](docs/LogSpanEvent.md)
 - [LogSpanFunctionContent](docs/LogSpanFunctionContent.md)
 - [LogSpanGuardrailContent](docs/LogSpanGuardrailContent.md)
 - [LogSpanModelContent](docs/LogSpanModelContent.md)
 - [LogSpanModelStreamContent](docs/LogSpanModelStreamContent.md)
 - [LogSpanOtherContent](docs/LogSpanOtherContent.md)
 - [LogSpanParsedContent](docs/LogSpanParsedContent.md)
 - [LogSpanRetrievalContent](docs/LogSpanRetrievalContent.md)
 - [LogSpanToolContent](docs/LogSpanToolContent.md)
 - [McpServer](docs/McpServer.md)
 - [McpServerToolConfiguration](docs/McpServerToolConfiguration.md)
 - [Message](docs/Message.md)
 - [ModalityEnum](docs/ModalityEnum.md)
 - [PdfContent](docs/PdfContent.md)
 - [PdfContentFile](docs/PdfContentFile.md)
 - [PdfContentValue](docs/PdfContentValue.md)
 - [ReasoningContent](docs/ReasoningContent.md)
 - [ReasoningContentValue](docs/ReasoningContentValue.md)
 - [ReasoningContentValueUnion](docs/ReasoningContentValueUnion.md)
 - [RedactedReasoningContentValue](docs/RedactedReasoningContentValue.md)
 - [ResponseSchema](docs/ResponseSchema.md)
 - [ResponseSchemaProperty](docs/ResponseSchemaProperty.md)
 - [ResponseSchemaPropertyEnumInner](docs/ResponseSchemaPropertyEnumInner.md)
 - [ResponseSchemaPropertyType](docs/ResponseSchemaPropertyType.md)
 - [ResponseSchemaStructure](docs/ResponseSchemaStructure.md)
 - [RoleEnum](docs/RoleEnum.md)
 - [TextContent](docs/TextContent.md)
 - [ToolCallContent](docs/ToolCallContent.md)
 - [ToolResponseContent](docs/ToolResponseContent.md)
 - [ToolResponseContentApiResponse](docs/ToolResponseContentApiResponse.md)
 - [UpdateLogTraceRequest](docs/UpdateLogTraceRequest.md)
 - [UpdateLogTraceRequestAttributeItem](docs/UpdateLogTraceRequestAttributeItem.md)
 - [UpdateLogTraceRequestAttributeItemOneOf](docs/UpdateLogTraceRequestAttributeItemOneOf.md)
 - [UpdateLogTraceRequestAttributeItemOneOf1](docs/UpdateLogTraceRequestAttributeItemOneOf1.md)
 - [UpdateLogTraceRequestAttributeItemOneOfValue](docs/UpdateLogTraceRequestAttributeItemOneOfValue.md)
 - [UpdateLogTraceRequestTagItem](docs/UpdateLogTraceRequestTagItem.md)
 - [UpdateLogTraceRequestTagItemOneOf](docs/UpdateLogTraceRequestTagItemOneOf.md)
 - [UpdateLogTraceRequestTagItemOneOf1](docs/UpdateLogTraceRequestTagItemOneOf1.md)
 - [UpdateLogTraceRequestTrace](docs/UpdateLogTraceRequestTrace.md)
 - [UpdateLogTraceResponse](docs/UpdateLogTraceResponse.md)
 - [UrlImageContentValue](docs/UrlImageContentValue.md)
 - [UrlPdfContentValue](docs/UrlPdfContentValue.md)
 - [Variable](docs/Variable.md)
 - [VariableValue](docs/VariableValue.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)


## Author