Skip to content

Commit

Permalink
Merge pull request OkGoDoIt#113 from tomaustin700/master
Browse files Browse the repository at this point in the history
Fix typo - "hstory" to "history"
  • Loading branch information
OkGoDoIt authored Apr 15, 2023
2 parents 39d76d5 + 5867dca commit 8bc534b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions OpenAI_API/Chat/Conversation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public Conversation(ChatEndpoint endpoint, OpenAI_API.Models.Model model = null,
private List<ChatMessage> _Messages;

/// <summary>
/// Appends a <see cref="ChatMessage"/> to the chat hstory
/// Appends a <see cref="ChatMessage"/> to the chat history
/// </summary>
/// <param name="message">The <see cref="ChatMessage"/> to append to the chat history</param>
public void AppendMessage(ChatMessage message)
Expand All @@ -80,33 +80,33 @@ public void AppendMessage(ChatMessage message)
}

/// <summary>
/// Creates and appends a <see cref="ChatMessage"/> to the chat hstory
/// Creates and appends a <see cref="ChatMessage"/> to the chat history
/// </summary>
/// <param name="role">The <see cref="ChatMessageRole"/> for the message. Typically, a conversation is formatted with a system message first, followed by alternating user and assistant messages. See <see href="https://platform.openai.com/docs/guides/chat/introduction">the OpenAI docs</see> for more details about usage.</param>
/// <param name="content">The content of the message)</param>
public void AppendMessage(ChatMessageRole role, string content) => this.AppendMessage(new ChatMessage(role, content));

/// <summary>
/// Creates and appends a <see cref="ChatMessage"/> to the chat hstory with the Role of <see cref="ChatMessageRole.User"/>. The user messages help instruct the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
/// Creates and appends a <see cref="ChatMessage"/> to the chat history with the Role of <see cref="ChatMessageRole.User"/>. The user messages help instruct the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
/// </summary>
/// <param name="content">Text content generated by the end users of an application, or set by a developer as an instruction</param>
public void AppendUserInput(string content) => this.AppendMessage(new ChatMessage(ChatMessageRole.User, content));

/// <summary>
/// Creates and appends a <see cref="ChatMessage"/> to the chat hstory with the Role of <see cref="ChatMessageRole.User"/>. The user messages help instruct the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
/// Creates and appends a <see cref="ChatMessage"/> to the chat history with the Role of <see cref="ChatMessageRole.User"/>. The user messages help instruct the assistant. They can be generated by the end users of an application, or set by a developer as an instruction.
/// </summary>
/// <param name="userName">The name of the user in a multi-user chat</param>
/// <param name="content">Text content generated by the end users of an application, or set by a developer as an instruction</param>
public void AppendUserInputWithName(string userName, string content) => this.AppendMessage(new ChatMessage(ChatMessageRole.User, content) { Name = userName });


/// <summary>
/// Creates and appends a <see cref="ChatMessage"/> to the chat hstory with the Role of <see cref="ChatMessageRole.System"/>. The system message helps set the behavior of the assistant.
/// Creates and appends a <see cref="ChatMessage"/> to the chat history with the Role of <see cref="ChatMessageRole.System"/>. The system message helps set the behavior of the assistant.
/// </summary>
/// <param name="content">text content that helps set the behavior of the assistant</param>
public void AppendSystemMessage(string content) => this.AppendMessage(new ChatMessage(ChatMessageRole.System, content));
/// <summary>
/// Creates and appends a <see cref="ChatMessage"/> to the chat hstory with the Role of <see cref="ChatMessageRole.Assistant"/>. Assistant messages can be written by a developer to help give examples of desired behavior.
/// Creates and appends a <see cref="ChatMessage"/> to the chat history with the Role of <see cref="ChatMessageRole.Assistant"/>. Assistant messages can be written by a developer to help give examples of desired behavior.
/// </summary>
/// <param name="content">Text content written by a developer to help give examples of desired behavior</param>
public void AppendExampleChatbotOutput(string content) => this.AppendMessage(new ChatMessage(ChatMessageRole.Assistant, content));
Expand Down

0 comments on commit 8bc534b

Please sign in to comment.