mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
Shawn Callegariandname
f8a8d884ff
"KernelSyntaxExamples" is the only outstanding project under /samples that still uses project references to access the kernel libraries. This change consolidates all the building, linked dotnet SDK code in SK-dotnet.sln into a single top-level folder. This will simplify build jobs, automatic code owner assignment, and other dev ops tasks. Coming next: other projects in samples will get removed from the dotnet/SK-dotnet.sln solution, and a new solution with dedicated builds created for the /samples folder. TBD: - Language-specific code "samples" will move into a similar subfolder for each language. - The current "/samples" folder (at the root) will likely become something like "apps", with the demo apps promoted to the top-level folder for better discoverability. - notebooks may also move to this folder in the future. Co-authored-by: name <email>
Semantic Kernel syntax examples
This project contains a collection of semi-random examples about various scenarios using SK components.
The examples are ordered by number, starting with very basic examples.
Most of the examples will require secrets and credentials, to access OpenAI, Azure OpenAI, Bing and other resources. We suggest using .NET Secret Manager to avoid the risk of leaking secrets into the repository, branches and pull requests. You can also use environment variables if you prefer.
To set your secrets with Secret Manager:
cd dotnet/samples/KernelSyntaxExamples
dotnet user-secrets set "BING_API_KEY" "..."
dotnet user-secrets set "OPENAI_API_KEY" "..."
dotnet user-secrets set "AZURE_OPENAI_SERVICE_ID" "..."
dotnet user-secrets set "AZURE_OPENAI_DEPLOYMENT_NAME" "..."
dotnet user-secrets set "AZURE_OPENAI_CHAT_DEPLOYMENT_NAME" "..."
dotnet user-secrets set "AZURE_OPENAI_ENDPOINT" "https://... .openai.azure.com/"
dotnet user-secrets set "AZURE_OPENAI_KEY" "..."
dotnet user-secrets set "AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME" "..."
dotnet user-secrets set "AZURE_OPENAI_EMBEDDINGS_ENDPOINT" "https://... .openai.azure.com/"
dotnet user-secrets set "AZURE_OPENAI_EMBEDDINGS_KEY" "..."
dotnet user-secrets set "ACS_ENDPOINT" "https://... .search.windows.net"
dotnet user-secrets set "ACS_API_KEY" "..."
dotnet user-secrets set "QDRANT_ENDPOINT" "..."
dotnet user-secrets set "QDRANT_PORT" "..."
dotnet user-secrets set "WEAVIATE_SCHEME" "..."
dotnet user-secrets set "WEAVIATE_ENDPOINT" "..."
dotnet user-secrets set "WEAVIATE_PORT" "..."
dotnet user-secrets set "WEAVIATE_APIKEY" "..."
dotnet user-secrets set "GITHUB_PERSONAL_ACCESS_TOKEN" "github_pat_..."
dotnet user-secrets set "POSTGRES_CONNECTIONSTRING" "..."
dotnet user-secrets set "REDIS_CONFIGURATION" "..."
To set your secrets with environment variables, use these names:
- BING_API_KEY
- OPENAI_API_KEY
- AZURE_OPENAI_SERVICE_ID
- AZURE_OPENAI_DEPLOYMENT_NAME
- AZURE_OPENAI_ENDPOINT
- AZURE_OPENAI_KEY
- ACS_ENDPOINT
- ACS_API_KEY
- QDRANT_ENDPOINT
- QDRANT_PORT
- WEAVIATE_SCHEME
- WEAVIATE_ENDPOINT
- WEAVIATE_PORT
- WEAVIATE_APIKEY
- GITHUB_PERSONAL_ACCESS_TOKEN
- POSTGRES_CONNECTIONSTRING
- REDIS_CONFIGURATION
- AZURE_OPENAI_EMBEDDINGS_DEPLOYMENT_NAME
- AZURE_OPENAI_EMBEDDINGS_ENDPOINT
- AZURE_OPENAI_EMBEDDINGS_KEY