openai/openai-python
Publicmirrored fromhttps://github.com/openai/openai-pythonAvailable
README.md
203lines · modecode
| 1 | # OpenAI Python Library |
| 2 | |
| 3 | The OpenAI Python library provides convenient access to the OpenAI API |
| 4 | from applications written in the Python language. It includes a |
| 5 | pre-defined set of classes for API resources that initialize |
| 6 | themselves dynamically from API responses which makes it compatible |
| 7 | with a wide range of versions of the OpenAI API. |
| 8 | |
| 9 | ## Documentation |
| 10 | |
| 11 | See the [OpenAI API docs](https://beta.openai.com/docs/api-reference?lang=python). |
| 12 | |
| 13 | ## Installation |
| 14 | |
| 15 | You don't need this source code unless you want to modify the package. If you just |
| 16 | want to use the package, just run: |
| 17 | |
| 18 | ```sh |
| 19 | pip install --upgrade openai |
| 20 | ``` |
| 21 | |
| 22 | Install from source with: |
| 23 | |
| 24 | ```sh |
| 25 | python setup.py install |
| 26 | ``` |
| 27 | |
| 28 | ## Usage |
| 29 | |
| 30 | The library needs to be configured with your account's secret key which is available on the [website](https://beta.openai.com/account/api-keys). Either set it as the `OPENAI_API_KEY` environment variable before using the library: |
| 31 | |
| 32 | ```bash |
| 33 | export OPENAI_API_KEY='sk-...' |
| 34 | ``` |
| 35 | |
| 36 | Or set `openai.api_key` to its value: |
| 37 | |
| 38 | ```python |
| 39 | import openai |
| 40 | openai.api_key = "sk-..." |
| 41 | |
| 42 | # list engines |
| 43 | engines = openai.Engine.list() |
| 44 | |
| 45 | # print the first engine's id |
| 46 | print(engines.data[0].id) |
| 47 | |
| 48 | # create a completion |
| 49 | completion = openai.Completion.create(engine="ada", prompt="Hello world") |
| 50 | |
| 51 | # print the completion |
| 52 | print(completion.choices[0].text) |
| 53 | ``` |
| 54 | |
| 55 | |
| 56 | ### Params |
| 57 | All endpoints have a `.create` method that support a `request_timeout` param. This param takes a `Union[float, Tuple[float, float]]` and will raise a `openai.error.TimeoutError` error if the request exceeds that time in seconds (See: https://requests.readthedocs.io/en/latest/user/quickstart/#timeouts). |
| 58 | |
| 59 | ### Microsoft Azure Endpoints |
| 60 | |
| 61 | In order to use the library with Microsoft Azure endpoints, you need to set the api_type, api_base and api_version in addition to the api_key. The api_type must be set to 'azure' and the others correspond to the properties of your endpoint. |
| 62 | In addition, the deployment name must be passed as the engine parameter. |
| 63 | |
| 64 | ```python |
| 65 | import openai |
| 66 | openai.api_type = "azure" |
| 67 | openai.api_key = "..." |
| 68 | openai.api_base = "https://example-endpoint.openai.azure.com" |
| 69 | openai.api_version = "2021-11-01-preview" |
| 70 | |
| 71 | # create a completion |
| 72 | completion = openai.Completion.create(engine="deployment-name", prompt="Hello world") |
| 73 | |
| 74 | # print the completion |
| 75 | print(completion.choices[0].text) |
| 76 | |
| 77 | # create a search and pass the deployment-name as the engine Id. |
| 78 | search = openai.Engine(id="deployment-name").search(documents=["White House", "hospital", "school"], query ="the president") |
| 79 | |
| 80 | # print the search |
| 81 | print(search) |
| 82 | ``` |
| 83 | |
| 84 | Please note that for the moment, the Microsoft Azure endpoints can only be used for completion, search and fine-tuning operations. |
| 85 | For a detailed example on how to use fine-tuning and other operations using Azure endpoints, please check out the following Jupyter notebooks: |
| 86 | * [Using Azure fine-tuning](https://github.com/openai/openai-cookbook/tree/main/examples/azure/finetuning.ipynb) |
| 87 | * [Using Azure embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/azure/embeddings.ipynb) |
| 88 | |
| 89 | ### Microsoft Azure Active Directory Authentication |
| 90 | |
| 91 | In order to use Microsoft Active Directory to authenticate to your Azure endpoint, you need to set the api_type to "azure_ad" and pass the acquired credential token to api_key. The rest of the parameters need to be set as specified in the previous section. |
| 92 | |
| 93 | |
| 94 | ```python |
| 95 | from azure.identity import DefaultAzureCredential |
| 96 | import openai |
| 97 | |
| 98 | # Request credential |
| 99 | default_credential = DefaultAzureCredential() |
| 100 | token = default_credential.get_token("https://cognitiveservices.azure.com") |
| 101 | |
| 102 | # Setup parameters |
| 103 | openai.api_type = "azure_ad" |
| 104 | openai.api_key = token.token |
| 105 | openai.api_base = "https://example-endpoint.openai.azure.com/" |
| 106 | openai.api_version = "2022-03-01-preview" |
| 107 | |
| 108 | # ... |
| 109 | ``` |
| 110 | ### Command-line interface |
| 111 | |
| 112 | This library additionally provides an `openai` command-line utility |
| 113 | which makes it easy to interact with the API from your terminal. Run |
| 114 | `openai api -h` for usage. |
| 115 | |
| 116 | ```sh |
| 117 | # list engines |
| 118 | openai api engines.list |
| 119 | |
| 120 | # create a completion |
| 121 | openai api completions.create -e ada -p "Hello world" |
| 122 | ``` |
| 123 | |
| 124 | ## Example code |
| 125 | |
| 126 | Examples of how to use this Python library to accomplish various tasks can be found in the [OpenAI Cookbook](https://github.com/openai/openai-cookbook/). It contains code examples for: |
| 127 | |
| 128 | * Classification using fine-tuning |
| 129 | * Clustering |
| 130 | * Code search |
| 131 | * Customizing embeddings |
| 132 | * Question answering from a corpus of documents |
| 133 | * Recommendations |
| 134 | * Visualization of embeddings |
| 135 | * And more |
| 136 | |
| 137 | Prior to July 2022, this OpenAI Python library hosted code examples in its examples folder, but since then all examples have been migrated to the [OpenAI Cookbook](https://github.com/openai/openai-cookbook/). |
| 138 | |
| 139 | ### Embeddings |
| 140 | |
| 141 | In the OpenAI Python library, an embedding represents a text string as a fixed-length vector of floating point numbers. Embeddings are designed to measure the similarity or relevance between text strings. |
| 142 | |
| 143 | To get an embedding for a text string, you can use the embeddings method as follows in Python: |
| 144 | |
| 145 | ```python |
| 146 | import openai |
| 147 | openai.api_key = "sk-..." # supply your API key however you choose |
| 148 | |
| 149 | # choose text to embed |
| 150 | text_string = "sample text" |
| 151 | |
| 152 | # choose an embedding |
| 153 | model_id = "text-similarity-davinci-001" |
| 154 | |
| 155 | # compute the embedding of the text |
| 156 | embedding = openai.Embedding.create(input=text_string, engine=model_id)['data'][0]['embedding'] |
| 157 | ``` |
| 158 | |
| 159 | An example of how to call the embeddings method is shown in this [get embeddings notebook](https://github.com/openai/openai-cookbook/blob/main/examples/Get_embeddings.ipynb). |
| 160 | |
| 161 | Examples of how to use embeddings are shared in the following Jupyter notebooks: |
| 162 | |
| 163 | - [Classification using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Classification_using_embeddings.ipynb) |
| 164 | - [Clustering using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Clustering.ipynb) |
| 165 | - [Code search using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Code_search.ipynb) |
| 166 | - [Semantic text search using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Semantic_text_search_using_embeddings.ipynb) |
| 167 | - [User and product embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/User_and_product_embeddings.ipynb) |
| 168 | - [Zero-shot classification using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Zero-shot_classification_with_embeddings.ipynb) |
| 169 | - [Recommendation using embeddings](https://github.com/openai/openai-cookbook/blob/main/examples/Recommendation_using_embeddings.ipynb) |
| 170 | |
| 171 | For more information on embeddings and the types of embeddings OpenAI offers, read the [embeddings guide](https://beta.openai.com/docs/guides/embeddings) in the OpenAI documentation. |
| 172 | |
| 173 | ### Fine tuning |
| 174 | |
| 175 | Fine tuning a model on training data can both improve the results (by giving the model more examples to learn from) and reduce the cost & latency of API calls (by reducing the need to include training examples in prompts). |
| 176 | |
| 177 | Examples of fine tuning are shared in the following Jupyter notebooks: |
| 178 | |
| 179 | - [Classification with fine tuning](https://github.com/openai/openai-cookbook/blob/main/examples/Fine-tuned_classification.ipynb) (a simple notebook that shows the steps required for fine tuning) |
| 180 | - Fine tuning a model that answers questions about the 2020 Olympics |
| 181 | - [Step 1: Collecting data](https://github.com/openai/openai-cookbook/blob/main/examples/fine-tuned_qa/olympics-1-collect-data.ipynb) |
| 182 | - [Step 2: Creating a synthetic Q&A dataset](https://github.com/openai/openai-cookbook/blob/main/examples/fine-tuned_qa/olympics-2-create-qa.ipynb) |
| 183 | - [Step 3: Train a fine-tuning model specialized for Q&A](https://github.com/openai/openai-cookbook/blob/main/examples/fine-tuned_qa/olympics-3-train-qa.ipynb) |
| 184 | |
| 185 | Sync your fine-tunes to [Weights & Biases](https://wandb.me/openai-docs) to track experiments, models, and datasets in your central dashboard with: |
| 186 | |
| 187 | ```bash |
| 188 | openai wandb sync |
| 189 | ``` |
| 190 | |
| 191 | For more information on fine tuning, read the [fine-tuning guide](https://beta.openai.com/docs/guides/fine-tuning) in the OpenAI documentation. |
| 192 | |
| 193 | ## Requirements |
| 194 | |
| 195 | - Python 3.7.1+ |
| 196 | |
| 197 | In general we want to support the versions of Python that our |
| 198 | customers are using, so if you run into issues with any version |
| 199 | issues, please let us know at support@openai.com. |
| 200 | |
| 201 | ## Credit |
| 202 | |
| 203 | This library is forked from the [Stripe Python Library](https://github.com/stripe/stripe-python). |
| 204 | |