Skip to content

Commit 873a007

Browse files
karthikmurali60lemillermicrosoftglahaye
authored and
SOE-YoungS
committed
Python: Update examples and notebooks to stop using text-davinci-003 (microsoft#2359)
### Motivation and Context text-davinci-003 is being retired by Azure OpenAI and is no longer supported for new deployments Resolves - microsoft#2309 <!-- Thank you for your contribution to the semantic-kernel repo! Please help reviewers and future users, providing the following information: 1. Why is this change required? 2. What problem does it solve? 3. What scenario does it contribute to? 4. If it fixes an open issue, please link to the issue here. --> ### Description Update examples and notebooks to use gpt-35-turbo / gpt-3.5-turbo instead <!-- Describe your changes, the overall approach, the underlying design. These notes will help understanding how your code works. Thanks! --> ### Contribution Checklist <!-- Before submitting this PR, please make sure: --> - [ ] The code builds clean without any errors or warnings - [ ] The PR follows the [SK Contribution Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md) and the [pre-submission formatting script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts) raises no violations - [ ] All unit tests pass, and I have added new tests where possible - [ ] I didn't break anyone 😄 Signed-off-by: karthikmurali60 <[email protected]> Co-authored-by: Lee Miller <[email protected]> Co-authored-by: Gil LaHaye <[email protected]>
1 parent e1b13b1 commit 873a007

13 files changed

+45
-45
lines changed

‎python/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ kernel = sk.Kernel()
3232

3333
# Prepare OpenAI service using credentials stored in the `.env` file
3434
api_key, org_id = sk.openai_settings_from_dot_env()
35-
kernel.add_text_completion_service("dv", OpenAITextCompletion("text-davinci-003", api_key, org_id))
35+
kernel.add_chat_service("chat-gpt", OpenAIChatCompletion("gpt-3.5-turbo", api_key, org_id))
3636

3737
# Alternative using Azure:
3838
# deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()

‎python/notebooks/00-getting-started.ipynb

+6-6
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
"OPENAI_ORG_ID=\"\"\n",
4545
"```\n",
4646
"\n",
47-
"and add OpenAI Text Completion to the kernel:"
47+
"and add OpenAI Chat Completion to the kernel:"
4848
]
4949
},
5050
{
@@ -53,11 +53,11 @@
5353
"metadata": {},
5454
"outputs": [],
5555
"source": [
56-
"from semantic_kernel.connectors.ai.open_ai import OpenAITextCompletion\n",
56+
"from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion\n",
5757
"\n",
5858
"api_key, org_id = sk.openai_settings_from_dot_env()\n",
5959
"\n",
60-
"kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
60+
"kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))"
6161
]
6262
},
6363
{
@@ -75,7 +75,7 @@
7575
"AZURE_OPENAI_DEPLOYMENT_NAME=\"...\"\n",
7676
"```\n",
7777
"\n",
78-
"and add Azure OpenAI Text Completion to the kernel:"
78+
"and add Azure OpenAI Chat Completion to the kernel:"
7979
]
8080
},
8181
{
@@ -84,11 +84,11 @@
8484
"metadata": {},
8585
"outputs": [],
8686
"source": [
87-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion\n",
87+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion\n",
8888
"\n",
8989
"deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
9090
"\n",
91-
"kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))"
91+
"kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n"
9292
]
9393
},
9494
{

‎python/notebooks/01-basic-loading-the-kernel.ipynb

+7-7
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
"outputs": [],
3636
"source": [
3737
"import semantic_kernel as sk\n",
38-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion"
38+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion"
3939
]
4040
},
4141
{
@@ -87,19 +87,19 @@
8787
"source": [
8888
"kernel = sk.Kernel()\n",
8989
"\n",
90-
"kernel.add_text_completion_service( # We are adding a text service\n",
90+
"kernel.add_chat_service( # We are adding a text service\n",
9191
" \"Azure_curie\", # The alias we can use in prompt templates' config.json\n",
92-
" AzureTextCompletion(\n",
92+
" AzureChatCompletion(\n",
9393
" \"my-finetuned-Curie\", # Azure OpenAI *Deployment name*\n",
9494
" \"https://contoso.openai.azure.com/\", # Azure OpenAI *Endpoint*\n",
9595
" \"...your Azure OpenAI Key...\" # Azure OpenAI *Key*\n",
9696
" )\n",
9797
")\n",
9898
"\n",
99-
"kernel.add_text_completion_service( # We are adding a text service\n",
100-
" \"OpenAI_davinci\", # The alias we can use in prompt templates' config.json\n",
101-
" OpenAITextCompletion(\n",
102-
" \"text-davinci-003\", # OpenAI Model Name\n",
99+
"kernel.add_chat_service( # We are adding a text service\n",
100+
" \"OpenAI_chat_gpt\", # The alias we can use in prompt templates' config.json\n",
101+
" OpenAIChatCompletion(\n",
102+
" \"gpt-3.5-turbo\", # OpenAI Model Name\n",
103103
" \"...your OpenAI API Key...\", # OpenAI API key\n",
104104
" \"...your OpenAI Org ID...\" # *optional* OpenAI Organization ID\n",
105105
" )\n",

‎python/notebooks/02-running-prompts-from-file.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
"outputs": [],
101101
"source": [
102102
"import semantic_kernel as sk\n",
103-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion\n",
103+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion\n",
104104
"\n",
105105
"kernel = sk.Kernel()\n",
106106
"\n",
@@ -109,10 +109,10 @@
109109
"# Configure AI service used by the kernel\n",
110110
"if useAzureOpenAI:\n",
111111
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
112-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
112+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
113113
"else:\n",
114114
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
115-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
115+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))"
116116
]
117117
},
118118
{

‎python/notebooks/04-context-variables-chat.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"outputs": [],
3838
"source": [
3939
"import semantic_kernel as sk\n",
40-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion\n",
40+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion\n",
4141
"\n",
4242
"kernel = sk.Kernel()\n",
4343
"\n",
@@ -46,10 +46,10 @@
4646
"# Configure AI service used by the kernel\n",
4747
"if useAzureOpenAI:\n",
4848
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
49-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
49+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
5050
"else:\n",
5151
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
52-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
52+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))\n"
5353
]
5454
},
5555
{

‎python/notebooks/06-memory-and-embeddings.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"from typing import Tuple\n",
4242
"\n",
4343
"import semantic_kernel as sk\n",
44-
"from semantic_kernel.connectors.ai.open_ai import OpenAITextCompletion, OpenAITextEmbedding, AzureTextCompletion, AzureTextEmbedding"
44+
"from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion, OpenAITextEmbedding, AzureChatCompletion, AzureTextEmbedding"
4545
]
4646
},
4747
{
@@ -70,12 +70,12 @@
7070
"# Configure AI service used by the kernel\n",
7171
"if useAzureOpenAI:\n",
7272
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
73-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
73+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
7474
" # next line assumes embeddings deployment name is \"text-embedding-ada-002\", adjust this if appropriate \n",
7575
" kernel.add_text_embedding_generation_service(\"ada\", AzureTextEmbedding(\"text-embedding-ada-002\", endpoint, api_key))\n",
7676
"else:\n",
7777
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
78-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))\n",
78+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))\n",
7979
" kernel.add_text_embedding_generation_service(\"ada\", OpenAITextEmbedding(\"text-embedding-ada-002\", api_key, org_id))\n",
8080
"\n",
8181
"kernel.register_memory_store(memory_store=sk.memory.VolatileMemoryStore())\n",

‎python/notebooks/08-native-function-inline.ipynb

+6-6
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
"import os\n",
6060
"import sys\n",
6161
"import semantic_kernel as sk\n",
62-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion\n",
62+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion\n",
6363
"\n",
6464
"kernel = sk.Kernel()\n",
6565
"\n",
@@ -69,10 +69,10 @@
6969
"# Configure AI service used by the kernel\n",
7070
"if useAzureOpenAI:\n",
7171
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
72-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
72+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
7373
"else:\n",
7474
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
75-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
75+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))"
7676
]
7777
},
7878
{
@@ -225,7 +225,7 @@
225225
"import os\n",
226226
"import sys\n",
227227
"import semantic_kernel as sk\n",
228-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion\n",
228+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion\n",
229229
"\n",
230230
"kernel = sk.Kernel()\n",
231231
"\n",
@@ -235,10 +235,10 @@
235235
"# Configure AI service used by the kernel\n",
236236
"if useAzureOpenAI:\n",
237237
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
238-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
238+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
239239
"else:\n",
240240
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
241-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
241+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))\n"
242242
]
243243
},
244244
{

‎python/notebooks/09-groundedness-checking.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
"outputs": [],
8484
"source": [
8585
"import semantic_kernel as sk\n",
86-
"from semantic_kernel.connectors.ai.open_ai import AzureTextCompletion, OpenAITextCompletion\n",
86+
"from semantic_kernel.connectors.ai.open_ai import AzureChatCompletion, OpenAIChatCompletion\n",
8787
"\n",
8888
"kernel = sk.Kernel()\n",
8989
"\n",
@@ -92,10 +92,10 @@
9292
"# Configure AI service used by the kernel\n",
9393
"if useAzureOpenAI:\n",
9494
" deployment, api_key, endpoint = sk.azure_openai_settings_from_dot_env()\n",
95-
" kernel.add_text_completion_service(\"dv\", AzureTextCompletion(deployment, endpoint, api_key))\n",
95+
" kernel.add_chat_service(\"chat_completion\", AzureChatCompletion(\"gpt-35-turbo\", endpoint, api_key))\n",
9696
"else:\n",
9797
" api_key, org_id = sk.openai_settings_from_dot_env()\n",
98-
" kernel.add_text_completion_service(\"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id))"
98+
" kernel.add_chat_service(\"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id))"
9999
]
100100
},
101101
{

‎python/notebooks/third_party/weaviate-persistent-memory.ipynb

+3-3
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@
190190
"\n",
191191
"import semantic_kernel as sk\n",
192192
"from semantic_kernel.connectors.ai.open_ai import (\n",
193-
" OpenAITextCompletion,\n",
193+
" OpenAIChatCompletion,\n",
194194
" OpenAITextEmbedding,\n",
195195
")\n",
196196
"\n",
@@ -264,8 +264,8 @@
264264
"kernel = sk.Kernel()\n",
265265
"\n",
266266
"api_key, org_id = sk.openai_settings_from_dot_env()\n",
267-
"kernel.add_text_completion_service(\n",
268-
" \"dv\", OpenAITextCompletion(\"text-davinci-003\", api_key, org_id)\n",
267+
"kernel.add_chat_service(\n",
268+
" \"chat-gpt\", OpenAIChatCompletion(\"gpt-3.5-turbo\", api_key, org_id)\n",
269269
")\n",
270270
"kernel.add_text_embedding_generation_service(\n",
271271
" \"ada\", OpenAITextEmbedding(\"text-embedding-ada-002\", api_key, org_id)\n",

‎python/samples/kernel-syntax-examples/bing_search_skill.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
from dotenv import load_dotenv
44

55
import semantic_kernel as sk
6-
from semantic_kernel.connectors.ai.open_ai import OpenAITextCompletion
6+
from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion
77
from semantic_kernel.connectors.search_engine import BingConnector
88
from semantic_kernel.core_skills import WebSearchEngineSkill
99

@@ -13,8 +13,8 @@
1313
async def main():
1414
kernel = sk.Kernel()
1515
api_key, org_id = sk.openai_settings_from_dot_env()
16-
kernel.add_text_completion_service(
17-
"dv", OpenAITextCompletion("text-davinci-003", api_key, org_id)
16+
kernel.add_chat_service(
17+
"chat-gpt", OpenAIChatCompletion("gpt-3.5-turbo", api_key, org_id)
1818
)
1919
connector = BingConnector(api_key=os.getenv("BING_API_KEY"))
2020
web_skill = kernel.import_skill(WebSearchEngineSkill(connector), "WebSearch")

‎python/samples/kernel-syntax-examples/chat.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
kernel = sk.Kernel()
1919

2020
api_key, org_id = sk.openai_settings_from_dot_env()
21-
kernel.add_text_completion_service(
22-
"davinci-003", sk_oai.OpenAITextCompletion("text-davinci-003", api_key, org_id)
21+
kernel.add_chat_service(
22+
"chat-gpt", sk_oai.OpenAIChatCompletion("gpt-3.5-turbo", api_key, org_id)
2323
)
2424

2525
prompt_config = sk.PromptTemplateConfig.from_completion_parameters(

‎python/samples/kernel-syntax-examples/google_search_skill.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from dotenv import load_dotenv
66

77
import semantic_kernel as sk
8-
from semantic_kernel.connectors.ai.open_ai import OpenAITextCompletion
8+
from semantic_kernel.connectors.ai.open_ai import OpenAIChatCompletion
99
from semantic_kernel.connectors.search_engine import GoogleConnector
1010
from semantic_kernel.core_skills import WebSearchEngineSkill
1111

@@ -15,8 +15,8 @@
1515
async def main():
1616
kernel = sk.Kernel()
1717
api_key, org_id = sk.openai_settings_from_dot_env()
18-
kernel.add_text_completion_service(
19-
"dv", OpenAITextCompletion("text-davinci-003", api_key, org_id)
18+
kernel.add_chat_service(
19+
"chat-gpt", OpenAIChatCompletion("gpt-3.5-turbo", api_key, org_id)
2020
)
2121

2222
"""

‎python/samples/kernel-syntax-examples/memory.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ async def main() -> None:
108108
kernel = sk.Kernel()
109109

110110
api_key, org_id = sk.openai_settings_from_dot_env()
111-
kernel.add_text_completion_service(
112-
"dv", sk_oai.OpenAITextCompletion("text-davinci-003", api_key, org_id)
111+
kernel.add_chat_service(
112+
"chat-gpt", sk_oai.OpenAIChatCompletion("gpt-3.5-turbo", api_key, org_id)
113113
)
114114
kernel.add_text_embedding_generation_service(
115115
"ada", sk_oai.OpenAITextEmbedding("text-embedding-ada-002", api_key, org_id)

0 commit comments

Comments
 (0)