openai/openai-python
Publicmirrored fromhttps://github.com/openai/openai-pythonAvailable
api.md
172lines · modecode
| 1 | # Completions |
| 2 | |
| 3 | Types: |
| 4 | |
| 5 | ```python |
| 6 | from openai.types import Completion, CompletionChoice, CompletionUsage |
| 7 | ``` |
| 8 | |
| 9 | Methods: |
| 10 | |
| 11 | - <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code> |
| 12 | |
| 13 | # Chat |
| 14 | |
| 15 | ## Completions |
| 16 | |
| 17 | Types: |
| 18 | |
| 19 | ```python |
| 20 | from openai.types.chat import ( |
| 21 | ChatCompletion, |
| 22 | ChatCompletionChunk, |
| 23 | ChatCompletionMessage, |
| 24 | ChatCompletionMessageParam, |
| 25 | ChatCompletionRole, |
| 26 | ) |
| 27 | ``` |
| 28 | |
| 29 | Methods: |
| 30 | |
| 31 | - <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code> |
| 32 | |
| 33 | # Edits |
| 34 | |
| 35 | Types: |
| 36 | |
| 37 | ```python |
| 38 | from openai.types import Edit |
| 39 | ``` |
| 40 | |
| 41 | Methods: |
| 42 | |
| 43 | - <code title="post /edits">client.edits.<a href="./src/openai/resources/edits.py">create</a>(\*\*<a href="src/openai/types/edit_create_params.py">params</a>) -> <a href="./src/openai/types/edit.py">Edit</a></code> |
| 44 | |
| 45 | # Embeddings |
| 46 | |
| 47 | Types: |
| 48 | |
| 49 | ```python |
| 50 | from openai.types import CreateEmbeddingResponse, Embedding |
| 51 | ``` |
| 52 | |
| 53 | Methods: |
| 54 | |
| 55 | - <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code> |
| 56 | |
| 57 | # Files |
| 58 | |
| 59 | Types: |
| 60 | |
| 61 | ```python |
| 62 | from openai.types import FileContent, FileDeleted, FileObject |
| 63 | ``` |
| 64 | |
| 65 | Methods: |
| 66 | |
| 67 | - <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code> |
| 68 | - <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code> |
| 69 | - <code title="get /files">client.files.<a href="./src/openai/resources/files.py">list</a>() -> <a href="./src/openai/types/file_object.py">SyncPage[FileObject]</a></code> |
| 70 | - <code title="delete /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">delete</a>(file_id) -> <a href="./src/openai/types/file_deleted.py">FileDeleted</a></code> |
| 71 | - <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> str</code> |
| 72 | - <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code> |
| 73 | |
| 74 | # Images |
| 75 | |
| 76 | Types: |
| 77 | |
| 78 | ```python |
| 79 | from openai.types import Image, ImagesResponse |
| 80 | ``` |
| 81 | |
| 82 | Methods: |
| 83 | |
| 84 | - <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code> |
| 85 | - <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code> |
| 86 | - <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code> |
| 87 | |
| 88 | # Audio |
| 89 | |
| 90 | ## Transcriptions |
| 91 | |
| 92 | Types: |
| 93 | |
| 94 | ```python |
| 95 | from openai.types.audio import Transcription |
| 96 | ``` |
| 97 | |
| 98 | Methods: |
| 99 | |
| 100 | - <code title="post /audio/transcriptions">client.audio.transcriptions.<a href="./src/openai/resources/audio/transcriptions.py">create</a>(\*\*<a href="src/openai/types/audio/transcription_create_params.py">params</a>) -> <a href="./src/openai/types/audio/transcription.py">Transcription</a></code> |
| 101 | |
| 102 | ## Translations |
| 103 | |
| 104 | Types: |
| 105 | |
| 106 | ```python |
| 107 | from openai.types.audio import Translation |
| 108 | ``` |
| 109 | |
| 110 | Methods: |
| 111 | |
| 112 | - <code title="post /audio/translations">client.audio.translations.<a href="./src/openai/resources/audio/translations.py">create</a>(\*\*<a href="src/openai/types/audio/translation_create_params.py">params</a>) -> <a href="./src/openai/types/audio/translation.py">Translation</a></code> |
| 113 | |
| 114 | # Moderations |
| 115 | |
| 116 | Types: |
| 117 | |
| 118 | ```python |
| 119 | from openai.types import Moderation, ModerationCreateResponse |
| 120 | ``` |
| 121 | |
| 122 | Methods: |
| 123 | |
| 124 | - <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code> |
| 125 | |
| 126 | # Models |
| 127 | |
| 128 | Types: |
| 129 | |
| 130 | ```python |
| 131 | from openai.types import Model, ModelDeleted |
| 132 | ``` |
| 133 | |
| 134 | Methods: |
| 135 | |
| 136 | - <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code> |
| 137 | - <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code> |
| 138 | - <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code> |
| 139 | |
| 140 | # FineTuning |
| 141 | |
| 142 | ## Jobs |
| 143 | |
| 144 | Types: |
| 145 | |
| 146 | ```python |
| 147 | from openai.types.fine_tuning import FineTuningJob, FineTuningJobEvent |
| 148 | ``` |
| 149 | |
| 150 | Methods: |
| 151 | |
| 152 | - <code title="post /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs.py">create</a>(\*\*<a href="src/openai/types/fine_tuning/job_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code> |
| 153 | - <code title="get /fine_tuning/jobs/{fine_tuning_job_id}">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs.py">retrieve</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code> |
| 154 | - <code title="get /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs.py">list</a>(\*\*<a href="src/openai/types/fine_tuning/job_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">SyncCursorPage[FineTuningJob]</a></code> |
| 155 | - <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/cancel">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs.py">cancel</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code> |
| 156 | - <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/events">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs.py">list_events</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/job_list_events_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job_event.py">SyncCursorPage[FineTuningJobEvent]</a></code> |
| 157 | |
| 158 | # FineTunes |
| 159 | |
| 160 | Types: |
| 161 | |
| 162 | ```python |
| 163 | from openai.types import FineTune, FineTuneEvent, FineTuneEventsListResponse |
| 164 | ``` |
| 165 | |
| 166 | Methods: |
| 167 | |
| 168 | - <code title="post /fine-tunes">client.fine_tunes.<a href="./src/openai/resources/fine_tunes.py">create</a>(\*\*<a href="src/openai/types/fine_tune_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tune.py">FineTune</a></code> |
| 169 | - <code title="get /fine-tunes/{fine_tune_id}">client.fine_tunes.<a href="./src/openai/resources/fine_tunes.py">retrieve</a>(fine_tune_id) -> <a href="./src/openai/types/fine_tune.py">FineTune</a></code> |
| 170 | - <code title="get /fine-tunes">client.fine_tunes.<a href="./src/openai/resources/fine_tunes.py">list</a>() -> <a href="./src/openai/types/fine_tune.py">SyncPage[FineTune]</a></code> |
| 171 | - <code title="post /fine-tunes/{fine_tune_id}/cancel">client.fine_tunes.<a href="./src/openai/resources/fine_tunes.py">cancel</a>(fine_tune_id) -> <a href="./src/openai/types/fine_tune.py">FineTune</a></code> |
| 172 | - <code title="get /fine-tunes/{fine_tune_id}/events">client.fine_tunes.<a href="./src/openai/resources/fine_tunes.py">list_events</a>(fine_tune_id, \*\*<a href="src/openai/types/fine_tune_list_events_params.py">params</a>) -> <a href="./src/openai/types/fine_tune_events_list_response.py">FineTuneEventsListResponse</a></code> |