Skip to content

Add diagram to readme#8

Closed
craigomatic wants to merge 0 commit intomicrosoft:mainfrom
craigomatic:update-af-readme
Closed

Add diagram to readme#8
craigomatic wants to merge 0 commit intomicrosoft:mainfrom
craigomatic:update-af-readme

Conversation

@craigomatic
Copy link
Copy Markdown
Contributor

Motivation and Context

To make it easier for a developer to understand how the Azure Function integrates the Semantic Kernel.

Description

This PR adds a single image to the readme for the Azure Function that shows the basic flow of data from the caller via HTTP POST, to the Azure Function/Semantic Kernel, which in turn makes a HTTP POST request to Azure Open AI/Open AI

Contribution Checklist

@craigomatic craigomatic added the PR: ready for review All feedback addressed, ready for reviews label Mar 1, 2023
Copy link
Copy Markdown
Contributor

@dluc dluc left a comment

Choose a reason for hiding this comment

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

  • the numbers in yellow are extremely hard to read
  • we should rename "inputs" to "variables" to be consistent with SK terminology
  • I would remove the OpenAI logo, use an image that is good both for OpenAI and Azure OpenAI

@dluc dluc added PR: feedback to address Waiting for PR owner to address comments/questions and removed PR: ready for review All feedback addressed, ready for reviews labels Mar 1, 2023
shawncal
shawncal previously approved these changes Mar 1, 2023
@shawncal shawncal self-requested a review March 1, 2023 18:42
@shawncal shawncal dismissed their stale review March 1, 2023 18:43

Clearning to address dluc's feedback

@craigomatic
Copy link
Copy Markdown
Contributor Author

  • the numbers in yellow are extremely hard to read

Ruokan is helping to fix

  • we should rename "inputs" to "variables" to be consistent with SK terminology

The samples use a slightly different model, if we rename here we would also want to rename the models used by both the client and azure function samples.

  • I would remove the OpenAI logo, use an image that is good both for OpenAI and Azure OpenAI

There doesn't really seem to be a specific logo that Azure OpenAI uses to differentiate from OpenAI, seems to be the same logo in both places:
https://azure.microsoft.com/en-us/products/cognitive-services/openai-service/
image

https://openai.com/
image

Any suggestions on a more generic logo?

@alexchaomander
Copy link
Copy Markdown
Contributor

  • the numbers in yellow are extremely hard to read

Ruokan is helping to fix

  • we should rename "inputs" to "variables" to be consistent with SK terminology

The samples use a slightly different model, if we rename here we would also want to rename the models used by both the client and azure function samples.

  • I would remove the OpenAI logo, use an image that is good both for OpenAI and Azure OpenAI

There doesn't really seem to be a specific logo that Azure OpenAI uses to differentiate from OpenAI, seems to be the same logo in both places: https://azure.microsoft.com/en-us/products/cognitive-services/openai-service/ image

https://openai.com/ image

Any suggestions on a more generic logo?

Maybe just put them side by side? Eventually we may update the image with other model providers like Cohere, Anthropic etc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

PR: feedback to address Waiting for PR owner to address comments/questions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants