Skip to content

Conversation

aaronwilkowitz-openai
Copy link
Contributor

Summary

Updated Max's Sharepoint article into 3 - 2 GPT Actions on solution 1 & solution 2, then an article on using Azure middleware.

Motivation

Why are these changes necessary? How do they improve the cookbook?

Max's article is great but doesn't follow our new GPT Actions Library format, so we wanted to update it to make it follow the right process.


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • X[ ] I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • [X ] I have conducted a self-review of my content based on the contribution guidelines:
    • [X ] Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • [X ] Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • [X ] Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • [ X] Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • [ X] Correctness: The information I include is correct and all of my code executes successfully.
    • [X ] Completeness: I have explained everything fully, including all necessary references and citations.

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.

Copy link
Contributor

@maxreid-openai maxreid-openai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a few comments. updated arch diagram below

solution-1-architecture-gpt4o-mini

" // This is where we are doing the search\n",
" const list = await client.api('/search/query').post(requestBody);\n",
" const processList = async () => {\n",
" // This will go through and for each search response, grab the contents of the file and summarize with gpt-3.5-turbo\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should probably change this to 4o-mini

"\n",
"### Considerations\n",
"\n",
"Note that all the same limitations of Actions apply here, with regards to returning 100K characters or less and the [45 second timeout](https://platform.openai.com/docs/actions/production/timeouts).\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this might be slightly confusing for the doc return part...since we are returning the doc and not plaintext charagers

"cell_type": "markdown",
"metadata": {},
"source": [
"This page provides an instruction & guide for developers building a GPT Action for a specific application. Before you proceed, make sure to first familiarize yourself with the following information: \n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably worth adding here (and in the other one) a link out to the middleware notebook. I know it's referenced later too

"\n",
"2. For each file that is found, convert it to a consistent readable format and retrieve all the text.\n",
"\n",
"3. Use GPT 3.5-turbo (gpt-3.5-turbo-0125) to extract the relevant text from the files based on the initial user’s question. Note the pricing of GPT 3.5 turbo [here](https://openai.com/pricing#language-models) - since we are dealing with small token chunks, the cost of this step is nominal.  \n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.5 turbo --> 4o

" 1. Basics\n",
"\n",
" 1. _Do you want to deploy code or container image?:_  **Code**\n",
"\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably worth calling out here that you can change these to others, but these settings will be compatible with the sharepoint cookbooks

"cell_type": "markdown",
"metadata": {},
"source": [
"This particular GPT Action provides an overview of how to build an **Azure Function**, MSFT's cloud-based function builder. This documentation helps a user set up Azure Functions to connect to a GPT Action - and to a sample application. "
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe a comment on why this is useful? Like how you can use this to connect to different systems you have, and pre-process (eg summarizing text before returning to chatgpt, or converting to the proper file format)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and some mention about how this example uses OAuth

"cell_type": "markdown",
"metadata": {},
"source": [
"*This is application specific.*"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe another reference to the sharepoint instructions, linking to the specific header, as an example?

@aaronwilkowitz-openai aaronwilkowitz-openai merged commit 8a288eb into main Jul 22, 2024
@aaronwilkowitz-openai aaronwilkowitz-openai deleted the aaronwilkowitz/sharepoint branch July 22, 2024 19:23
nelsonauner pushed a commit to nelsonauner/openai-cookbook that referenced this pull request Aug 14, 2024
Co-authored-by: maxreid-openai <max.reid@openai.com>
joshagilend pushed a commit to joshagilend/openai-cookbook that referenced this pull request Oct 23, 2024
Co-authored-by: maxreid-openai <max.reid@openai.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants