Skip to content

Commit e727921

Browse files
authored
[Doc] Update upgrade faq (#1313)
# Description Please add an informative description that covers that changes made by the pull request and link all relevant issues. # 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. --------- Signed-off-by: Brynn Yin <[email protected]>
1 parent abf0ad8 commit e727921

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

docs/how-to-guides/faq.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ Prompt flow provides both stable and experimental features in the same SDK.
1111
Stable features | **Production ready** <br/><br/> These features are recommended for most use cases and production environments. They are updated less frequently then experimental features.|
1212
Experimental features | **Developmental** <br/><br/> These features are newly developed capabilities & updates that may not be ready or fully tested for production usage. While the features are typically functional, they can include some breaking changes. Experimental features are used to iron out SDK breaking bugs, and will only receive updates for the duration of the testing period. Experimental features are also referred to as features that are in **preview**. <br/> As the name indicates, the experimental (preview) features are for experimenting and is **not considered bug free or stable**. For this reason, we only recommend experimental features to advanced users who wish to try out early versions of capabilities and updates, and intend to participate in the reporting of bugs and glitches.
1313

14+
15+
### OpenAI 1.x support
16+
Please use the following command to upgrade promptflow for openai 1.x support:
17+
```
18+
pip install promptflow>=1.1.0
19+
pip install promptflow-tools>=1.0.0
20+
```
21+
Note that the command above will upgrade your openai package a version later than 1.0.0,
22+
which may introduce breaking changes to custom tool code.
23+
24+
Reach [OpenAI migration guide](https://github.com/openai/openai-python/discussions/742) for more details.
25+
1426
## Troubleshooting ##
1527

1628
### Connection creation failed with StoreConnectionEncryptionKeyError
@@ -20,7 +32,7 @@ Connection creation failed with StoreConnectionEncryptionKeyError: System keyrin
2032
```
2133

2234
This error raised due to keyring can't find an available backend to store keys.
23-
For example [macOs Keychain](https://en.wikipedia.org/wiki/Keychain_%28software%29) and [Windows Credential Locker](https://learn.microsoft.com/en-us/windows/uwp/security/credential-locker)
35+
For example [macOS Keychain](https://en.wikipedia.org/wiki/Keychain_%28software%29) and [Windows Credential Locker](https://learn.microsoft.com/en-us/windows/uwp/security/credential-locker)
2436
are valid keyring backends.
2537

2638
To resolve this issue, install the third-party keyring backend or write your own keyring backend, for example:

scripts/docs/_static/custom.css

+12
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,18 @@
2020
max-width: 70em;
2121
}
2222

23+
html[data-theme="light"] {
24+
--header-announcement-color: #fff070;
25+
}
26+
27+
html[data-theme="dark"] {
28+
--header-announcement-color: #4d4d00;
29+
}
30+
31+
.bd-header-announcement {
32+
background: var(--header-announcement-color);
33+
}
34+
2335
/* (A) LIGHTBOX BACKGROUND */
2436
#lightbox {
2537
/* (A1) COVERS FULLSCREEN */

scripts/docs/conf.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,10 @@
9393
"show_toc_level": 1,
9494
"navbar_align": "left", # [left, content, right] For testing that the navbar items align properly
9595
"navbar_center": ["navbar-nav"],
96-
# "announcement": "Test our announcement here.",
96+
"announcement":
97+
"Prompt flow supports OpenAI 1.x since v1.1.0. This may introduce breaking change. Reach "
98+
"<a href='https://microsoft.github.io/promptflow/how-to-guides/faq.html#openai-1-x-support'>here</a> "
99+
"for guide to upgrade.",
97100
"show_nav_level": 1,
98101
}
99102

0 commit comments

Comments
 (0)