Skip to content

Ongoing Readme refinement #139

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.

Sign up for GitHub

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

Merged
umeshma merged 3 commits into from
Sep 20, 2023
Merged

Ongoing Readme refinement #139

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab19be8
Ongoing Readme refinement
umeshma Sep 20, 2023
7eb18c5
Ongoing Readme refinements
umeshma Sep 20, 2023
b7a6b64
Typo found by Spellchecker job
umeshma Sep 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ program.Run(api);
```

## Microsoft.TypeChat.SemanticKernel ##
TypeChat.SemanticKernel provides bindings for language models, plugins and embeddings to Typechat.NET and TypeChat.NET examples.
TypeChat.SemanticKernel provides default bindings for language models, plugins and embeddings to Typechat.NET and TypeChat.NET examples.

TypeChat.SemanticKernel include classes for:
* **Json Programs for Plugins**: turn registered plugins into **APIs** that Json programs can target See the [Plugins Example](examples/Plugins/Program.cs).
* **Json Programs for Plugins**: turn registered plugins into **APIs** that Json programs can target. See the [Plugins Example](examples/Plugins/Program.cs).
* Language model and embeddings access: all TypeChat examples use the Semantic Kernel to call models and generate embeddings.

## Microsoft.TypeChat.Dialog
Expand Down Expand Up @@ -118,7 +118,7 @@ while (true)

## Examples

To see TypeChat in action, explore the [TypeChat example projects](./examples). The list below describes which examples will best introduc which concept. Some examples or scenarios may work best with gpt-4.
To see TypeChat in action, explore the [TypeChat example projects](./examples). The list below describes which examples will best introduce which concept. Some examples or scenarios may work best with gpt-4.

* Hello World: The [Sentiment](./examples/Sentiment/Program.cs) example is TypeChat's Hello World and a minimal introduction to JsonTranslator.

Expand Down Expand Up @@ -173,8 +173,8 @@ A typical appSettings.Development.json will look like this:
}
```

## OpenAIConfig
TypeChat accesses language models using the [LanguageModel](./src/typechat.sk/LanguageModel.cs) class. The OpenAIConfig class is configuration for LanguageModel. You initialize OpenAIConfig from your application's configuration, from a Json file or from environment variables.
### OpenAIConfig
TypeChat examples accesses language models using the [LanguageModel](./src/typechat.sk/LanguageModel.cs) class. The OpenAIConfig class supplies configuration for LanguageModel. You initialize OpenAIConfig from your application's configuration, from a Json file or from environment variables.

See [OpenAIConfig.cs](./src/typechat.sk/OpenAIConfig.cs) for a list of :
* Configurable properties
Expand All @@ -197,6 +197,11 @@ const string modelName = "gpt-35-turbo";
new LanguageModel(_kernel.GetService<IChatCompletion>(modelName), modelName);
```

### Using your own client
TypeChat accesses language models using the [ILanguageModel](src/typechat/ILanguageModel.cs) interface. [LanguageModel](src/typechat.sk/LanguageModel.cs) implements ILanguageModel.

You can use your own model client by implementing ILanguageModel.

# License

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
Expand Down