Skip to content

Commit e58d6f8

Browse files
committed
docs: add basic manual azure example
1 parent 116db59 commit e58d6f8

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

examples/azure.py

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
import os
2+
from openai import OpenAI
3+
4+
5+
# The name of your Azure OpenAI Resource.
6+
# https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal#create-a-resource
7+
resource = "<your resource name>"
8+
9+
# Corresponds to your Model deployment within your OpenAI resource, e.g. my-gpt35-16k-deployment
10+
# Navigate to the Azure OpenAI Studio to deploy a model.
11+
model = "<your model>"
12+
13+
# https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#rest-api-versioning
14+
api_version = "2023-08-01-preview"
15+
16+
api_key = os.environ.get("AZURE_OPENAI_API_KEY")
17+
18+
if not api_key:
19+
raise Exception("The AZURE_OPENAI_API_KEY environment variable is missing or empty.")
20+
21+
# Azure OpenAI requires a custom baseURL, api-version query param, and api-key header.
22+
client = OpenAI(
23+
api_key=api_key,
24+
base_url=f"https://{resource}.openai.azure.com/openai/deployments/{model}",
25+
default_query={
26+
"api-version": api_version,
27+
},
28+
default_headers={"api-key": api_key},
29+
)
30+
31+
completion = client.chat.completions.create(
32+
model="gpt-4",
33+
messages=[
34+
{
35+
"role": "user",
36+
"content": "How do I output all files in a directory using Python?",
37+
},
38+
],
39+
)
40+
print(completion.model_dump_json(indent=2))

0 commit comments

Comments
 (0)