Skip to content

Commit 5585d8d

Browse files
wangchao1230wangchao1230
authored
Doc update: Open AI -> OpenAI (#3509)
# Description Make follow up change with this: #3351 # All Promptflow Contribution checklist: - [ ] **The pull request does not introduce [breaking changes].** - [ ] **CHANGELOG is updated for new features, bug fixes or other significant changes.** - [ ] **I have read the [contribution guidelines](../CONTRIBUTING.md).** - [ ] **Create an issue and link to the pull request to get dedicated review from promptflow team. Learn more: [suggested workflow](../CONTRIBUTING.md#suggested-workflow).** ## General Guidelines and Best Practices - [ ] Title of the pull request is clear and informative. - [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md). ### Testing Guidelines - [ ] Pull request includes test coverage for the included changes.
1 parent f258d2c commit 5585d8d

File tree

106 files changed

+393
-393
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+393
-393
lines changed

‎benchmark/promptflow-serve/pf_flows/static_async/node1.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
async def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call async
8+
# sleep for 250ms to simulate OpenAI call async
99
await asyncio.sleep(0.25)
1010
return "completed"

‎benchmark/promptflow-serve/pf_flows/static_async/node2.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
async def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call async
8+
# sleep for 250ms to simulate OpenAI call async
99
await asyncio.sleep(0.25)
1010
return "completed"

‎benchmark/promptflow-serve/pf_flows/static_async/node3.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
async def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call async
8+
# sleep for 250ms to simulate OpenAI call async
99
await asyncio.sleep(0.25)
1010
return "completed"

‎benchmark/promptflow-serve/pf_flows/static_sync/node1.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call
8+
# sleep for 250ms to simulate OpenAI call
99
time.sleep(0.25)
1010
return "completed"

‎benchmark/promptflow-serve/pf_flows/static_sync/node2.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call
8+
# sleep for 250ms to simulate OpenAI call
99
time.sleep(0.25)
1010
return "completed"

‎benchmark/promptflow-serve/pf_flows/static_sync/node3.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
@tool
66
def my_python_tool(chat_history: list, question: str) -> str:
77

8-
# sleep for 250ms to simulate open ai call
8+
# sleep for 250ms to simulate OpenAI call
99
time.sleep(0.25)
1010
return "completed"

‎docs/concepts/concept-connections.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Connections are for storing information about how to access external services li
77
- In your local development environment, the connections are persisted in your local machine with keys encrypted.
88
- In Azure AI, connections can be configured to be shared across the entire workspace. Secrets associated with connections are securely persisted in the corresponding Azure Key Vault, adhering to robust security and compliance standards.
99

10-
Prompt flow provides a variety of pre-built connections, including Azure Open AI, Open AI, etc. These pre-built connections enable seamless integration with these resources within the built-in tools. Additionally, you have the flexibility to create custom connection types using key-value pairs, empowering them to tailor the connections to their specific requirements, particularly in Python tools.
10+
Prompt flow provides a variety of pre-built connections, including Azure OpenAI, OpenAI, etc. These pre-built connections enable seamless integration with these resources within the built-in tools. Additionally, you have the flexibility to create custom connection types using key-value pairs, empowering them to tailor the connections to their specific requirements, particularly in Python tools.
1111

1212
| Connection type | Built-in tools |
1313
| ------------------------------------------------------------ | ------------------------------- |
14-
| [Azure Open AI](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service) | LLM or Python |
15-
| [Open AI](https://openai.com/) | LLM or Python |
14+
| [Azure OpenAI](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service) | LLM or Python |
15+
| [OpenAI](https://openai.com/) | LLM or Python |
1616
| [Cognitive Search](https://azure.microsoft.com/en-us/products/search) | Vector DB Lookup or Python |
1717
| [Serp](https://serpapi.com/) | Serp API or Python |
1818
| [Serverless](https://learn.microsoft.com/en-us/azure/ai-studio/concepts/deployments-overview#deploy-models-with-model-as-a-service-maas) | LLM or Python |

‎docs/how-to-guides/develop-a-dag-flow/quick-start.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ We need to set up the connection if we haven't added it before. Once created, th
130130

131131
Firstly we need a connection yaml file `connection.yaml`:
132132

133-
If you are using Azure Open AI, prepare your resource follow with this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
133+
If you are using Azure OpenAI, prepare your resource follow with this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
134134
```yaml
135135
$schema: https://azuremlschemas.azureedge.net/promptflow/latest/AzureOpenAIConnection.schema.json
136136
name: open_ai_connection

‎docs/how-to-guides/manage-connections.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ On the VS Code primary sidebar > prompt flow pane. You can find the connections
108108
:sync: CLI
109109
The commands below show how to update existing connections with new values:
110110
```bash
111-
# Update an azure open ai connection with a new api base
111+
# Update an azure OpenAI connection with a new api base
112112
pf connection update -n my_azure_open_ai_connection --set api_base='new_value'
113113
# Update a custom connection
114114
pf connection update -n my_custom_connection --set configs.other_config='new_value'
@@ -120,7 +120,7 @@ pf connection update -n my_custom_connection --set configs.other_config='new_val
120120
:sync: SDK
121121
The code snippet below shows how to update existing connections with new values:
122122
```python
123-
# Update an azure open ai connection with a new api base
123+
# Update an azure OpenAI connection with a new api base
124124
connection = pf.connections.get(name="my_azure_open_ai_connection")
125125
connection.api_base = "new_value"
126126
connection.api_key = "<original-key>" # secrets are required when updating connection using sdk

‎examples/connections/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ pf connection show --name custom_connection
3434
- To update a connection that in workspace, execute following command. Currently only a few fields(description, display_name) support update:
3535
```bash
3636
# Update an existing connection with --set to override values
37-
# Update an azure open ai connection with a new api base
37+
# Update an azure OpenAI connection with a new api base
3838
pf connection update -n open_ai_connection --set api_base='<your_api_base>'
3939
# Update a custom connection
4040
pf connection update -n custom_connection --set configs.key1='<your_new_key>' secrets.key2='<your_another_key>'

‎examples/connections/connection.ipynb

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
"source": [
88
"# Connection Management\n",
99
"\n",
10-
"Prompt flow provides various prebuilt connections, including Azure Open AI, Open AI, Azure Content Safety, etc. Prebuilt connections enable seamless integration with these resources within the built-in tools. \n",
10+
"Prompt flow provides various prebuilt connections, including Azure OpenAI, OpenAI, Azure Content Safety, etc. Prebuilt connections enable seamless integration with these resources within the built-in tools. \n",
1111
"\n",
1212
"Additionally, users have the flexibility to create custom connection types using key-value pairs, empowering them to tailor the connections to their specific requirements, particularly in Python tools.\n",
1313
"\n",
1414
"Reach more details about connection types [here](https://learn.microsoft.com/en-us/azure/machine-learning/prompt-flow/concept-connections?view=azureml-api-2).\n",
1515
"## Create different type of connections\n",
16-
"We will use Azure Open AI connection and custom connection as example to show how to create connection with promptflow sdk."
16+
"We will use Azure OpenAI connection and custom connection as example to show how to create connection with promptflow sdk."
1717
]
1818
},
1919
{
@@ -57,9 +57,9 @@
5757
"cell_type": "markdown",
5858
"metadata": {},
5959
"source": [
60-
"### Create an Azure Open AI connection\n",
60+
"### Create an Azure OpenAI connection\n",
6161
"\n",
62-
"Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
62+
"Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
6363
]
6464
},
6565
{
@@ -160,7 +160,7 @@
160160
"metadata": {},
161161
"source": [
162162
"## Update a connection\n",
163-
"### Update an Azure Open AI connection"
163+
"### Update an Azure OpenAI connection"
164164
]
165165
},
166166
{

‎examples/flex-flows/basic/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ pip install -r requirements.txt
1010

1111
## Run flow
1212

13-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
13+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1414

1515
- Setup environment variables
1616

17-
Ensure you have put your azure open ai endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
17+
Ensure you have put your azure OpenAI endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
1818

1919
```bash
2020
cat ../.env

‎examples/flex-flows/chat-async-stream/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See <a href="https://platform.openai.com/docs/api-reference/chat/create#chat/cre
3131
3232
## Run flow
3333
34-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
34+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
3535
3636
- Setup connection
3737

‎examples/flex-flows/chat-async-stream/chat-stream-with-async-flex-flow.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
"\n",
8181
"Above prompty uses connection `open_ai_connection` inside, we need to set up the connection if we haven't added it before. After created, it's stored in local db and can be used in any flow.\n",
8282
"\n",
83-
"Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
83+
"Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
8484
]
8585
},
8686
{
@@ -99,7 +99,7 @@
9999
" conn = pf.connections.get(name=conn_name)\n",
100100
" print(\"using existing connection\")\n",
101101
"except:\n",
102-
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure Open AI resource.\n",
102+
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure OpenAI resource.\n",
103103
" connection = AzureOpenAIConnection(\n",
104104
" name=conn_name,\n",
105105
" api_key=\"<your_AOAI_key>\",\n",

‎examples/flex-flows/chat-basic/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See <a href="https://platform.openai.com/docs/api-reference/chat/create#chat/cre
3131
3232
## Run flow
3333
34-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
34+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
3535
3636
- Setup connection
3737

‎examples/flex-flows/chat-basic/chat-with-class-based-flow.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"\n",
6161
"Above prompty uses connection `open_ai_connection` inside, we need to set up the connection if we haven't added it before. After created, it's stored in local db and can be used in any flow.\n",
6262
"\n",
63-
"Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
63+
"Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
6464
]
6565
},
6666
{
@@ -79,7 +79,7 @@
7979
" conn = pf.connections.get(name=conn_name)\n",
8080
" print(\"using existing connection\")\n",
8181
"except:\n",
82-
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure Open AI resource.\n",
82+
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure OpenAI resource.\n",
8383
" connection = AzureOpenAIConnection(\n",
8484
" name=conn_name,\n",
8585
" api_key=\"<your_AOAI_key>\",\n",

‎examples/flex-flows/chat-minimal/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ See <a href="https://platform.openai.com/docs/api-reference/chat/create#chat/cre
2424

2525
## Run flow
2626

27-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
27+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
2828

2929
- Setup environment variables
3030

31-
Ensure you have put your azure open ai endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
31+
Ensure you have put your azure OpenAI endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
3232

3333
```bash
3434
cat ../.env

‎examples/flex-flows/chat-stream/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See <a href="https://platform.openai.com/docs/api-reference/chat/create#chat/cre
3131
3232
## Run flow
3333
34-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
34+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
3535
3636
- Setup connection
3737

‎examples/flex-flows/chat-stream/chat-stream-with-flex-flow.ipynb

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
"\n",
8181
"Above prompty uses connection `open_ai_connection` inside, we need to set up the connection if we haven't added it before. After created, it's stored in local db and can be used in any flow.\n",
8282
"\n",
83-
"Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
83+
"Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one."
8484
]
8585
},
8686
{
@@ -99,7 +99,7 @@
9999
" conn = pf.connections.get(name=conn_name)\n",
100100
" print(\"using existing connection\")\n",
101101
"except:\n",
102-
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure Open AI resource.\n",
102+
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure OpenAI resource.\n",
103103
" connection = AzureOpenAIConnection(\n",
104104
" name=conn_name,\n",
105105
" api_key=\"<your_AOAI_key>\",\n",

‎examples/flex-flows/chat-with-functions/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,11 @@ pip install -r requirements.txt
2222
## Getting started
2323

2424
### 1 prepare api_key env
25-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
25+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
2626

2727
- Setup environment variables
2828

29-
Ensure you have put your azure open ai endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
29+
Ensure you have put your azure OpenAI endpoint key in [.env](../.env) file. You can create one refer to this [example file](../.env.example).
3030

3131
### 2 understand how chat model choose function
3232
```shell

‎examples/flex-flows/eval-checklist/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pip install -r requirements.txt
1010

1111
## Run flow
1212

13-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
13+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1414

1515
- Setup connection
1616

‎examples/flex-flows/eval-code-quality/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pip install -r requirements.txt
1010

1111
## Run flow
1212

13-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
13+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1414

1515
- Setup connection
1616

‎examples/flex-flows/eval-criteria-with-langchain/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip install -r requirements.txt
1212

1313
## Run flow
1414

15-
- Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
15+
- Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1616
- Or prepare your Anthropic resource follow this [instruction](https://python.langchain.com/docs/integrations/platforms/anthropic/) and get your `api_key` if you don't have one.
1717

1818
- Setup connection

‎examples/flows/chat/chat-with-pdf/chat-with-pdf.ipynb

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
" conn = pf.connections.get(name=conn_name)\n",
7373
" print(\"using existing connection\")\n",
7474
"except:\n",
75-
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure Open AI resource.\n",
75+
" # Follow https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal to create an Azure OpenAI resource.\n",
7676
" connection = AzureOpenAIConnection(\n",
7777
" name=conn_name,\n",
7878
" api_key=\"<user-input>\",\n",

‎examples/flows/evaluation/eval-classification-accuracy/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In this flow, you will learn
1414

1515
### 0. Setup connection
1616

17-
Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
17+
Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1818

1919
```bash
2020
# Override keys with --set to avoid yaml file changes

‎examples/flows/evaluation/eval-groundedness/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Tools used in this flow：
88

99
### 0. Setup connection
1010

11-
Prepare your Azure Open AI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
11+
Prepare your Azure OpenAI resource follow this [instruction](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/how-to/create-resource?pivots=web-portal) and get your `api_key` if you don't have one.
1212

1313
```bash
1414
# Override keys with --set to avoid yaml file changes

0 commit comments

Comments
 (0)