adaline-api 2.0.0

Adaline API

adaline-api

API for managing Adaline deployments, logs, and core type definitions.

This Python package is automatically generated by the OpenAPI Generator 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:

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 (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.get_deployment(prompt_id, deployment_id, deployment_environment_id=deployment_environment_id)
        print("The response of DefaultApi->get_deployment:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_deployment: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DefaultApi	get_deployment	GET /deployments	Retrieve a specific or latest deployment
DefaultApi	patch_log_trace	PATCH /logs/trace	Update trace log
DefaultApi	post_log_span	POST /logs/span	Create span log
DefaultApi	post_log_trace	POST /logs/trace	Create trace log

Documentation For Models

• Base64ImageContentValue
• Base64PdfContentValue
• BaseEntity
• Content
• CreateLogSpanRequest
• CreateLogSpanRequestSpan
• CreateLogSpanResponse
• CreateLogTraceRequest
• CreateLogTraceRequestSpan
• CreateLogTraceRequestTrace
• CreateLogTraceResponse
• Deployment
• DeploymentPrompt
• DeploymentPromptConfig
• DeploymentPromptVariables
• ErrorResponse
• Function
• FunctionParameter
• FunctionParameters
• FunctionRequestHttp
• FunctionRequestRetry
• FunctionTool
• FunctionToolDefinition
• ImageContent
• ImageContentValue
• LogAttributesValue
• LogFeedbackComment
• LogSpanContent
• LogSpanEmbeddingsContent
• LogSpanEvent
• LogSpanFunctionContent
• LogSpanGuardrailContent
• LogSpanModelContent
• LogSpanModelStreamContent
• LogSpanOtherContent
• LogSpanParsedContent
• LogSpanRetrievalContent
• LogSpanToolContent
• McpServer
• McpServerToolConfiguration
• Message
• ModalityEnum
• PdfContent
• PdfContentFile
• PdfContentValue
• ReasoningContent
• ReasoningContentValue
• ReasoningContentValueUnion
• RedactedReasoningContentValue
• ResponseSchema
• ResponseSchemaProperty
• ResponseSchemaPropertyEnumInner
• ResponseSchemaPropertyType
• ResponseSchemaStructure
• RoleEnum
• TextContent
• ToolCallContent
• ToolResponseContent
• ToolResponseContentApiResponse
• UpdateLogTraceRequest
• UpdateLogTraceRequestAttributeItem
• UpdateLogTraceRequestAttributeItemOneOf
• UpdateLogTraceRequestAttributeItemOneOf1
• UpdateLogTraceRequestAttributeItemOneOfValue
• UpdateLogTraceRequestTagItem
• UpdateLogTraceRequestTagItemOneOf
• UpdateLogTraceRequestTagItemOneOf1
• UpdateLogTraceRequestTrace
• UpdateLogTraceResponse
• UrlImageContentValue
• UrlPdfContentValue
• Variable
• VariableValue

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author