-
-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1442 from samchon/feat/llm
Fix `ILlmFunction.parameters.description` problem.
- Loading branch information
Showing
4 changed files
with
143 additions
and
21 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
This file was deleted.
Oops, something went wrong.
134 changes: 134 additions & 0 deletions
134
test/src/features/issues/test_pr_1442_llm_function_parameters_description.ts
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,134 @@ | ||
import { ILlmApplication, ILlmFunction } from "@samchon/openapi"; | ||
import typia, { tags } from "typia"; | ||
|
||
import { TestValidator } from "../../helpers/TestValidator"; | ||
|
||
export const test_pr_1442_llm_function_parameters_description = (): void => { | ||
const app: ILlmApplication<"chatgpt"> = typia.llm.application< | ||
BbsArticleController, | ||
"chatgpt" | ||
>(); | ||
for (const func of app.functions) | ||
TestValidator.equals("parameters.description")( | ||
!!func.parameters.description, | ||
)(true); | ||
|
||
const func: ILlmFunction<"chatgpt"> | undefined = app.functions.find( | ||
(func) => func.name === "create", | ||
); | ||
TestValidator.equals("parameters.description")( | ||
!!func?.parameters.description, | ||
)(true); | ||
TestValidator.equals("output.description")(!!func?.output?.description)(true); | ||
}; | ||
|
||
interface BbsArticleController { | ||
/** | ||
* Create a new article. | ||
* | ||
* Writes a new article and archives it into the DB. | ||
* | ||
* @param props Properties of create function | ||
* @returns Newly created article | ||
*/ | ||
create(props: { | ||
/** | ||
* Information of the article to create | ||
*/ | ||
input: IBbsArticle.ICreate; | ||
}): Promise<IBbsArticle>; | ||
|
||
/** | ||
* Update an article. | ||
* | ||
* Updates an article with new content. | ||
* | ||
* @param props Properties of update function | ||
* @param input New content to update | ||
*/ | ||
update(props: { | ||
/** | ||
* Target article's {@link IBbsArticle.id}. | ||
*/ | ||
id: string & tags.Format<"uuid">; | ||
|
||
/** | ||
* New content to update. | ||
*/ | ||
input: IBbsArticle.IUpdate; | ||
}): Promise<void>; | ||
|
||
/** | ||
* Erase an article. | ||
* | ||
* Erases an article from the DB. | ||
* | ||
* @param props Properties of erase function | ||
*/ | ||
erase(props: { | ||
/** | ||
* Target article's {@link IBbsArticle.id}. | ||
*/ | ||
id: string & tags.Format<"uuid">; | ||
}): Promise<void>; | ||
} | ||
|
||
/** | ||
* Article entity. | ||
* | ||
* `IBbsArticle` is an entity representing an article in the BBS (Bulletin Board System). | ||
*/ | ||
interface IBbsArticle extends IBbsArticle.ICreate { | ||
/** | ||
* Primary Key. | ||
*/ | ||
id: string & tags.Format<"uuid">; | ||
|
||
/** | ||
* Creation time of the article. | ||
*/ | ||
created_at: string & tags.Format<"date-time">; | ||
|
||
/** | ||
* Last updated time of the article. | ||
*/ | ||
updated_at: string & tags.Format<"date-time">; | ||
} | ||
namespace IBbsArticle { | ||
/** | ||
* Information of the article to create. | ||
*/ | ||
export interface ICreate { | ||
/** | ||
* Title of the article. | ||
* | ||
* Representative title of the article. | ||
*/ | ||
title: string; | ||
|
||
/** | ||
* Content body. | ||
* | ||
* Content body of the article writtn in the markdown format. | ||
*/ | ||
body: string; | ||
|
||
/** | ||
* Thumbnail image URI. | ||
* | ||
* Thumbnail image URI which can represent the article. | ||
* | ||
* If configured as `null`, it means that no thumbnail image in the article. | ||
*/ | ||
thumbnail: | ||
| null | ||
| (string & tags.Format<"uri"> & tags.ContentMediaType<"image/*">); | ||
} | ||
|
||
/** | ||
* Information of the article to update. | ||
* | ||
* Only the filled properties will be updated. | ||
*/ | ||
export type IUpdate = Partial<ICreate>; | ||
} |