diff --git a/docs/modelfile.md b/docs/modelfile.md index 1d0030f4..7c38192b 100644 --- a/docs/modelfile.md +++ b/docs/modelfile.md @@ -131,7 +131,7 @@ The `PARAMETER` instruction defines a parameter that can be set when the model i PARAMETER ``` -### Valid Parameters and Values +#### Valid Parameters and Values | Parameter | Description | Value Type | Example Usage | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- | @@ -201,7 +201,22 @@ LICENSE """ ### MESSAGE -The `MESSAGE` instruction allows you to specify a message history for the model to use when responding: +The `MESSAGE` instruction allows you to specify a message history for the model to use when responding. Use multiple iterations of the MESSAGE command to build up a conversation which will guide the model to answer in a similar way. + +```modelfile +MESSAGE +``` + +#### Valid roles + +| Role | Description | +| --------- | ------------------------------------------------------------ | +| system | Alternate way of providing the SYSTEM message for the model. | +| user | An example message of what the user could have asked. | +| assistant | An example message of how the model should respond. | + + +#### Example conversation ```modelfile MESSAGE user Is Toronto in Canada? @@ -212,6 +227,7 @@ MESSAGE user Is Ontario in Canada? MESSAGE assistant yes ``` + ## Notes - the **`Modelfile` is not case sensitive**. In the examples, uppercase instructions are used to make it easier to distinguish it from arguments.