OpenAI API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for oapicf from gravatar.com oapicf

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Cliffano Subagio
  • Tags OpenAPI , OpenAPI-Generator , OpenAI API
  • Requires: Python >=3.9
Report project as malware

Project description

openapiopenai

The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 2.3.0
  • Package version: 1.2.0
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/oapicf/openapi-openai

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/oapicf/openapi-openai.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/oapicf/openapi-openai.git)

Then import the package:

import openapiopenai

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 openapiopenai

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapiopenai
from openapiopenai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.openai.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapiopenai.Configuration(
    host = "https://api.openai.com/v1"
)

# 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: ApiKeyAuth
configuration = openapiopenai.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openapiopenai.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapiopenai.AssistantsApi(api_client)
    thread_id = 'thread_id_example' # str | The ID of the thread to which this run belongs.
    run_id = 'run_id_example' # str | The ID of the run to cancel.

    try:
        # Cancels a run that is `in_progress`.
        api_response = api_instance.cancel_run(thread_id, run_id)
        print("The response of AssistantsApi->cancel_run:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AssistantsApi->cancel_run: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.openai.com/v1

Class Method HTTP request Description
AssistantsApi cancel_run POST /threads/{thread_id}/runs/{run_id}/cancel Cancels a run that is `in_progress`.
AssistantsApi create_assistant POST /assistants Create an assistant with a model and instructions.
AssistantsApi create_message POST /threads/{thread_id}/messages Create a message.
AssistantsApi create_run POST /threads/{thread_id}/runs Create a run.
AssistantsApi create_thread POST /threads Create a thread.
AssistantsApi create_thread_and_run POST /threads/runs Create a thread and run it in one request.
AssistantsApi delete_assistant DELETE /assistants/{assistant_id} Delete an assistant.
AssistantsApi delete_message DELETE /threads/{thread_id}/messages/{message_id} Deletes a message.
AssistantsApi delete_thread DELETE /threads/{thread_id} Delete a thread.
AssistantsApi get_assistant GET /assistants/{assistant_id} Retrieves an assistant.
AssistantsApi get_message GET /threads/{thread_id}/messages/{message_id} Retrieve a message.
AssistantsApi get_run GET /threads/{thread_id}/runs/{run_id} Retrieves a run.
AssistantsApi get_run_step GET /threads/{thread_id}/runs/{run_id}/steps/{step_id} Retrieves a run step.
AssistantsApi get_thread GET /threads/{thread_id} Retrieves a thread.
AssistantsApi list_assistants GET /assistants Returns a list of assistants.
AssistantsApi list_messages GET /threads/{thread_id}/messages Returns a list of messages for a given thread.
AssistantsApi list_run_steps GET /threads/{thread_id}/runs/{run_id}/steps Returns a list of run steps belonging to a run.
AssistantsApi list_runs GET /threads/{thread_id}/runs Returns a list of runs belonging to a thread.
AssistantsApi modify_assistant POST /assistants/{assistant_id} Modifies an assistant.
AssistantsApi modify_message POST /threads/{thread_id}/messages/{message_id} Modifies a message.
AssistantsApi modify_run POST /threads/{thread_id}/runs/{run_id} Modifies a run.
AssistantsApi modify_thread POST /threads/{thread_id} Modifies a thread.
AssistantsApi submit_tool_ouputs_to_run POST /threads/{thread_id}/runs/{run_id}/submit_tool_outputs When a run has the `status: "requires_action"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.
AudioApi create_speech POST /audio/speech Generates audio from the input text.
AudioApi create_transcription POST /audio/transcriptions Transcribes audio into the input language.
AudioApi create_translation POST /audio/translations Translates audio into English.
AuditLogsApi list_audit_logs GET /organization/audit_logs List user actions and configuration changes within this organization.
BatchApi cancel_batch POST /batches/{batch_id}/cancel Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.
BatchApi create_batch POST /batches Creates and executes a batch from an uploaded file of requests
BatchApi list_batches GET /batches List your organization's batches.
BatchApi retrieve_batch GET /batches/{batch_id} Retrieves a batch.
ChatApi create_chat_completion POST /chat/completions Creates a model response for the given chat conversation. Learn more in the text generation, vision, and audio guides. Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.
CompletionsApi create_completion POST /completions Creates a completion for the provided prompt and parameters.
EmbeddingsApi create_embedding POST /embeddings Creates an embedding vector representing the input text.
FilesApi create_file POST /files Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the Assistants Tools guide for details. The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning chat or completions models. The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific required format. Please contact us if you need to increase these storage limits.
FilesApi delete_file DELETE /files/{file_id} Delete a file.
FilesApi download_file GET /files/{file_id}/content Returns the contents of the specified file.
FilesApi list_files GET /files Returns a list of files.
FilesApi retrieve_file GET /files/{file_id} Returns information about a specific file.
FineTuningApi cancel_fine_tuning_job POST /fine_tuning/jobs/{fine_tuning_job_id}/cancel Immediately cancel a fine-tune job.
FineTuningApi create_fine_tuning_job POST /fine_tuning/jobs Creates a fine-tuning job which begins the process of creating a new model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete. Learn more about fine-tuning
FineTuningApi list_fine_tuning_events GET /fine_tuning/jobs/{fine_tuning_job_id}/events Get status updates for a fine-tuning job.
FineTuningApi list_fine_tuning_job_checkpoints GET /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints List checkpoints for a fine-tuning job.
FineTuningApi list_paginated_fine_tuning_jobs GET /fine_tuning/jobs List your organization's fine-tuning jobs
FineTuningApi retrieve_fine_tuning_job GET /fine_tuning/jobs/{fine_tuning_job_id} Get info about a fine-tuning job. Learn more about fine-tuning
ImagesApi create_image POST /images/generations Creates an image given a prompt.
ImagesApi create_image_edit POST /images/edits Creates an edited or extended image given an original image and a prompt.
ImagesApi create_image_variation POST /images/variations Creates a variation of a given image.
InvitesApi delete_invite DELETE /organization/invites/{invite_id} Delete an invite. If the invite has already been accepted, it cannot be deleted.
InvitesApi invite_user POST /organization/invites Create an invite for a user to the organization. The invite must be accepted by the user before they have access to the organization.
InvitesApi list_invites GET /organization/invites Returns a list of invites in the organization.
InvitesApi retrieve_invite GET /organization/invites/{invite_id} Retrieves an invite.
ModelsApi delete_model DELETE /models/{model} Delete a fine-tuned model. You must have the Owner role in your organization to delete a model.
ModelsApi list_models GET /models Lists the currently available models, and provides basic information about each one such as the owner and availability.
ModelsApi retrieve_model GET /models/{model} Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
ModerationsApi create_moderation POST /moderations Classifies if text and/or image inputs are potentially harmful. Learn more in the moderation guide.
ProjectsApi archive_project POST /organization/projects/{project_id}/archive Archives a project in the organization. Archived projects cannot be used or updated.
ProjectsApi create_project POST /organization/projects Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
ProjectsApi create_project_service_account POST /organization/projects/{project_id}/service_accounts Creates a new service account in the project. This also returns an unredacted API key for the service account.
ProjectsApi create_project_user POST /organization/projects/{project_id}/users Adds a user to the project. Users must already be members of the organization to be added to a project.
ProjectsApi delete_project_api_key DELETE /organization/projects/{project_id}/api_keys/{key_id} Deletes an API key from the project.
ProjectsApi delete_project_service_account DELETE /organization/projects/{project_id}/service_accounts/{service_account_id} Deletes a service account from the project.
ProjectsApi delete_project_user DELETE /organization/projects/{project_id}/users/{user_id} Deletes a user from the project.
ProjectsApi list_project_api_keys GET /organization/projects/{project_id}/api_keys Returns a list of API keys in the project.
ProjectsApi list_project_rate_limits GET /organization/projects/{project_id}/rate_limits Returns the rate limits per model for a project.
ProjectsApi list_project_service_accounts GET /organization/projects/{project_id}/service_accounts Returns a list of service accounts in the project.
ProjectsApi list_project_users GET /organization/projects/{project_id}/users Returns a list of users in the project.
ProjectsApi list_projects GET /organization/projects Returns a list of projects.
ProjectsApi modify_project POST /organization/projects/{project_id} Modifies a project in the organization.
ProjectsApi modify_project_user POST /organization/projects/{project_id}/users/{user_id} Modifies a user's role in the project.
ProjectsApi retrieve_project GET /organization/projects/{project_id} Retrieves a project.
ProjectsApi retrieve_project_api_key GET /organization/projects/{project_id}/api_keys/{key_id} Retrieves an API key in the project.
ProjectsApi retrieve_project_service_account GET /organization/projects/{project_id}/service_accounts/{service_account_id} Retrieves a service account in the project.
ProjectsApi retrieve_project_user GET /organization/projects/{project_id}/users/{user_id} Retrieves a user in the project.
ProjectsApi update_project_rate_limits POST /organization/projects/{project_id}/rate_limits/{rate_limit_id} Updates a project rate limit.
RealtimeApi create_realtime_session POST /realtime/sessions Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the `session.update` client event. It responds with a session object, plus a `client_secret` key which contains a usable ephemeral API token that can be used to authenticate browser clients for the Realtime API.
UploadsApi add_upload_part POST /uploads/{upload_id}/parts Adds a Part to an Upload object. A Part represents a chunk of bytes from the file you are trying to upload. Each Part can be at most 64 MB, and you can add Parts until you hit the Upload maximum of 8 GB. It is possible to add multiple Parts in parallel. You can decide the intended order of the Parts when you complete the Upload.
UploadsApi cancel_upload POST /uploads/{upload_id}/cancel Cancels the Upload. No Parts may be added after an Upload is cancelled.
UploadsApi complete_upload POST /uploads/{upload_id}/complete Completes the Upload. Within the returned Upload object, there is a nested File object that is ready to use in the rest of the platform. You can specify the order of the Parts by passing in an ordered list of the Part IDs. The number of bytes uploaded upon completion must match the number of bytes initially specified when creating the Upload object. No Parts may be added after an Upload is completed.
UploadsApi create_upload POST /uploads Creates an intermediate Upload object that you can add Parts to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a File object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: - Assistants For guidance on the proper filename extensions for each purpose, please follow the documentation on creating a File.
UsageApi usage_audio_speeches GET /organization/usage/audio_speeches Get audio speeches usage details for the organization.
UsageApi usage_audio_transcriptions GET /organization/usage/audio_transcriptions Get audio transcriptions usage details for the organization.
UsageApi usage_code_interpreter_sessions GET /organization/usage/code_interpreter_sessions Get code interpreter sessions usage details for the organization.
UsageApi usage_completions GET /organization/usage/completions Get completions usage details for the organization.
UsageApi usage_costs GET /organization/costs Get costs details for the organization.
UsageApi usage_embeddings GET /organization/usage/embeddings Get embeddings usage details for the organization.
UsageApi usage_images GET /organization/usage/images Get images usage details for the organization.
UsageApi usage_moderations GET /organization/usage/moderations Get moderations usage details for the organization.
UsageApi usage_vector_stores GET /organization/usage/vector_stores Get vector stores usage details for the organization.
UsersApi delete_user DELETE /organization/users/{user_id} Deletes a user from the organization.
UsersApi list_users GET /organization/users Lists all of the users in the organization.
UsersApi modify_user POST /organization/users/{user_id} Modifies a user's role in the organization.
UsersApi retrieve_user GET /organization/users/{user_id} Retrieves a user by their identifier.
VectorStoresApi cancel_vector_store_file_batch POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
VectorStoresApi create_vector_store POST /vector_stores Create a vector store.
VectorStoresApi create_vector_store_file POST /vector_stores/{vector_store_id}/files Create a vector store file by attaching a File to a vector store.
VectorStoresApi create_vector_store_file_batch POST /vector_stores/{vector_store_id}/file_batches Create a vector store file batch.
VectorStoresApi delete_vector_store DELETE /vector_stores/{vector_store_id} Delete a vector store.
VectorStoresApi delete_vector_store_file DELETE /vector_stores/{vector_store_id}/files/{file_id} Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.
VectorStoresApi get_vector_store GET /vector_stores/{vector_store_id} Retrieves a vector store.
VectorStoresApi get_vector_store_file GET /vector_stores/{vector_store_id}/files/{file_id} Retrieves a vector store file.
VectorStoresApi get_vector_store_file_batch GET /vector_stores/{vector_store_id}/file_batches/{batch_id} Retrieves a vector store file batch.
VectorStoresApi list_files_in_vector_store_batch GET /vector_stores/{vector_store_id}/file_batches/{batch_id}/files Returns a list of vector store files in a batch.
VectorStoresApi list_vector_store_files GET /vector_stores/{vector_store_id}/files Returns a list of vector store files.
VectorStoresApi list_vector_stores GET /vector_stores Returns a list of vector stores.
VectorStoresApi modify_vector_store POST /vector_stores/{vector_store_id} Modifies a vector store.
DefaultApi admin_api_keys_create POST /organization/admin_api_keys Create an organization admin API key
DefaultApi admin_api_keys_delete DELETE /organization/admin_api_keys/{key_id} Delete an organization admin API key
DefaultApi admin_api_keys_get GET /organization/admin_api_keys/{key_id} Retrieve a single organization API key
DefaultApi admin_api_keys_list GET /organization/admin_api_keys List organization API keys

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: Bearer authentication

Author

blah+oapicf@cliffano.com

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for oapicf from gravatar.com oapicf

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Cliffano Subagio
  • Tags OpenAPI , OpenAPI-Generator , OpenAI API
  • Requires: Python >=3.9

Release history Release notifications | RSS feed

This version

1.2.0

1.1.0

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapiopenai-1.2.0.tar.gz (367.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openapiopenai-1.2.0-py3-none-any.whl (962.7 kB view details)

Uploaded Python 3

File details

Details for the file openapiopenai-1.2.0.tar.gz.

File metadata

  • Download URL: openapiopenai-1.2.0.tar.gz
  • Upload date:
  • Size: 367.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for openapiopenai-1.2.0.tar.gz
Algorithm Hash digest
SHA256 ea568b5c0996830e9fcb722ca6a484fad79b6385b2993440f85d9f81bcb5741e
MD5 d6d0a79930ad60d53a41a5ec0fb0c012
BLAKE2b-256 dafae7ae1dbcf89d247ebbd5c66eed68a8333a62b32240540d40a122c4115202

See more details on using hashes here.

File details

Details for the file openapiopenai-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: openapiopenai-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 962.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for openapiopenai-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7df4f47f4120afd683eccd6e0b2b08c158fa0641c80859a951517570146a1c66
MD5 6005a098cc80e3fc974ab975e59df105
BLAKE2b-256 530f6e5fe82c5c692318a6b23134ed4868b7f69bbb4fca542877d5820615f149

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page