diff --git a/doc/site/api/Lensophy.Dto.ContentAnalyse.html b/doc/site/api/Lensophy.Dto.ContentAnalyse.html index e75c6d9..cc4069e 100644 --- a/doc/site/api/Lensophy.Dto.ContentAnalyse.html +++ b/doc/site/api/Lensophy.Dto.ContentAnalyse.html @@ -145,8 +145,8 @@

Examples

- Context: "They are discussing the latest Indiana Jones movie."

-

Message: "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!"

+ Context: They are discussing the latest Indiana Jones movie.

+

Message: "You are an idiot and your opinion is worthless. The old movies were better, you jerk!"

Possible result: "Your opinion is valuable, but I personally prefer the older Indiana Jones movies."

Possible result with no context: "Your opinion is valid, but the old film productions were more preferred."

@@ -194,8 +194,8 @@

Parameters

Examples

- Context: "They are discussing the latest Indiana Jones movie."

-

Message: "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!"

+ Context: They are discussing the latest Indiana Jones movie.

+

Message: "You are an idiot and your opinion is worthless. The old movies were better, you jerk!"

Possible result: "Your opinion is valuable, but I personally prefer the older Indiana Jones movies."

Possible result with no context: "Your opinion is valid, but the old film productions were more preferred."

diff --git a/doc/site/api/Lensophy.Dto.ContentAnalysed.html b/doc/site/api/Lensophy.Dto.ContentAnalysed.html index dbb9903..7604ee2 100644 --- a/doc/site/api/Lensophy.Dto.ContentAnalysed.html +++ b/doc/site/api/Lensophy.Dto.ContentAnalysed.html @@ -169,14 +169,14 @@

Parameters

SuggestedMessage string

The reformulated Message, whether based on -Context or not. It can be null or empty if there is an ErrorMessage.

+Context or not. It can be null or empty if HasError.

IsHarmful bool

Indicates as true if the message was considered harmful; otherwise, false.

ErrorMessage string

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 HasError, the SuggestedMessage will be null or empty.

@@ -204,7 +204,7 @@

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 HasError, the SuggestedMessage will be null or empty.

@@ -259,8 +259,8 @@

Property Value

Remarks

-

If it is true, SuggestedMessage will be null or empty, and the message related to -the issue can be obtained from ErrorMessage. Otherwise, it will be false, and +

If it is true, SuggestedMessage will be null or empty and the message related to +the issue can be obtained from ErrorMessage. Otherwise, it will be false and SuggestedMessage will contain the expected result.

@@ -307,7 +307,7 @@

The reformulated Message, whether based on -Context or not. It can be null or empty if there is an ErrorMessage.

+Context or not. It can be null or empty if HasError.

diff --git a/doc/site/api/toc.html b/doc/site/api/toc.html index 3dbb11c..8277fd8 100644 --- a/doc/site/api/toc.html +++ b/doc/site/api/toc.html @@ -22,16 +22,6 @@ -
  • - - Lensophy.Benchmark - - -
  • Lensophy.Dto @@ -61,16 +51,6 @@
    • -
  • - - Lensophy.ExampleApi.Controllers - - -
  • Lensophy.Extension diff --git a/doc/site/api/toc.json b/doc/site/api/toc.json index 8c2f20e..28f23b1 100644 --- a/doc/site/api/toc.json +++ b/doc/site/api/toc.json @@ -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"} \ No newline at end of file +{"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"} \ No newline at end of file diff --git a/doc/site/toc.html b/doc/site/toc.html index 591cb7e..bf2f0c1 100644 --- a/doc/site/toc.html +++ b/doc/site/toc.html @@ -16,7 +16,7 @@ Articles
  • - Api Documentation + Documentation
    • diff --git a/doc/site/toc.json b/doc/site/toc.json index 6741344..32dc247 100644 --- a/doc/site/toc.json +++ b/doc/site/toc.json @@ -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"}]} \ No newline at end of file +{"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"}]} \ No newline at end of file diff --git a/src/Lensophy/Doc/Lensophy.xml b/src/Lensophy/Doc/Lensophy.xml index 5f07656..528740e 100644 --- a/src/Lensophy/Doc/Lensophy.xml +++ b/src/Lensophy/Doc/Lensophy.xml @@ -12,8 +12,8 @@ The subject that should be taken into consideration during the response generation. The use of aids in providing a subject-oriented response suggestion. If omitted, the result will be disconnected from the subject, although the result will still make sense. - Context: "They are discussing the latest Indiana Jones movie." - Message: "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!" + Context: They are discussing the latest Indiana Jones movie. + Message: "You are an idiot and your opinion is worthless. The old movies were better, you jerk!" Possible result: "Your opinion is valuable, but I personally prefer the older Indiana Jones movies." Possible result with no context: "Your opinion is valid, but the old film productions were more preferred." @@ -26,8 +26,8 @@ The subject that should be taken into consideration during the response generation. The use of aids in providing a subject-oriented response suggestion. If omitted, the result will be disconnected from the subject, although the result will still make sense. - Context: "They are discussing the latest Indiana Jones movie." - Message: "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!" + Context: They are discussing the latest Indiana Jones movie. + Message: "You are an idiot and your opinion is worthless. The old movies were better, you jerk!" Possible result: "Your opinion is valuable, but I personally prefer the older Indiana Jones movies." Possible result with no context: "Your opinion is valid, but the old film productions were more preferred." @@ -43,10 +43,10 @@ Structure of the content analyzed. The reformulated , whether based on - or not. It can be null or empty if there is an . + or not. It can be null or empty if . Indicates as true if the message was considered harmful; otherwise, false. 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 , the will be null or empty. @@ -54,30 +54,30 @@ Structure of the content analyzed. The reformulated , whether based on - or not. It can be null or empty if there is an . + or not. It can be null or empty if . Indicates as true if the message was considered harmful; otherwise, false. 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 , the will be null or empty. The reformulated , whether based on - or not. It can be null or empty if there is an . + or not. It can be null or empty if . Indicates as true if the message was considered harmful; otherwise, false. 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 , the will be null or empty. Indicates as true if there was an error in the external API request; otherwise, false. - If it is true, will be null or empty, and the message related to - the issue can be obtained from . Otherwise, it will be false, and + If it is true, will be null or empty and the message related to + the issue can be obtained from . Otherwise, it will be false and will contain the expected result. diff --git a/src/Lensophy/Dto/ContentAnalyse.cs b/src/Lensophy/Dto/ContentAnalyse.cs index 098d5c2..2099b75 100644 --- a/src/Lensophy/Dto/ContentAnalyse.cs +++ b/src/Lensophy/Dto/ContentAnalyse.cs @@ -7,8 +7,8 @@ /// The subject that should be taken into consideration during the response generation. /// The use of aids in providing a subject-oriented response suggestion. /// If omitted, the result will be disconnected from the subject, although the result will still make sense. -/// Context: "They are discussing the latest Indiana Jones movie." -/// Message: "You are an idiot, and your opinion is worthless. The old movies were better, you jerk!" +/// Context: They are discussing the latest Indiana Jones movie. +/// Message: "You are an idiot and your opinion is worthless. The old movies were better, you jerk!" /// Possible result: "Your opinion is valuable, but I personally prefer the older Indiana Jones movies." /// Possible result with no context: "Your opinion is valid, but the old film productions were more preferred." /// diff --git a/src/Lensophy/Dto/ContentAnalysed.cs b/src/Lensophy/Dto/ContentAnalysed.cs index cc9a775..3484f87 100644 --- a/src/Lensophy/Dto/ContentAnalysed.cs +++ b/src/Lensophy/Dto/ContentAnalysed.cs @@ -4,18 +4,18 @@ /// Structure of the content analyzed. /// /// The reformulated , whether based on -/// or not. It can be null or empty if there is an . +/// or not. It can be null or empty if . /// Indicates as true if the message was considered harmful; otherwise, false. /// 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 , /// the will be null or empty. public readonly record struct ContentAnalysed(string? SuggestedMessage, bool IsHarmful, string ErrorMessage) { /// /// Indicates as true if there was an error in the external API request; otherwise, false. /// - /// If it is true, will be null or empty, and the message related to - /// the issue can be obtained from . Otherwise, it will be false, and + /// If it is true, will be null or empty and the message related to + /// the issue can be obtained from . Otherwise, it will be false and /// will contain the expected result. public bool HasError => !string.IsNullOrWhiteSpace(ErrorMessage); } \ No newline at end of file diff --git a/tool/docfx_project/docfx.json b/tool/docfx_project/docfx.json index 186dcc4..a430378 100644 --- a/tool/docfx_project/docfx.json +++ b/tool/docfx_project/docfx.json @@ -3,7 +3,7 @@ { "src": [ { - "files": [ "**.csproj" ], + "files": [ "Lensophy/Lensophy.csproj" ], "src": "../../src" } ], diff --git a/tool/docfx_project/toc.yml b/tool/docfx_project/toc.yml index 59f8010..63de479 100644 --- a/tool/docfx_project/toc.yml +++ b/tool/docfx_project/toc.yml @@ -1,5 +1,5 @@ - name: Articles href: articles/ -- name: Api Documentation +- name: Documentation href: api/ homepage: api/index.md