-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
315 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# ChatGptChoice.LogProbabilities property | ||
|
||
Gets or sets the log probabilities associated with this [`ChatGptChoice`](../ChatGptChoice.md). | ||
|
||
```csharp | ||
public ChatGptLogProbability? LogProbabilities { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbability](../ChatGptLogProbability.md) | ||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* class [ChatGptChoice](../ChatGptChoice.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# ChatGptLogProbability class | ||
|
||
Represents the log probability information of a [`completion choice`](./ChatGptChoice.md). | ||
|
||
```csharp | ||
public class ChatGptLogProbability | ||
``` | ||
|
||
## Public Members | ||
|
||
| name | description | | ||
| --- | --- | | ||
| [ChatGptLogProbability](ChatGptLogProbability/ChatGptLogProbability.md)() | The default constructor. | | ||
| [Content](ChatGptLogProbability/Content.md) { get; set; } | Gets or sets the list of message content tokens with log probability information. | | ||
|
||
## See Also | ||
|
||
* namespace [ChatGptNet.Models](../ChatGptNet.md) | ||
* [ChatGptLogProbability.cs](https://github.com/marcominerva/ChatGptNet/tree/master/src/ChatGptNet/Models/ChatGptLogProbability.cs) | ||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
14 changes: 14 additions & 0 deletions
14
docs/ChatGptNet.Models/ChatGptLogProbability/ChatGptLogProbability.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ChatGptLogProbability constructor | ||
|
||
The default constructor. | ||
|
||
```csharp | ||
public ChatGptLogProbability() | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbability](../ChatGptLogProbability.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# ChatGptLogProbability.Content property | ||
|
||
Gets or sets the list of message content tokens with log probability information. | ||
|
||
```csharp | ||
public IEnumerable<ChatGptLogProbabilityContent> Content { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* class [ChatGptLogProbability](../ChatGptLogProbability.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# ChatGptLogProbabilityContent class | ||
|
||
Represents a message content token with log probability information. | ||
|
||
```csharp | ||
public class ChatGptLogProbabilityContent | ||
``` | ||
|
||
## Public Members | ||
|
||
| name | description | | ||
| --- | --- | | ||
| [ChatGptLogProbabilityContent](ChatGptLogProbabilityContent/ChatGptLogProbabilityContent.md)() | The default constructor. | | ||
| [Bytes](ChatGptLogProbabilityContent/Bytes.md) { get; set; } | Gets or sets a list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. | | ||
| [LogProbality](ChatGptLogProbabilityContent/LogProbality.md) { get; set; } | Gets or sets the log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. | | ||
| [Token](ChatGptLogProbabilityContent/Token.md) { get; set; } | Gets or sets the token. | | ||
| [TopLogProbabilities](ChatGptLogProbabilityContent/TopLogProbabilities.md) { get; set; } | Gets or sets the list of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested [`TopLogProbabilities`](./ChatGptParameters/TopLogProbabilities.md) returned. | | ||
|
||
## See Also | ||
|
||
* namespace [ChatGptNet.Models](../ChatGptNet.md) | ||
* [ChatGptLogProbabilityContent.cs](https://github.com/marcominerva/ChatGptNet/tree/master/src/ChatGptNet/Models/ChatGptLogProbabilityContent.cs) | ||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
14 changes: 14 additions & 0 deletions
14
docs/ChatGptNet.Models/ChatGptLogProbabilityContent/Bytes.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ChatGptLogProbabilityContent.Bytes property | ||
|
||
Gets or sets a list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token. | ||
|
||
```csharp | ||
public IEnumerable<byte>? Bytes { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
14 changes: 14 additions & 0 deletions
14
.../ChatGptNet.Models/ChatGptLogProbabilityContent/ChatGptLogProbabilityContent.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ChatGptLogProbabilityContent constructor | ||
|
||
The default constructor. | ||
|
||
```csharp | ||
public ChatGptLogProbabilityContent() | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
14 changes: 14 additions & 0 deletions
14
docs/ChatGptNet.Models/ChatGptLogProbabilityContent/LogProbality.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ChatGptLogProbabilityContent.LogProbality property | ||
|
||
Gets or sets the log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value -9999.0 is used to signify that the token is very unlikely. | ||
|
||
```csharp | ||
public double LogProbality { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
14 changes: 14 additions & 0 deletions
14
docs/ChatGptNet.Models/ChatGptLogProbabilityContent/Token.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ChatGptLogProbabilityContent.Token property | ||
|
||
Gets or sets the token. | ||
|
||
```csharp | ||
public string Token { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
15 changes: 15 additions & 0 deletions
15
docs/ChatGptNet.Models/ChatGptLogProbabilityContent/TopLogProbabilities.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# ChatGptLogProbabilityContent.TopLogProbabilities property | ||
|
||
Gets or sets the list of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested [`TopLogProbabilities`](../ChatGptParameters/TopLogProbabilities.md) returned. | ||
|
||
```csharp | ||
public IEnumerable<ChatGptLogProbabilityContent>? TopLogProbabilities { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* property [TopLogProbabilities](../ChatGptParameters/TopLogProbabilities.md) | ||
* class [ChatGptLogProbabilityContent](../ChatGptLogProbabilityContent.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
docs/ChatGptNet.Models/ChatGptParameters/LogProbabilities.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# ChatGptParameters.LogProbabilities property | ||
|
||
Gets or set a value that determines whether to return log probabilities of the output tokens or not. If `true`, returns the log probabilities of each output token returned in the content of message (default: `false`). | ||
|
||
```csharp | ||
public bool? LogProbabilities { get; set; } | ||
``` | ||
|
||
## See Also | ||
|
||
* property [TopLogProbabilities](./TopLogProbabilities.md) | ||
* class [ChatGptParameters](../ChatGptParameters.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
19 changes: 19 additions & 0 deletions
19
docs/ChatGptNet.Models/ChatGptParameters/TopLogProbabilities.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# ChatGptParameters.TopLogProbabilities property | ||
|
||
Gets or sets a value between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. | ||
|
||
```csharp | ||
public int? TopLogProbabilities { get; set; } | ||
``` | ||
|
||
## Remarks | ||
|
||
[`LogProbabilities`](./LogProbabilities.md)must be set to `true` if this parameter is used. | ||
|
||
## See Also | ||
|
||
* property [LogProbabilities](./LogProbabilities.md) | ||
* class [ChatGptParameters](../ChatGptParameters.md) | ||
* namespace [ChatGptNet.Models](../../ChatGptNet.md) | ||
|
||
<!-- DO NOT EDIT: generated by xmldocmd for ChatGptNet.dll --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
namespace ChatGptNet.Models; | ||
|
||
/// <summary> | ||
/// Represents the log probability information of a <see cref="ChatGptChoice">completion choice</see>. | ||
/// </summary> | ||
public class ChatGptLogProbability | ||
{ | ||
/// <summary> | ||
/// Gets or sets the list of message content tokens with log probability information. | ||
/// </summary> | ||
public IEnumerable<ChatGptLogProbabilityContent> Content { get; set; } = []; | ||
} |
Oops, something went wrong.