diff --git a/README-JA.md b/README-JA.md index ad7624d..a786f4c 100644 --- a/README-JA.md +++ b/README-JA.md @@ -165,6 +165,10 @@ CurrentProfile: gpt4.yaml 会話の概要を表示するかどうかを示します。trueに設定されているプロファイルで会話を始めた際、会話の概要をGPT3.5で生成します。 +**ResponseFormat** + +`text` か `json_object` を指定します。 `text` を指定した場合、ChatGPTは通常のテキスト形式で応答を行います。 `json_object` を指定し、プロンプトに `json` を含めて送信した場合、ChatGPTは有効なJSONオブジェクト形式で応答を行います。 + **SystemContext** ChatGPTに送信されるシステムコンテキストです。会話の最も最初に送信され、どのような会話をしてほしいかをChatGPTに伝えます。 diff --git a/README.md b/README.md index 39b3f58..8a15845 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ `aski` is a feature-rich ChatGPT client for the terminal. In addition to regular conversations, it offers various features such as saving and restoring conversation history, moving to and editing arbitrary conversations. ## Features -- Written in Go, so it can be used on any platform that supports Go. +- It is written in Go, which allows for cross-platform compatibility on systems that support Go. - Works in the shell, compatible with PowerShell and Terminal. -- GPT4 supported +- Support for GPT-4 Turbo (Preview) - Save and restore conversation history - Move to any point in the conversation - File attachment with GLOB support @@ -77,7 +77,7 @@ All commands except `:exit` are searched by forward match. For example, typing ` ![external editor](https://raw.githubusercontent.com/kznrluk/aski/main/docs/editor.gif) -For prompts with line breaks or long input that is difficult to input on the console, you can use an external editor. +For prompts with line breaks or long input difficult to type directly into the console, you can use an external editor. ``` aski@GPT4> :editor @@ -168,11 +168,15 @@ Indicates whether to automatically save the conversation history. Profiles set t Indicates whether to display the conversation summary. When starting a conversation with a profile set to true, a summary of the conversation will be generated using GPT3.5. +**ResponseFormat** + +Specifies whether the response should be in `text` or `json_object` format. If `text` is selected, ChatGPT will respond in the usual text format. If `json_object` is selected and the prompt includes `json`, ChatGPT will respond in a valid JSON object format. + **SystemContext** The system context that will be sent to ChatGPT. It is sent at the beginning of the conversation to tell ChatGPT what kind of conversation you want to have. -**UserMessages** +**Messages** The user context that will be sent to ChatGPT. It is sent at the beginning of the conversation. Use it when you don't want to include information in the SystemContext.