MicrosoftDocs / semantic-kernel-docs

Semantic Kernel (SK) is a lightweight SDK enabling integration of AI Large Language Models (LLMs) with conventional programming languages.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Inconsistent use of $INPUT

Cotspheer opened this issue · comments

Documentations like chaining-functions do use "$input". The your-first-prompt uses $INPUT and every other parameter is in uppercase too. The ContextVariables.MainKey is defined as "INPUT" and the Plugins.Core.SemanticFunctionConstants.cs uses the variable in its template like this: {{$INPUT}}. But all other samples I found are using lowercase. This is quite confusing for newcomers as the first thing I assumed was: "Alright UPPERCASE means global available variable and will be chained to the next one and lowercase means local variable".

Any chance to fix that in a housekeeping session? Additionally an idea would be to include a reference to prompt-template-syntax in your-first-prompt as I went through the page but did not recognise it in the navigation. I think a short paragraph mentioning that and maybe a reference in the bottom section would be good enough.

Another finding:
https://learn.microsoft.com/en-us/semantic-kernel/ai-orchestration/plugins/chaining-functions?tabs=Csharp#passing-a-context-object-to-runasync where snake_case is used.

Maybe it would be good to mention the preferred style in prompt-template-syntax. Is it camelCase, PascalCase, UPPERCASE, snake_case or kebab-case?

Syntax changed with handlebars templates, closing therefore my issue.