open-api-apimatic 1.0.0

OpenAPI is a standard specification for defining and documenting RESTful APIs, making them easy to understand, test, and integrate across different platforms and tools.

Getting Started with OpenAI

Introduction

The OpenAI API can be applied to virtually any task that involves understanding or generating natural language or code. We offer a spectrum of models with different levels of power suitable for different tasks, as well as the ability to fine-tune your own custom models. These models can be used for everything from content generation to semantic search and classification.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install open-api-apimatic==1.0.0

You can also view the package at: https://pypi.python.org/pypi/open-api-apimatic/1.0.0

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
bearer_auth_credentials	BearerAuthCredentials	The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

from openai.configuration import Environment
from openai.http.auth.o_auth_2 import BearerAuthCredentials
from openai.openai_client import OpenaiClient

client = OpenaiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION
)

Authorization

This API uses the following authentication schemes.

• bearer (OAuth 2 Bearer token)

List of APIs

• Models
• Completions
• Edits
• Images
• Embeddings
• Files
• Fine-Tunes
• Moderations
• Engines

SDK Infrastructure

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime