-
Notifications
You must be signed in to change notification settings - Fork 11.5k
initial commit for Azure RAG cookbook #1272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a comments primarily to the notebook.
Overall, it looks very in-depth, but it's also a bit overwhelming. Some high level recommendations:
- Try to add some type of map or guidance at the beginning that gives some overview for all of the content that'll be reviewed.
- There's a few cases where code blocks are broken up by single lines of text; we should try to consolidate these so it doesn't feel as choppy
- The very end doesn't feel finished; could you add a summary section and review what was demonstrated?
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding the sections!
Added a few more comments. Another high-level - there's a lot of repetitive phrases throughout the cookbook - "In this code block" "In this section" "the below section" "Feel free to".
Consider removing these references since they reduce clarity and conciseness, and tend to be more passive.
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
...t/rag-quickstart/azure/Azure_AI_Search_with_Azure_Functions_and_GPT_Actions_in_ChatGPT.ipynb
Outdated
Show resolved
Hide resolved
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. There's still points where more polish can be added, if you have the time to improve them, but this should be good to put up now.
Feedback areas:
- Code blocks are difficult to read due to the comments - consolidating these comments into block comments or adding more intentional spacing.
Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Summary
Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.
Motivation
Why are these changes necessary? How do they improve the cookbook?
For new content
When contributing new content, read through our contribution guidelines, and mark the following action items as completed:
We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.