add more docs on for the modelfile message command (#3087)
This commit is contained in:
parent
2f804068bd
commit
ba7cf7fb66
1 changed files with 18 additions and 2 deletions
|
@ -131,7 +131,7 @@ The `PARAMETER` instruction defines a parameter that can be set when the model i
|
||||||
PARAMETER <parameter> <parametervalue>
|
PARAMETER <parameter> <parametervalue>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Valid Parameters and Values
|
#### Valid Parameters and Values
|
||||||
|
|
||||||
| Parameter | Description | Value Type | Example Usage |
|
| Parameter | Description | Value Type | Example Usage |
|
||||||
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- |
|
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | -------------------- |
|
||||||
|
@ -201,7 +201,22 @@ LICENSE """
|
||||||
|
|
||||||
### MESSAGE
|
### 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 <role> <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
|
```modelfile
|
||||||
MESSAGE user Is Toronto in Canada?
|
MESSAGE user Is Toronto in Canada?
|
||||||
|
@ -212,6 +227,7 @@ MESSAGE user Is Ontario in Canada?
|
||||||
MESSAGE assistant yes
|
MESSAGE assistant yes
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- the **`Modelfile` is not case sensitive**. In the examples, uppercase instructions are used to make it easier to distinguish it from arguments.
|
- the **`Modelfile` is not case sensitive**. In the examples, uppercase instructions are used to make it easier to distinguish it from arguments.
|
||||||
|
|
Loading…
Reference in a new issue