Documentation update #24

marcominerva · Dec 7, 2023 · 892bb25 · 892bb25
1 parent c3a8800
commit 892bb25
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 0 deletions.
diff --git a/docs/DallENet/DallEOptions.md b/docs/DallENet/DallEOptions.md
@@ -17,6 +17,7 @@ public class DallEOptions
 | [DefaultSize](DallEOptions/DefaultSize.md) { get; set; } | Gets or sets the default resolution for image generation (default: [`_1024x1024`](../DallENet.Models/DallEImageSizes/_1024x1024.md)). |
 | [DefaultStyle](DallEOptions/DefaultStyle.md) { get; set; } | Gets or sets the default style of generated images (default: [`Vivid`](../DallENet.Models/DallEImageStyles/Vivid.md). |
 | [ThrowExceptionOnError](DallEOptions/ThrowExceptionOnError.md) { get; set; } | Gets or sets a value that determines whether to throw a [`DallEException`](../DallENet.Exceptions/DallEException.md) when an error occurred (default: `true`). If this property is set to `false`, API errors are returned in the [`DallEImageGenerationResponse`](../DallENet.Models/DallEImageGenerationResponse.md) object. |
+| [User](DallEOptions/User.md) { get; set; } | Gets or sets the user identification for chat completion, which can help OpenAI to monitor and detect abuse. |
 
 ## See Also
 

diff --git a/docs/DallENet/DallEOptions/User.md b/docs/DallENet/DallEOptions/User.md
@@ -0,0 +1,18 @@
+# DallEOptions.User property
+
+Gets or sets the user identification for chat completion, which can help OpenAI to monitor and detect abuse.
+
+```csharp
+public string? User { get; set; }
+```
+
+## Remarks
+
+See [Safety best practices](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids) for more information.
+
+## See Also
+
+* class [DallEOptions](../DallEOptions.md)
+* namespace [DallENet](../../DallENet.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for DallENet.dll -->
diff --git a/docs/DallENet/DallEOptionsBuilder.md b/docs/DallENet/DallEOptionsBuilder.md
@@ -17,6 +17,7 @@ public class DallEOptionsBuilder
 | [DefaultSize](DallEOptionsBuilder/DefaultSize.md) { get; set; } | Gets or sets the default resolution for image generation (default: [`_1024x1024`](../DallENet.Models/DallEImageSizes/_1024x1024.md)). |
 | [DefaultStyle](DallEOptionsBuilder/DefaultStyle.md) { get; set; } | Gets or sets the default style of generated images (default: [`Vivid`](../DallENet.Models/DallEImageStyles/Vivid.md). |
 | [ThrowExceptionOnError](DallEOptionsBuilder/ThrowExceptionOnError.md) { get; set; } | Gets or sets a value that determines whether to throw a [`DallEException`](../DallENet.Exceptions/DallEException.md) when an error occurred (default: `true`). If this property is set to `false`, API errors are returned in the [`DallEImageGenerationResponse`](../DallENet.Models/DallEImageGenerationResponse.md) object. |
+| [User](DallEOptionsBuilder/User.md) { get; set; } | Gets or sets the user identification for chat completion, which can help OpenAI to monitor and detect abuse. |
 
 ## See Also
 

diff --git a/docs/DallENet/DallEOptionsBuilder/User.md b/docs/DallENet/DallEOptionsBuilder/User.md
@@ -0,0 +1,18 @@
+# DallEOptionsBuilder.User property
+
+Gets or sets the user identification for chat completion, which can help OpenAI to monitor and detect abuse.
+
+```csharp
+public string? User { get; set; }
+```
+
+## Remarks
+
+See [Safety best practices](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids) for more information.
+
+## See Also
+
+* class [DallEOptionsBuilder](../DallEOptionsBuilder.md)
+* namespace [DallENet](../../DallENet.md)
+
+<!-- DO NOT EDIT: generated by xmldocmd for DallENet.dll -->