Skip to content

Commit

Permalink
Revisão 3: Documentação do Dto
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphael Silva Moreira committed Oct 12, 2023
1 parent 6b03466 commit 1b402b4
Show file tree
Hide file tree
Showing 11 changed files with 33 additions and 53 deletions.
8 changes: 4 additions & 4 deletions doc/site/api/Lensophy.Dto.ContentAnalyse.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ <h1 id="Lensophy_Dto_ContentAnalyse" data-uid="Lensophy.Dto.ContentAnalyse" clas

<h2 id="Lensophy_Dto_ContentAnalyse_examples">Examples</h2>
<p>
<b>Context:</b> "They are discussing the latest Indiana Jones movie."</p>
<p><b>Message:</b> "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!"</p>
<b>Context:</b> They are discussing the latest Indiana Jones movie.</p>
<p><b>Message:</b> "You are an idiot and your opinion is worthless. The old movies were better, you jerk!"</p>
<p><b>Possible result:</b> "Your opinion is valuable, but I personally prefer the older Indiana Jones movies."</p>
<p><b>Possible result with no context:</b> "Your opinion is valid, but the old film productions were more preferred."</p>

Expand Down Expand Up @@ -194,8 +194,8 @@ <h4 class="section">Parameters</h4>

<h4 class="section" id="Lensophy_Dto_ContentAnalyse__ctor_System_String_System_String__examples">Examples</h4>
<p>
<b>Context:</b> "They are discussing the latest Indiana Jones movie."</p>
<p><b>Message:</b> "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!"</p>
<b>Context:</b> They are discussing the latest Indiana Jones movie.</p>
<p><b>Message:</b> "You are an idiot and your opinion is worthless. The old movies were better, you jerk!"</p>
<p><b>Possible result:</b> "Your opinion is valuable, but I personally prefer the older Indiana Jones movies."</p>
<p><b>Possible result with no context:</b> "Your opinion is valid, but the old film productions were more preferred."</p>

Expand Down
12 changes: 6 additions & 6 deletions doc/site/api/Lensophy.Dto.ContentAnalysed.html
Original file line number Diff line number Diff line change
Expand Up @@ -169,14 +169,14 @@ <h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>SuggestedMessage</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The reformulated <a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Message">Message</a>, whether based on
<a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Context">Context</a> or not. It can be null or empty if there is an <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_ErrorMessage">ErrorMessage</a>.</p>
<a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Context">Context</a> or not. It can be null or empty if <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_HasError">HasError</a>.</p>
</dd>
<dt><code>IsHarmful</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>Indicates as <code>true</code> if the message was considered harmful; otherwise, <code>false</code>.</p>
</dd>
<dt><code>ErrorMessage</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>Displays an error message if the external Api request fails. Please note that the
displayed message comes exclusively from the external Api and not from Lensophy. Whenever there is an error,
displayed message comes exclusively from the external Api and not from Lensophy. Whenever <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_HasError">HasError</a>,
the <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_SuggestedMessage">SuggestedMessage</a> will be null or empty.</p>
</dd>
</dl>
Expand Down Expand Up @@ -204,7 +204,7 @@ <h3 id="Lensophy_Dto_ContentAnalysed_ErrorMessage" data-uid="Lensophy.Dto.Conten
</h3>

<div class="markdown level1 summary"><p>Displays an error message if the external Api request fails. Please note that the
displayed message comes exclusively from the external Api and not from Lensophy. Whenever there is an error,
displayed message comes exclusively from the external Api and not from Lensophy. Whenever <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_HasError">HasError</a>,
the <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_SuggestedMessage">SuggestedMessage</a> will be null or empty.</p>
</div>
<div class="markdown level1 conceptual"></div>
Expand Down Expand Up @@ -259,8 +259,8 @@ <h4 class="section">Property Value</h4>


<h4 class="section" id="Lensophy_Dto_ContentAnalysed_HasError_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>If it is <code>true</code>, <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_SuggestedMessage">SuggestedMessage</a> will be null or empty, and the message related to
the issue can be obtained from <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_ErrorMessage">ErrorMessage</a>. Otherwise, it will be <code>false</code>, and
<div class="markdown level1 remarks"><p>If it is <code>true</code>, <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_SuggestedMessage">SuggestedMessage</a> will be null or empty and the message related to
the issue can be obtained from <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_ErrorMessage">ErrorMessage</a>. Otherwise, it will be <code>false</code> and
<a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_SuggestedMessage">SuggestedMessage</a> will contain the expected result.</p>
</div>

Expand Down Expand Up @@ -307,7 +307,7 @@ <h3 id="Lensophy_Dto_ContentAnalysed_SuggestedMessage" data-uid="Lensophy.Dto.Co
</h3>

<div class="markdown level1 summary"><p>The reformulated <a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Message">Message</a>, whether based on
<a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Context">Context</a> or not. It can be null or empty if there is an <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_ErrorMessage">ErrorMessage</a>.</p>
<a class="xref" href="Lensophy.Dto.ContentAnalyse.html#Lensophy_Dto_ContentAnalyse_Context">Context</a> or not. It can be null or empty if <a class="xref" href="Lensophy.Dto.ContentAnalysed.html#Lensophy_Dto_ContentAnalysed_HasError">HasError</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>

Expand Down
20 changes: 0 additions & 20 deletions doc/site/api/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,6 @@
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Lensophy.Benchmark.html" name="" title="Lensophy.Benchmark">Lensophy.Benchmark</a>

<ul class="nav level2">
<li>
<a href="Lensophy.Benchmark.JsonSerializerBenchmark.html" name="" title="JsonSerializerBenchmark">JsonSerializerBenchmark</a>
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Lensophy.Dto.html" name="" title="Lensophy.Dto">Lensophy.Dto</a>
Expand Down Expand Up @@ -61,16 +51,6 @@
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Lensophy.ExampleApi.Controllers.html" name="" title="Lensophy.ExampleApi.Controllers">Lensophy.ExampleApi.Controllers</a>

<ul class="nav level2">
<li>
<a href="Lensophy.ExampleApi.Controllers.SampleController.html" name="" title="SampleController">SampleController</a>
</li>
</ul>
</li>
<li>
<span class="expand-stub"></span>
<a href="Lensophy.Extension.html" name="" title="Lensophy.Extension">Lensophy.Extension</a>
Expand Down
2 changes: 1 addition & 1 deletion doc/site/api/toc.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

{"items":[{"name":"Lensophy","href":"Lensophy.html","topicHref":"Lensophy.html","topicUid":"Lensophy","items":[{"name":"LensophyService","href":"Lensophy.LensophyService.html","topicHref":"Lensophy.LensophyService.html","topicUid":"Lensophy.LensophyService"}]},{"name":"Lensophy.Benchmark","href":"Lensophy.Benchmark.html","topicHref":"Lensophy.Benchmark.html","topicUid":"Lensophy.Benchmark","items":[{"name":"JsonSerializerBenchmark","href":"Lensophy.Benchmark.JsonSerializerBenchmark.html","topicHref":"Lensophy.Benchmark.JsonSerializerBenchmark.html","topicUid":"Lensophy.Benchmark.JsonSerializerBenchmark"}]},{"name":"Lensophy.Dto","href":"Lensophy.Dto.html","topicHref":"Lensophy.Dto.html","topicUid":"Lensophy.Dto","items":[{"name":"ContentAnalyse","href":"Lensophy.Dto.ContentAnalyse.html","topicHref":"Lensophy.Dto.ContentAnalyse.html","topicUid":"Lensophy.Dto.ContentAnalyse"},{"name":"ContentAnalysed","href":"Lensophy.Dto.ContentAnalysed.html","topicHref":"Lensophy.Dto.ContentAnalysed.html","topicUid":"Lensophy.Dto.ContentAnalysed"}]},{"name":"Lensophy.Dto.OpenAi","href":"Lensophy.Dto.OpenAi.html","topicHref":"Lensophy.Dto.OpenAi.html","topicUid":"Lensophy.Dto.OpenAi","items":[{"name":"CompletionChatMessage","href":"Lensophy.Dto.OpenAi.CompletionChatMessage.html","topicHref":"Lensophy.Dto.OpenAi.CompletionChatMessage.html","topicUid":"Lensophy.Dto.OpenAi.CompletionChatMessage"},{"name":"CompletionChatRequest","href":"Lensophy.Dto.OpenAi.CompletionChatRequest.html","topicHref":"Lensophy.Dto.OpenAi.CompletionChatRequest.html","topicUid":"Lensophy.Dto.OpenAi.CompletionChatRequest"},{"name":"OpenAiConfig","href":"Lensophy.Dto.OpenAi.OpenAiConfig.html","topicHref":"Lensophy.Dto.OpenAi.OpenAiConfig.html","topicUid":"Lensophy.Dto.OpenAi.OpenAiConfig"}]},{"name":"Lensophy.ExampleApi.Controllers","href":"Lensophy.ExampleApi.Controllers.html","topicHref":"Lensophy.ExampleApi.Controllers.html","topicUid":"Lensophy.ExampleApi.Controllers","items":[{"name":"SampleController","href":"Lensophy.ExampleApi.Controllers.SampleController.html","topicHref":"Lensophy.ExampleApi.Controllers.SampleController.html","topicUid":"Lensophy.ExampleApi.Controllers.SampleController"}]},{"name":"Lensophy.Extension","href":"Lensophy.Extension.html","topicHref":"Lensophy.Extension.html","topicUid":"Lensophy.Extension","items":[{"name":"ContentAnalyseExtension","href":"Lensophy.Extension.ContentAnalyseExtension.html","topicHref":"Lensophy.Extension.ContentAnalyseExtension.html","topicUid":"Lensophy.Extension.ContentAnalyseExtension"},{"name":"EnumExtension","href":"Lensophy.Extension.EnumExtension.html","topicHref":"Lensophy.Extension.EnumExtension.html","topicUid":"Lensophy.Extension.EnumExtension"},{"name":"ServiceCollectionExtension","href":"Lensophy.Extension.ServiceCollectionExtension.html","topicHref":"Lensophy.Extension.ServiceCollectionExtension.html","topicUid":"Lensophy.Extension.ServiceCollectionExtension"}]},{"name":"Lensophy.Resource","href":"Lensophy.Resource.html","topicHref":"Lensophy.Resource.html","topicUid":"Lensophy.Resource","items":[{"name":"Shared","href":"Lensophy.Resource.Shared.html","topicHref":"Lensophy.Resource.Shared.html","topicUid":"Lensophy.Resource.Shared"}]}],"memberLayout":"SamePage"}
{"items":[{"name":"Lensophy","href":"Lensophy.html","topicHref":"Lensophy.html","topicUid":"Lensophy","items":[{"name":"LensophyService","href":"Lensophy.LensophyService.html","topicHref":"Lensophy.LensophyService.html","topicUid":"Lensophy.LensophyService"}]},{"name":"Lensophy.Dto","href":"Lensophy.Dto.html","topicHref":"Lensophy.Dto.html","topicUid":"Lensophy.Dto","items":[{"name":"ContentAnalyse","href":"Lensophy.Dto.ContentAnalyse.html","topicHref":"Lensophy.Dto.ContentAnalyse.html","topicUid":"Lensophy.Dto.ContentAnalyse"},{"name":"ContentAnalysed","href":"Lensophy.Dto.ContentAnalysed.html","topicHref":"Lensophy.Dto.ContentAnalysed.html","topicUid":"Lensophy.Dto.ContentAnalysed"}]},{"name":"Lensophy.Dto.OpenAi","href":"Lensophy.Dto.OpenAi.html","topicHref":"Lensophy.Dto.OpenAi.html","topicUid":"Lensophy.Dto.OpenAi","items":[{"name":"CompletionChatMessage","href":"Lensophy.Dto.OpenAi.CompletionChatMessage.html","topicHref":"Lensophy.Dto.OpenAi.CompletionChatMessage.html","topicUid":"Lensophy.Dto.OpenAi.CompletionChatMessage"},{"name":"CompletionChatRequest","href":"Lensophy.Dto.OpenAi.CompletionChatRequest.html","topicHref":"Lensophy.Dto.OpenAi.CompletionChatRequest.html","topicUid":"Lensophy.Dto.OpenAi.CompletionChatRequest"},{"name":"OpenAiConfig","href":"Lensophy.Dto.OpenAi.OpenAiConfig.html","topicHref":"Lensophy.Dto.OpenAi.OpenAiConfig.html","topicUid":"Lensophy.Dto.OpenAi.OpenAiConfig"}]},{"name":"Lensophy.Extension","href":"Lensophy.Extension.html","topicHref":"Lensophy.Extension.html","topicUid":"Lensophy.Extension","items":[{"name":"ContentAnalyseExtension","href":"Lensophy.Extension.ContentAnalyseExtension.html","topicHref":"Lensophy.Extension.ContentAnalyseExtension.html","topicUid":"Lensophy.Extension.ContentAnalyseExtension"},{"name":"EnumExtension","href":"Lensophy.Extension.EnumExtension.html","topicHref":"Lensophy.Extension.EnumExtension.html","topicUid":"Lensophy.Extension.EnumExtension"},{"name":"ServiceCollectionExtension","href":"Lensophy.Extension.ServiceCollectionExtension.html","topicHref":"Lensophy.Extension.ServiceCollectionExtension.html","topicUid":"Lensophy.Extension.ServiceCollectionExtension"}]},{"name":"Lensophy.Resource","href":"Lensophy.Resource.html","topicHref":"Lensophy.Resource.html","topicUid":"Lensophy.Resource","items":[{"name":"Shared","href":"Lensophy.Resource.Shared.html","topicHref":"Lensophy.Resource.Shared.html","topicUid":"Lensophy.Resource.Shared"}]}],"memberLayout":"SamePage"}
2 changes: 1 addition & 1 deletion doc/site/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<a href="articles/sui-generis.html" name="articles/toc.html" title="Articles">Articles</a>
</li>
<li>
<a href="api/index.html" name="api/toc.html" title="Api Documentation">Api Documentation</a>
<a href="api/index.html" name="api/toc.html" title="Documentation">Documentation</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/site/toc.json
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

{"items":[{"name":"Articles","href":"articles/sui-generis.html","tocHref":"articles/toc.html","topicHref":"articles/sui-generis.html"},{"name":"Api Documentation","href":"api/index.html","tocHref":"api/toc.html","topicHref":"api/index.html","homepage":"api/index.html"}]}
{"items":[{"name":"Articles","href":"articles/sui-generis.html","tocHref":"articles/toc.html","topicHref":"articles/sui-generis.html"},{"name":"Documentation","href":"api/index.html","tocHref":"api/toc.html","topicHref":"api/index.html","homepage":"api/index.html"}]}
Loading

0 comments on commit 1b402b4

Please sign in to comment.