From 8cfb12bc0ae8b028946c0044143d7d7acf95dc31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=91=E8=BD=BB=E7=8B=82?= <1677568218@qq.com> Date: Sat, 23 Sep 2023 17:47:37 +0800 Subject: [PATCH] release: v0.0.4 --- docs/.vitepress/config.ts | 4 +- docs/api/index.md | 12 +++ ...m-ops.agentprompttemplate._constructor_.md | 20 ++++ ....agentprompttemplate.communicationstyle.md | 11 ++ docs/api/llm-ops.agentprompttemplate.desc.md | 11 ++ .../llm-ops.agentprompttemplate.evaluate.md | 11 ++ docs/api/llm-ops.agentprompttemplate.field.md | 11 ++ .../api/llm-ops.agentprompttemplate.format.md | 15 +++ ....agentprompttemplate.formatevaluateitem.md | 22 ++++ ...-ops.agentprompttemplate.humansituation.md | 11 ++ .../llm-ops.agentprompttemplate.keyrole.md | 11 ++ .../llm-ops.agentprompttemplate.language.md | 11 ++ docs/api/llm-ops.agentprompttemplate.level.md | 11 ++ docs/api/llm-ops.agentprompttemplate.md | 47 ++++++++ .../api/llm-ops.agentprompttemplate.memory.md | 11 ++ docs/api/llm-ops.agentprompttemplate.other.md | 11 ++ .../llm-ops.agentprompttemplate.reasoning.md | 11 ++ .../llm-ops.agentprompttemplate.reflection.md | 11 ++ ...lm-ops.agentprompttemplate.returnprompt.md | 11 ++ docs/api/llm-ops.agentprompttemplate.role.md | 11 ++ docs/api/llm-ops.agentprompttemplate.rules.md | 11 ++ .../llm-ops.agentprompttemplate.tonestyle.md | 11 ++ ...prompttemplateschema.communicationstyle.md | 11 ++ .../llm-ops.agentprompttemplateschema.desc.md | 11 ++ ...-ops.agentprompttemplateschema.evaluate.md | 11 ++ ...llm-ops.agentprompttemplateschema.field.md | 11 ++ ...gentprompttemplateschema.humansituation.md | 11 ++ ...m-ops.agentprompttemplateschema.keyrole.md | 11 ++ ...-ops.agentprompttemplateschema.language.md | 11 ++ ...llm-ops.agentprompttemplateschema.level.md | 11 ++ docs/api/llm-ops.agentprompttemplateschema.md | 32 ++++++ ...lm-ops.agentprompttemplateschema.memory.md | 11 ++ ...llm-ops.agentprompttemplateschema.other.md | 11 ++ ...ops.agentprompttemplateschema.reasoning.md | 11 ++ ...ps.agentprompttemplateschema.reflection.md | 11 ++ .../llm-ops.agentprompttemplateschema.role.md | 11 ++ ...llm-ops.agentprompttemplateschema.rules.md | 11 ++ ...ops.agentprompttemplateschema.tonestyle.md | 11 ++ docs/api/llm-ops.baseagent._constructor_.md | 20 ++++ docs/api/llm-ops.baseagent.call.md | 22 ++++ docs/api/llm-ops.baseagent.chain.md | 11 ++ docs/api/llm-ops.baseagent.md | 31 ++++++ docs/api/llm-ops.baseagent.prompt.md | 11 ++ docs/api/llm-ops.baseagentcallschema.md | 20 ++++ .../llm-ops.baseagentcallschema.prompts.md | 11 ++ .../llm-ops.baseagentcallschema.request.md | 11 ++ .../api/llm-ops.baseagentcallschema.struct.md | 11 ++ docs/api/llm-ops.baseprompttemplate.format.md | 15 +++ docs/api/llm-ops.baseprompttemplate.md | 18 ++++ docs/api/llm-ops.chain._constructor_.md | 20 ++++ docs/api/llm-ops.chain.call.md | 22 ++++ docs/api/llm-ops.chain.chain.md | 11 ++ docs/api/llm-ops.chain.chainname.md | 11 ++ docs/api/llm-ops.chain.exporthistory.md | 15 +++ docs/api/llm-ops.chain.llm.md | 11 ++ docs/api/llm-ops.chain.md | 33 ++++++ docs/api/llm-ops.chaincallschema.md | 21 ++++ docs/api/llm-ops.chaincallschema.prompt.md | 11 ++ docs/api/llm-ops.chaincallschema.request.md | 11 ++ docs/api/llm-ops.chaincallschema.struct.md | 11 ++ docs/api/llm-ops.chaincallschema.verbose.md | 11 ++ docs/api/llm-ops.chainschema.chainname.md | 11 ++ docs/api/llm-ops.chainschema.llm.md | 11 ++ docs/api/llm-ops.chainschema.llmschema.md | 11 ++ docs/api/llm-ops.chainschema.md | 20 ++++ docs/api/llm-ops.chatcompletiontype.md | 11 ++ docs/api/llm-ops.chatparamstype.md | 11 ++ docs/api/llm-ops.chatschema.function_call.md | 11 ++ docs/api/llm-ops.chatschema.functions.md | 11 ++ docs/api/llm-ops.chatschema.md | 20 ++++ docs/api/llm-ops.chatschema.messages.md | 11 ++ docs/api/llm-ops.communicationstyletype.md | 11 ++ docs/api/llm-ops.createjsonvalidator.md | 27 +++++ docs/api/llm-ops.createllmschema.cache.md | 11 ++ .../api/llm-ops.createllmschema.choice_num.md | 11 ++ ...s.createllmschema.helicone_auth_api_key.md | 11 ++ docs/api/llm-ops.createllmschema.history.md | 11 ++ docs/api/llm-ops.createllmschema.md | 27 +++++ docs/api/llm-ops.createllmschema.modelname.md | 11 ++ .../llm-ops.createllmschema.openai_api_key.md | 11 ++ docs/api/llm-ops.createllmschema.stop.md | 11 ++ .../llm-ops.createllmschema.temperature.md | 11 ++ docs/api/llm-ops.createllmschema.tokens.md | 11 ++ docs/api/llm-ops.createllmschema.user.md | 11 ++ docs/api/llm-ops.createmessage.md | 22 ++++ .../llm-ops.createmessageschema.content.md | 11 ++ ...lm-ops.createmessageschema.contentslots.md | 11 ++ ...m-ops.createmessageschema.function_call.md | 11 ++ docs/api/llm-ops.createmessageschema.md | 22 ++++ docs/api/llm-ops.createmessageschema.name.md | 11 ++ docs/api/llm-ops.createmessageschema.role.md | 11 ++ docs/api/llm-ops.error.md | 26 +++++ docs/api/llm-ops.error_2.md | 21 ++++ docs/api/llm-ops.error_2.message.md | 11 ++ docs/api/llm-ops.error_2.success.md | 11 ++ docs/api/llm-ops.evaluateitemschema.desc.md | 11 ++ docs/api/llm-ops.evaluateitemschema.md | 19 ++++ docs/api/llm-ops.evaluateitemschema.name.md | 11 ++ docs/api/llm-ops.formatprompttemplate.md | 11 ++ docs/api/llm-ops.function_calltype.md | 13 +++ docs/api/llm-ops.functioncalloption.md | 18 ++++ docs/api/llm-ops.functioncalloption.name.md | 13 +++ ...lm-ops.functioncallschema.function_call.md | 11 ++ .../llm-ops.functioncallschema.functions.md | 11 ++ docs/api/llm-ops.functioncallschema.md | 22 ++++ docs/api/llm-ops.functioncallschema.prompt.md | 11 ++ .../api/llm-ops.functioncallschema.request.md | 11 ++ .../api/llm-ops.functioncallschema.verbose.md | 11 ++ .../llm-ops.functionchain._constructor_.md | 20 ++++ docs/api/llm-ops.functionchain.call.md | 22 ++++ .../llm-ops.functionchain.exporthistory.md | 15 +++ docs/api/llm-ops.functionchain.llm.md | 11 ++ docs/api/llm-ops.functionchain.md | 31 ++++++ .../llm-ops.functioninterface.description.md | 13 +++ docs/api/llm-ops.functioninterface.md | 20 ++++ docs/api/llm-ops.functioninterface.name.md | 13 +++ .../llm-ops.functioninterface.parameters.md | 15 +++ docs/api/llm-ops.functionstype.md | 13 +++ docs/api/llm-ops.getdata.md | 26 +++++ docs/api/llm-ops.inputvalues.md | 11 ++ docs/api/llm-ops.languagetype.md | 11 ++ docs/api/llm-ops.leveltype.md | 11 ++ docs/api/llm-ops.llm._constructor_.md | 20 ++++ docs/api/llm-ops.llm.cache.md | 11 ++ docs/api/llm-ops.llm.chat.md | 22 ++++ docs/api/llm-ops.llm.choice_num.md | 11 ++ docs/api/llm-ops.llm.embedding.md | 22 ++++ docs/api/llm-ops.llm.exporthistory.md | 15 +++ docs/api/llm-ops.llm.function_call.md | 11 ++ docs/api/llm-ops.llm.functions.md | 11 ++ docs/api/llm-ops.llm.llm.md | 11 ++ docs/api/llm-ops.llm.log.md | 22 ++++ docs/api/llm-ops.llm.md | 47 ++++++++ docs/api/llm-ops.llm.messages.md | 11 ++ docs/api/llm-ops.llm.modelname.md | 11 ++ docs/api/llm-ops.llm.moderate.md | 22 ++++ docs/api/llm-ops.llm.printmessage.md | 23 ++++ docs/api/llm-ops.llm.recall.md | 15 +++ docs/api/llm-ops.llm.roletocolor.md | 16 +++ docs/api/llm-ops.llm.stop.md | 11 ++ docs/api/llm-ops.llm.temperature.md | 11 ++ docs/api/llm-ops.llm.tokens.md | 11 ++ docs/api/llm-ops.llm.user.md | 11 ++ ...ps.llm_ops_config.helicone_auth_api_key.md | 11 ++ docs/api/llm-ops.llm_ops_config.md | 23 ++++ .../llm-ops.llm_ops_config.milvus_address.md | 11 ++ .../llm-ops.llm_ops_config.milvus_password.md | 11 ++ .../llm-ops.llm_ops_config.milvus_username.md | 11 ++ docs/api/llm-ops.llm_ops_config.open_path.md | 16 +++ .../llm-ops.llm_ops_config.openai_api_key.md | 11 ++ docs/api/llm-ops.llmtype.md | 11 ++ docs/api/llm-ops.md | 100 ++++++++++++++++++ ...llm-ops.memoryprompttemplateschema.data.md | 11 ++ ...ps.memoryprompttemplateschema.knowledge.md | 11 ++ .../api/llm-ops.memoryprompttemplateschema.md | 20 ++++ ...lm-ops.memoryprompttemplateschema.tools.md | 11 ++ docs/api/llm-ops.messagefunctioncalltype.md | 11 ++ docs/api/llm-ops.messagestype.md | 11 ++ docs/api/llm-ops.messagetype.md | 11 ++ .../llm-ops.milvusvectordb._constructor_.md | 20 ++++ .../llm-ops.milvusvectordb.collection_name.md | 11 ++ ...llm-ops.milvusvectordb.createcollection.md | 22 ++++ ...s.milvusvectordb.generateprompttemplate.md | 22 ++++ .../llm-ops.milvusvectordb.generatevector.md | 22 ++++ docs/api/llm-ops.milvusvectordb.llm.md | 11 ++ docs/api/llm-ops.milvusvectordb.md | 37 +++++++ .../llm-ops.milvusvectordb.milvusclient.md | 11 ++ docs/api/llm-ops.milvusvectordb.query.md | 22 ++++ docs/api/llm-ops.milvusvectordb.search.md | 22 ++++ docs/api/llm-ops.milvusvectordb.upload.md | 22 ++++ ...m-ops.milvusvectordbcreateschema.fields.md | 11 ++ .../api/llm-ops.milvusvectordbcreateschema.md | 18 ++++ ...ps.milvusvectordbindexschema.field_name.md | 11 ++ docs/api/llm-ops.milvusvectordbindexschema.md | 19 ++++ ...s.milvusvectordbindexschema.metric_type.md | 11 ++ ...vusvectordbprompttemplateschema.content.md | 11 ++ ...-ops.milvusvectordbprompttemplateschema.md | 19 ++++ ...lm-ops.milvusvectordbqueryschema.filter.md | 11 ++ ...llm-ops.milvusvectordbqueryschema.limit.md | 11 ++ docs/api/llm-ops.milvusvectordbqueryschema.md | 20 ++++ ...milvusvectordbqueryschema.output_fields.md | 11 ++ .../llm-ops.milvusvectordbschema.address.md | 11 ++ ...ps.milvusvectordbschema.collection_name.md | 11 ++ docs/api/llm-ops.milvusvectordbschema.llm.md | 11 ++ docs/api/llm-ops.milvusvectordbschema.md | 22 ++++ .../llm-ops.milvusvectordbschema.password.md | 11 ++ .../llm-ops.milvusvectordbschema.username.md | 11 ++ ...svectordbsearchschema.consistency_level.md | 11 ++ ...m-ops.milvusvectordbsearchschema.filter.md | 11 ++ ...lm-ops.milvusvectordbsearchschema.limit.md | 11 ++ .../api/llm-ops.milvusvectordbsearchschema.md | 22 ++++ ...ilvusvectordbsearchschema.output_fields.md | 11 ++ ...m-ops.milvusvectordbsearchschema.vector.md | 11 ++ ....milvusvectordbuploadschema.fields_data.md | 11 ++ ...lm-ops.milvusvectordbuploadschema.index.md | 11 ++ .../api/llm-ops.milvusvectordbuploadschema.md | 20 ++++ ...lvusvectordbuploadschema.partition_name.md | 11 ++ ...m-ops.multipromptschema.collection_name.md | 11 ++ docs/api/llm-ops.multipromptschema.md | 19 ++++ .../api/llm-ops.piperegistry._constructor_.md | 13 +++ docs/api/llm-ops.piperegistry.md | 19 ++++ ...-ops.polishprompttemplate._constructor_.md | 20 ++++ .../llm-ops.polishprompttemplate.evaluate.md | 11 ++ .../llm-ops.polishprompttemplate.format.md | 15 +++ .../llm-ops.polishprompttemplate.language.md | 11 ++ docs/api/llm-ops.polishprompttemplate.md | 35 ++++++ .../api/llm-ops.polishprompttemplate.other.md | 11 ++ ...m-ops.polishprompttemplate.returnprompt.md | 11 ++ .../llm-ops.polishprompttemplate.tonestyle.md | 11 ++ ...ops.polishprompttemplateschema.evaluate.md | 11 ++ ...ops.polishprompttemplateschema.language.md | 11 ++ .../api/llm-ops.polishprompttemplateschema.md | 21 ++++ ...lm-ops.polishprompttemplateschema.other.md | 11 ++ ...ps.polishprompttemplateschema.tonestyle.md | 11 ++ .../llm-ops.promptsschema.collection_name.md | 11 ++ docs/api/llm-ops.promptsschema.md | 22 ++++ docs/api/llm-ops.promptsschema.name.md | 11 ++ docs/api/llm-ops.promptsschema.prompt.md | 11 ++ docs/api/llm-ops.promptsschema.schema.md | 11 ++ docs/api/llm-ops.reasoningtype.md | 11 ++ ...reflectionprompttemplateschema.feedback.md | 11 ++ .../llm-ops.reflectionprompttemplateschema.md | 19 ++++ ...flectionprompttemplateschema.resulttest.md | 11 ++ docs/api/llm-ops.resembeddingtype.md | 11 ++ docs/api/llm-ops.resmessagestype.md | 11 ++ docs/api/llm-ops.resmoderationtype.md | 11 ++ docs/api/llm-ops.result.md | 15 +++ .../api/llm-ops.structschema.function_call.md | 11 ++ docs/api/llm-ops.structschema.functions.md | 11 ++ docs/api/llm-ops.structschema.md | 21 ++++ docs/api/llm-ops.structschema.schema.md | 11 ++ docs/api/llm-ops.structschema.typename.md | 11 ++ docs/api/llm-ops.success.data.md | 11 ++ docs/api/llm-ops.success.md | 21 ++++ docs/api/llm-ops.success.success.md | 11 ++ .../llm-ops.teacherevaluateschema.items.md | 11 ++ .../llm-ops.teacherevaluateschema.maxscore.md | 11 ++ docs/api/llm-ops.teacherevaluateschema.md | 19 ++++ docs/api/llm-ops.tonestyletype.md | 11 ++ ...tjsonvalidator.createmoduletextfromjson.md | 24 +++++ docs/api/llm-ops.typechatjsonvalidator.md | 29 +++++ .../llm-ops.typechatjsonvalidator.schema.md | 13 +++ ...lm-ops.typechatjsonvalidator.stripnulls.md | 13 +++ .../llm-ops.typechatjsonvalidator.typename.md | 13 +++ .../llm-ops.typechatjsonvalidator.validate.md | 26 +++++ .../llm-ops.typescriptchain._constructor_.md | 20 ++++ .../llm-ops.typescriptchain.attemptrepair.md | 11 ++ docs/api/llm-ops.typescriptchain.call.md | 22 ++++ ...-ops.typescriptchain.createrepairprompt.md | 22 ++++ ...ops.typescriptchain.createrequestprompt.md | 22 ++++ .../llm-ops.typescriptchain.exporthistory.md | 15 +++ docs/api/llm-ops.typescriptchain.llm.md | 11 ++ docs/api/llm-ops.typescriptchain.md | 36 +++++++ ...llm-ops.typescriptchaincallschema.bound.md | 11 ++ docs/api/llm-ops.typescriptchaincallschema.md | 25 +++++ ...lm-ops.typescriptchaincallschema.prompt.md | 11 ++ ...m-ops.typescriptchaincallschema.request.md | 11 ++ ...lm-ops.typescriptchaincallschema.schema.md | 11 ++ ...-ops.typescriptchaincallschema.typename.md | 11 ++ ...m-ops.typescriptchaincallschema.verbose.md | 11 ++ package.json | 2 +- package/agent/agent.ts | 5 +- package/chain/chain.ts | 4 +- package/chain/function.ts | 2 +- package/chain/typechat.ts | 8 +- package/db/milvus.ts | 2 +- package/index.ts | 14 +-- package/llm/__tests__/cache.test.ts | 60 +++++------ package/llm/__tests__/index.test.ts | 2 +- package/llm/index.ts | 21 ++-- package/pipeline/__tests__/registry.test.ts | 21 ++-- package/pipeline/store.ts | 39 ++++--- package/prompt/promptTemplate.ts | 7 +- 273 files changed, 3991 insertions(+), 98 deletions(-) create mode 100644 docs/api/index.md create mode 100644 docs/api/llm-ops.agentprompttemplate._constructor_.md create mode 100644 docs/api/llm-ops.agentprompttemplate.communicationstyle.md create mode 100644 docs/api/llm-ops.agentprompttemplate.desc.md create mode 100644 docs/api/llm-ops.agentprompttemplate.evaluate.md create mode 100644 docs/api/llm-ops.agentprompttemplate.field.md create mode 100644 docs/api/llm-ops.agentprompttemplate.format.md create mode 100644 docs/api/llm-ops.agentprompttemplate.formatevaluateitem.md create mode 100644 docs/api/llm-ops.agentprompttemplate.humansituation.md create mode 100644 docs/api/llm-ops.agentprompttemplate.keyrole.md create mode 100644 docs/api/llm-ops.agentprompttemplate.language.md create mode 100644 docs/api/llm-ops.agentprompttemplate.level.md create mode 100644 docs/api/llm-ops.agentprompttemplate.md create mode 100644 docs/api/llm-ops.agentprompttemplate.memory.md create mode 100644 docs/api/llm-ops.agentprompttemplate.other.md create mode 100644 docs/api/llm-ops.agentprompttemplate.reasoning.md create mode 100644 docs/api/llm-ops.agentprompttemplate.reflection.md create mode 100644 docs/api/llm-ops.agentprompttemplate.returnprompt.md create mode 100644 docs/api/llm-ops.agentprompttemplate.role.md create mode 100644 docs/api/llm-ops.agentprompttemplate.rules.md create mode 100644 docs/api/llm-ops.agentprompttemplate.tonestyle.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.desc.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.evaluate.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.field.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.humansituation.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.keyrole.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.language.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.level.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.memory.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.other.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.reasoning.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.reflection.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.role.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.rules.md create mode 100644 docs/api/llm-ops.agentprompttemplateschema.tonestyle.md create mode 100644 docs/api/llm-ops.baseagent._constructor_.md create mode 100644 docs/api/llm-ops.baseagent.call.md create mode 100644 docs/api/llm-ops.baseagent.chain.md create mode 100644 docs/api/llm-ops.baseagent.md create mode 100644 docs/api/llm-ops.baseagent.prompt.md create mode 100644 docs/api/llm-ops.baseagentcallschema.md create mode 100644 docs/api/llm-ops.baseagentcallschema.prompts.md create mode 100644 docs/api/llm-ops.baseagentcallschema.request.md create mode 100644 docs/api/llm-ops.baseagentcallschema.struct.md create mode 100644 docs/api/llm-ops.baseprompttemplate.format.md create mode 100644 docs/api/llm-ops.baseprompttemplate.md create mode 100644 docs/api/llm-ops.chain._constructor_.md create mode 100644 docs/api/llm-ops.chain.call.md create mode 100644 docs/api/llm-ops.chain.chain.md create mode 100644 docs/api/llm-ops.chain.chainname.md create mode 100644 docs/api/llm-ops.chain.exporthistory.md create mode 100644 docs/api/llm-ops.chain.llm.md create mode 100644 docs/api/llm-ops.chain.md create mode 100644 docs/api/llm-ops.chaincallschema.md create mode 100644 docs/api/llm-ops.chaincallschema.prompt.md create mode 100644 docs/api/llm-ops.chaincallschema.request.md create mode 100644 docs/api/llm-ops.chaincallschema.struct.md create mode 100644 docs/api/llm-ops.chaincallschema.verbose.md create mode 100644 docs/api/llm-ops.chainschema.chainname.md create mode 100644 docs/api/llm-ops.chainschema.llm.md create mode 100644 docs/api/llm-ops.chainschema.llmschema.md create mode 100644 docs/api/llm-ops.chainschema.md create mode 100644 docs/api/llm-ops.chatcompletiontype.md create mode 100644 docs/api/llm-ops.chatparamstype.md create mode 100644 docs/api/llm-ops.chatschema.function_call.md create mode 100644 docs/api/llm-ops.chatschema.functions.md create mode 100644 docs/api/llm-ops.chatschema.md create mode 100644 docs/api/llm-ops.chatschema.messages.md create mode 100644 docs/api/llm-ops.communicationstyletype.md create mode 100644 docs/api/llm-ops.createjsonvalidator.md create mode 100644 docs/api/llm-ops.createllmschema.cache.md create mode 100644 docs/api/llm-ops.createllmschema.choice_num.md create mode 100644 docs/api/llm-ops.createllmschema.helicone_auth_api_key.md create mode 100644 docs/api/llm-ops.createllmschema.history.md create mode 100644 docs/api/llm-ops.createllmschema.md create mode 100644 docs/api/llm-ops.createllmschema.modelname.md create mode 100644 docs/api/llm-ops.createllmschema.openai_api_key.md create mode 100644 docs/api/llm-ops.createllmschema.stop.md create mode 100644 docs/api/llm-ops.createllmschema.temperature.md create mode 100644 docs/api/llm-ops.createllmschema.tokens.md create mode 100644 docs/api/llm-ops.createllmschema.user.md create mode 100644 docs/api/llm-ops.createmessage.md create mode 100644 docs/api/llm-ops.createmessageschema.content.md create mode 100644 docs/api/llm-ops.createmessageschema.contentslots.md create mode 100644 docs/api/llm-ops.createmessageschema.function_call.md create mode 100644 docs/api/llm-ops.createmessageschema.md create mode 100644 docs/api/llm-ops.createmessageschema.name.md create mode 100644 docs/api/llm-ops.createmessageschema.role.md create mode 100644 docs/api/llm-ops.error.md create mode 100644 docs/api/llm-ops.error_2.md create mode 100644 docs/api/llm-ops.error_2.message.md create mode 100644 docs/api/llm-ops.error_2.success.md create mode 100644 docs/api/llm-ops.evaluateitemschema.desc.md create mode 100644 docs/api/llm-ops.evaluateitemschema.md create mode 100644 docs/api/llm-ops.evaluateitemschema.name.md create mode 100644 docs/api/llm-ops.formatprompttemplate.md create mode 100644 docs/api/llm-ops.function_calltype.md create mode 100644 docs/api/llm-ops.functioncalloption.md create mode 100644 docs/api/llm-ops.functioncalloption.name.md create mode 100644 docs/api/llm-ops.functioncallschema.function_call.md create mode 100644 docs/api/llm-ops.functioncallschema.functions.md create mode 100644 docs/api/llm-ops.functioncallschema.md create mode 100644 docs/api/llm-ops.functioncallschema.prompt.md create mode 100644 docs/api/llm-ops.functioncallschema.request.md create mode 100644 docs/api/llm-ops.functioncallschema.verbose.md create mode 100644 docs/api/llm-ops.functionchain._constructor_.md create mode 100644 docs/api/llm-ops.functionchain.call.md create mode 100644 docs/api/llm-ops.functionchain.exporthistory.md create mode 100644 docs/api/llm-ops.functionchain.llm.md create mode 100644 docs/api/llm-ops.functionchain.md create mode 100644 docs/api/llm-ops.functioninterface.description.md create mode 100644 docs/api/llm-ops.functioninterface.md create mode 100644 docs/api/llm-ops.functioninterface.name.md create mode 100644 docs/api/llm-ops.functioninterface.parameters.md create mode 100644 docs/api/llm-ops.functionstype.md create mode 100644 docs/api/llm-ops.getdata.md create mode 100644 docs/api/llm-ops.inputvalues.md create mode 100644 docs/api/llm-ops.languagetype.md create mode 100644 docs/api/llm-ops.leveltype.md create mode 100644 docs/api/llm-ops.llm._constructor_.md create mode 100644 docs/api/llm-ops.llm.cache.md create mode 100644 docs/api/llm-ops.llm.chat.md create mode 100644 docs/api/llm-ops.llm.choice_num.md create mode 100644 docs/api/llm-ops.llm.embedding.md create mode 100644 docs/api/llm-ops.llm.exporthistory.md create mode 100644 docs/api/llm-ops.llm.function_call.md create mode 100644 docs/api/llm-ops.llm.functions.md create mode 100644 docs/api/llm-ops.llm.llm.md create mode 100644 docs/api/llm-ops.llm.log.md create mode 100644 docs/api/llm-ops.llm.md create mode 100644 docs/api/llm-ops.llm.messages.md create mode 100644 docs/api/llm-ops.llm.modelname.md create mode 100644 docs/api/llm-ops.llm.moderate.md create mode 100644 docs/api/llm-ops.llm.printmessage.md create mode 100644 docs/api/llm-ops.llm.recall.md create mode 100644 docs/api/llm-ops.llm.roletocolor.md create mode 100644 docs/api/llm-ops.llm.stop.md create mode 100644 docs/api/llm-ops.llm.temperature.md create mode 100644 docs/api/llm-ops.llm.tokens.md create mode 100644 docs/api/llm-ops.llm.user.md create mode 100644 docs/api/llm-ops.llm_ops_config.helicone_auth_api_key.md create mode 100644 docs/api/llm-ops.llm_ops_config.md create mode 100644 docs/api/llm-ops.llm_ops_config.milvus_address.md create mode 100644 docs/api/llm-ops.llm_ops_config.milvus_password.md create mode 100644 docs/api/llm-ops.llm_ops_config.milvus_username.md create mode 100644 docs/api/llm-ops.llm_ops_config.open_path.md create mode 100644 docs/api/llm-ops.llm_ops_config.openai_api_key.md create mode 100644 docs/api/llm-ops.llmtype.md create mode 100644 docs/api/llm-ops.md create mode 100644 docs/api/llm-ops.memoryprompttemplateschema.data.md create mode 100644 docs/api/llm-ops.memoryprompttemplateschema.knowledge.md create mode 100644 docs/api/llm-ops.memoryprompttemplateschema.md create mode 100644 docs/api/llm-ops.memoryprompttemplateschema.tools.md create mode 100644 docs/api/llm-ops.messagefunctioncalltype.md create mode 100644 docs/api/llm-ops.messagestype.md create mode 100644 docs/api/llm-ops.messagetype.md create mode 100644 docs/api/llm-ops.milvusvectordb._constructor_.md create mode 100644 docs/api/llm-ops.milvusvectordb.collection_name.md create mode 100644 docs/api/llm-ops.milvusvectordb.createcollection.md create mode 100644 docs/api/llm-ops.milvusvectordb.generateprompttemplate.md create mode 100644 docs/api/llm-ops.milvusvectordb.generatevector.md create mode 100644 docs/api/llm-ops.milvusvectordb.llm.md create mode 100644 docs/api/llm-ops.milvusvectordb.md create mode 100644 docs/api/llm-ops.milvusvectordb.milvusclient.md create mode 100644 docs/api/llm-ops.milvusvectordb.query.md create mode 100644 docs/api/llm-ops.milvusvectordb.search.md create mode 100644 docs/api/llm-ops.milvusvectordb.upload.md create mode 100644 docs/api/llm-ops.milvusvectordbcreateschema.fields.md create mode 100644 docs/api/llm-ops.milvusvectordbcreateschema.md create mode 100644 docs/api/llm-ops.milvusvectordbindexschema.field_name.md create mode 100644 docs/api/llm-ops.milvusvectordbindexschema.md create mode 100644 docs/api/llm-ops.milvusvectordbindexschema.metric_type.md create mode 100644 docs/api/llm-ops.milvusvectordbprompttemplateschema.content.md create mode 100644 docs/api/llm-ops.milvusvectordbprompttemplateschema.md create mode 100644 docs/api/llm-ops.milvusvectordbqueryschema.filter.md create mode 100644 docs/api/llm-ops.milvusvectordbqueryschema.limit.md create mode 100644 docs/api/llm-ops.milvusvectordbqueryschema.md create mode 100644 docs/api/llm-ops.milvusvectordbqueryschema.output_fields.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.address.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.collection_name.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.llm.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.password.md create mode 100644 docs/api/llm-ops.milvusvectordbschema.username.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.consistency_level.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.filter.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.limit.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.output_fields.md create mode 100644 docs/api/llm-ops.milvusvectordbsearchschema.vector.md create mode 100644 docs/api/llm-ops.milvusvectordbuploadschema.fields_data.md create mode 100644 docs/api/llm-ops.milvusvectordbuploadschema.index.md create mode 100644 docs/api/llm-ops.milvusvectordbuploadschema.md create mode 100644 docs/api/llm-ops.milvusvectordbuploadschema.partition_name.md create mode 100644 docs/api/llm-ops.multipromptschema.collection_name.md create mode 100644 docs/api/llm-ops.multipromptschema.md create mode 100644 docs/api/llm-ops.piperegistry._constructor_.md create mode 100644 docs/api/llm-ops.piperegistry.md create mode 100644 docs/api/llm-ops.polishprompttemplate._constructor_.md create mode 100644 docs/api/llm-ops.polishprompttemplate.evaluate.md create mode 100644 docs/api/llm-ops.polishprompttemplate.format.md create mode 100644 docs/api/llm-ops.polishprompttemplate.language.md create mode 100644 docs/api/llm-ops.polishprompttemplate.md create mode 100644 docs/api/llm-ops.polishprompttemplate.other.md create mode 100644 docs/api/llm-ops.polishprompttemplate.returnprompt.md create mode 100644 docs/api/llm-ops.polishprompttemplate.tonestyle.md create mode 100644 docs/api/llm-ops.polishprompttemplateschema.evaluate.md create mode 100644 docs/api/llm-ops.polishprompttemplateschema.language.md create mode 100644 docs/api/llm-ops.polishprompttemplateschema.md create mode 100644 docs/api/llm-ops.polishprompttemplateschema.other.md create mode 100644 docs/api/llm-ops.polishprompttemplateschema.tonestyle.md create mode 100644 docs/api/llm-ops.promptsschema.collection_name.md create mode 100644 docs/api/llm-ops.promptsschema.md create mode 100644 docs/api/llm-ops.promptsschema.name.md create mode 100644 docs/api/llm-ops.promptsschema.prompt.md create mode 100644 docs/api/llm-ops.promptsschema.schema.md create mode 100644 docs/api/llm-ops.reasoningtype.md create mode 100644 docs/api/llm-ops.reflectionprompttemplateschema.feedback.md create mode 100644 docs/api/llm-ops.reflectionprompttemplateschema.md create mode 100644 docs/api/llm-ops.reflectionprompttemplateschema.resulttest.md create mode 100644 docs/api/llm-ops.resembeddingtype.md create mode 100644 docs/api/llm-ops.resmessagestype.md create mode 100644 docs/api/llm-ops.resmoderationtype.md create mode 100644 docs/api/llm-ops.result.md create mode 100644 docs/api/llm-ops.structschema.function_call.md create mode 100644 docs/api/llm-ops.structschema.functions.md create mode 100644 docs/api/llm-ops.structschema.md create mode 100644 docs/api/llm-ops.structschema.schema.md create mode 100644 docs/api/llm-ops.structschema.typename.md create mode 100644 docs/api/llm-ops.success.data.md create mode 100644 docs/api/llm-ops.success.md create mode 100644 docs/api/llm-ops.success.success.md create mode 100644 docs/api/llm-ops.teacherevaluateschema.items.md create mode 100644 docs/api/llm-ops.teacherevaluateschema.maxscore.md create mode 100644 docs/api/llm-ops.teacherevaluateschema.md create mode 100644 docs/api/llm-ops.tonestyletype.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.createmoduletextfromjson.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.schema.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.stripnulls.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.typename.md create mode 100644 docs/api/llm-ops.typechatjsonvalidator.validate.md create mode 100644 docs/api/llm-ops.typescriptchain._constructor_.md create mode 100644 docs/api/llm-ops.typescriptchain.attemptrepair.md create mode 100644 docs/api/llm-ops.typescriptchain.call.md create mode 100644 docs/api/llm-ops.typescriptchain.createrepairprompt.md create mode 100644 docs/api/llm-ops.typescriptchain.createrequestprompt.md create mode 100644 docs/api/llm-ops.typescriptchain.exporthistory.md create mode 100644 docs/api/llm-ops.typescriptchain.llm.md create mode 100644 docs/api/llm-ops.typescriptchain.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.bound.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.prompt.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.request.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.schema.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.typename.md create mode 100644 docs/api/llm-ops.typescriptchaincallschema.verbose.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 81532b7..fe07c24 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -19,9 +19,7 @@ export default defineConfig({ "/guide": [ { text: "LLM Ops", - items: [ - { text: "model", link: "/guide/model" }, - ], + items: [{ text: "model", link: "/guide/model" }], }, ], }, diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..6c681d5 --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [llm-ops](./llm-ops.md) | | + diff --git a/docs/api/llm-ops.agentprompttemplate._constructor_.md b/docs/api/llm-ops.agentprompttemplate._constructor_.md new file mode 100644 index 0000000..c691d30 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [(constructor)](./llm-ops.agentprompttemplate._constructor_.md) + +## AgentPromptTemplate.(constructor) + +Constructs a new instance of the `AgentPromptTemplate` class + +**Signature:** + +```typescript +constructor({ role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, }: AgentPromptTemplateSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| { role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, } | [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) | | + diff --git a/docs/api/llm-ops.agentprompttemplate.communicationstyle.md b/docs/api/llm-ops.agentprompttemplate.communicationstyle.md new file mode 100644 index 0000000..4a0d5a9 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.communicationstyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [communicationStyle](./llm-ops.agentprompttemplate.communicationstyle.md) + +## AgentPromptTemplate.communicationStyle property + +**Signature:** + +```typescript +communicationStyle?: communicationStyleType; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.desc.md b/docs/api/llm-ops.agentprompttemplate.desc.md new file mode 100644 index 0000000..06a6cc0 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.desc.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [desc](./llm-ops.agentprompttemplate.desc.md) + +## AgentPromptTemplate.desc property + +**Signature:** + +```typescript +desc?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.evaluate.md b/docs/api/llm-ops.agentprompttemplate.evaluate.md new file mode 100644 index 0000000..5656655 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.evaluate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [evaluate](./llm-ops.agentprompttemplate.evaluate.md) + +## AgentPromptTemplate.evaluate property + +**Signature:** + +```typescript +evaluate?: TeacherEvaluateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.field.md b/docs/api/llm-ops.agentprompttemplate.field.md new file mode 100644 index 0000000..fac2c89 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.field.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [field](./llm-ops.agentprompttemplate.field.md) + +## AgentPromptTemplate.field property + +**Signature:** + +```typescript +field?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.format.md b/docs/api/llm-ops.agentprompttemplate.format.md new file mode 100644 index 0000000..dbc5ec1 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.format.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [format](./llm-ops.agentprompttemplate.format.md) + +## AgentPromptTemplate.format() method + +**Signature:** + +```typescript +format(): messagesType; +``` +**Returns:** + +[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.agentprompttemplate.formatevaluateitem.md b/docs/api/llm-ops.agentprompttemplate.formatevaluateitem.md new file mode 100644 index 0000000..d1a3984 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.formatevaluateitem.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [formatEvaluateItem](./llm-ops.agentprompttemplate.formatevaluateitem.md) + +## AgentPromptTemplate.formatEvaluateItem() method + +**Signature:** + +```typescript +formatEvaluateItem(items: EvaluateItemSchema[]): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| items | [EvaluateItemSchema](./llm-ops.evaluateitemschema.md)\[\] | | + +**Returns:** + +string + diff --git a/docs/api/llm-ops.agentprompttemplate.humansituation.md b/docs/api/llm-ops.agentprompttemplate.humansituation.md new file mode 100644 index 0000000..ef55805 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.humansituation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [humanSituation](./llm-ops.agentprompttemplate.humansituation.md) + +## AgentPromptTemplate.humanSituation property + +**Signature:** + +```typescript +humanSituation?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.keyrole.md b/docs/api/llm-ops.agentprompttemplate.keyrole.md new file mode 100644 index 0000000..18501d1 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.keyrole.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [keyRole](./llm-ops.agentprompttemplate.keyrole.md) + +## AgentPromptTemplate.keyRole property + +**Signature:** + +```typescript +keyRole?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.language.md b/docs/api/llm-ops.agentprompttemplate.language.md new file mode 100644 index 0000000..3b739ca --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.language.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [language](./llm-ops.agentprompttemplate.language.md) + +## AgentPromptTemplate.language property + +**Signature:** + +```typescript +language?: languageType; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.level.md b/docs/api/llm-ops.agentprompttemplate.level.md new file mode 100644 index 0000000..f301d98 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.level.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [level](./llm-ops.agentprompttemplate.level.md) + +## AgentPromptTemplate.level property + +**Signature:** + +```typescript +level?: levelType; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.md b/docs/api/llm-ops.agentprompttemplate.md new file mode 100644 index 0000000..2f9b68a --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) + +## AgentPromptTemplate class + +**Signature:** + +```typescript +export declare class AgentPromptTemplate extends BasePromptTemplate +``` +**Extends:** [BasePromptTemplate](./llm-ops.baseprompttemplate.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)({ role, desc, toneStyle, communicationStyle, level, field, keyRole, reasoning, rules, reflection, memory, humanSituation, language, other, evaluate, })](./llm-ops.agentprompttemplate._constructor_.md) | | Constructs a new instance of the AgentPromptTemplate class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [communicationStyle?](./llm-ops.agentprompttemplate.communicationstyle.md) | | [communicationStyleType](./llm-ops.communicationstyletype.md) | _(Optional)_ | +| [desc?](./llm-ops.agentprompttemplate.desc.md) | | string | _(Optional)_ | +| [evaluate?](./llm-ops.agentprompttemplate.evaluate.md) | | [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | _(Optional)_ | +| [field?](./llm-ops.agentprompttemplate.field.md) | | string | _(Optional)_ | +| [humanSituation?](./llm-ops.agentprompttemplate.humansituation.md) | | string | _(Optional)_ | +| [keyRole?](./llm-ops.agentprompttemplate.keyrole.md) | | string | _(Optional)_ | +| [language?](./llm-ops.agentprompttemplate.language.md) | | [languageType](./llm-ops.languagetype.md) | _(Optional)_ | +| [level?](./llm-ops.agentprompttemplate.level.md) | | [levelType](./llm-ops.leveltype.md) | _(Optional)_ | +| [memory?](./llm-ops.agentprompttemplate.memory.md) | | [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | _(Optional)_ | +| [other?](./llm-ops.agentprompttemplate.other.md) | | string | _(Optional)_ | +| [reasoning?](./llm-ops.agentprompttemplate.reasoning.md) | | [reasoningType](./llm-ops.reasoningtype.md) | _(Optional)_ | +| [reflection?](./llm-ops.agentprompttemplate.reflection.md) | | [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | _(Optional)_ | +| [returnPrompt?](./llm-ops.agentprompttemplate.returnprompt.md) | | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ | +| [role?](./llm-ops.agentprompttemplate.role.md) | | string | _(Optional)_ | +| [rules?](./llm-ops.agentprompttemplate.rules.md) | | string \| string\[\] | _(Optional)_ | +| [toneStyle?](./llm-ops.agentprompttemplate.tonestyle.md) | | [toneStyleType](./llm-ops.tonestyletype.md) | _(Optional)_ | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [format()](./llm-ops.agentprompttemplate.format.md) | | | +| [formatEvaluateItem(items)](./llm-ops.agentprompttemplate.formatevaluateitem.md) | | | + diff --git a/docs/api/llm-ops.agentprompttemplate.memory.md b/docs/api/llm-ops.agentprompttemplate.memory.md new file mode 100644 index 0000000..e8a5674 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.memory.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [memory](./llm-ops.agentprompttemplate.memory.md) + +## AgentPromptTemplate.memory property + +**Signature:** + +```typescript +memory?: MemoryPromptTemplateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.other.md b/docs/api/llm-ops.agentprompttemplate.other.md new file mode 100644 index 0000000..8585fa7 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.other.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [other](./llm-ops.agentprompttemplate.other.md) + +## AgentPromptTemplate.other property + +**Signature:** + +```typescript +other?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.reasoning.md b/docs/api/llm-ops.agentprompttemplate.reasoning.md new file mode 100644 index 0000000..df34e21 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.reasoning.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [reasoning](./llm-ops.agentprompttemplate.reasoning.md) + +## AgentPromptTemplate.reasoning property + +**Signature:** + +```typescript +reasoning?: reasoningType; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.reflection.md b/docs/api/llm-ops.agentprompttemplate.reflection.md new file mode 100644 index 0000000..d6c8bc1 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.reflection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [reflection](./llm-ops.agentprompttemplate.reflection.md) + +## AgentPromptTemplate.reflection property + +**Signature:** + +```typescript +reflection?: ReflectionPromptTemplateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.returnprompt.md b/docs/api/llm-ops.agentprompttemplate.returnprompt.md new file mode 100644 index 0000000..af719f0 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.returnprompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [returnPrompt](./llm-ops.agentprompttemplate.returnprompt.md) + +## AgentPromptTemplate.returnPrompt property + +**Signature:** + +```typescript +returnPrompt?: messagesType; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.role.md b/docs/api/llm-ops.agentprompttemplate.role.md new file mode 100644 index 0000000..4073415 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.role.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [role](./llm-ops.agentprompttemplate.role.md) + +## AgentPromptTemplate.role property + +**Signature:** + +```typescript +role?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.rules.md b/docs/api/llm-ops.agentprompttemplate.rules.md new file mode 100644 index 0000000..f7bd798 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.rules.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [rules](./llm-ops.agentprompttemplate.rules.md) + +## AgentPromptTemplate.rules property + +**Signature:** + +```typescript +rules?: string | string[]; +``` diff --git a/docs/api/llm-ops.agentprompttemplate.tonestyle.md b/docs/api/llm-ops.agentprompttemplate.tonestyle.md new file mode 100644 index 0000000..b82f17b --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplate.tonestyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) > [toneStyle](./llm-ops.agentprompttemplate.tonestyle.md) + +## AgentPromptTemplate.toneStyle property + +**Signature:** + +```typescript +toneStyle?: toneStyleType; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md b/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md new file mode 100644 index 0000000..7bbc632 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.communicationstyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [communicationStyle](./llm-ops.agentprompttemplateschema.communicationstyle.md) + +## AgentPromptTemplateSchema.communicationStyle property + +**Signature:** + +```typescript +communicationStyle?: communicationStyleType; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.desc.md b/docs/api/llm-ops.agentprompttemplateschema.desc.md new file mode 100644 index 0000000..91815b1 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.desc.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [desc](./llm-ops.agentprompttemplateschema.desc.md) + +## AgentPromptTemplateSchema.desc property + +**Signature:** + +```typescript +desc?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.evaluate.md b/docs/api/llm-ops.agentprompttemplateschema.evaluate.md new file mode 100644 index 0000000..71f23e2 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.evaluate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [evaluate](./llm-ops.agentprompttemplateschema.evaluate.md) + +## AgentPromptTemplateSchema.evaluate property + +**Signature:** + +```typescript +evaluate?: TeacherEvaluateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.field.md b/docs/api/llm-ops.agentprompttemplateschema.field.md new file mode 100644 index 0000000..03b7ff1 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.field.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [field](./llm-ops.agentprompttemplateschema.field.md) + +## AgentPromptTemplateSchema.field property + +**Signature:** + +```typescript +field?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.humansituation.md b/docs/api/llm-ops.agentprompttemplateschema.humansituation.md new file mode 100644 index 0000000..f6d01a0 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.humansituation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [humanSituation](./llm-ops.agentprompttemplateschema.humansituation.md) + +## AgentPromptTemplateSchema.humanSituation property + +**Signature:** + +```typescript +humanSituation?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.keyrole.md b/docs/api/llm-ops.agentprompttemplateschema.keyrole.md new file mode 100644 index 0000000..acead91 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.keyrole.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [keyRole](./llm-ops.agentprompttemplateschema.keyrole.md) + +## AgentPromptTemplateSchema.keyRole property + +**Signature:** + +```typescript +keyRole?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.language.md b/docs/api/llm-ops.agentprompttemplateschema.language.md new file mode 100644 index 0000000..64dded2 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.language.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [language](./llm-ops.agentprompttemplateschema.language.md) + +## AgentPromptTemplateSchema.language property + +**Signature:** + +```typescript +language?: languageType; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.level.md b/docs/api/llm-ops.agentprompttemplateschema.level.md new file mode 100644 index 0000000..7e03acf --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.level.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [level](./llm-ops.agentprompttemplateschema.level.md) + +## AgentPromptTemplateSchema.level property + +**Signature:** + +```typescript +level?: levelType; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.md b/docs/api/llm-ops.agentprompttemplateschema.md new file mode 100644 index 0000000..1968d18 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) + +## AgentPromptTemplateSchema interface + +**Signature:** + +```typescript +export interface AgentPromptTemplateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [communicationStyle?](./llm-ops.agentprompttemplateschema.communicationstyle.md) | | [communicationStyleType](./llm-ops.communicationstyletype.md) | _(Optional)_ | +| [desc?](./llm-ops.agentprompttemplateschema.desc.md) | | string | _(Optional)_ | +| [evaluate?](./llm-ops.agentprompttemplateschema.evaluate.md) | | [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | _(Optional)_ | +| [field?](./llm-ops.agentprompttemplateschema.field.md) | | string | _(Optional)_ | +| [humanSituation?](./llm-ops.agentprompttemplateschema.humansituation.md) | | string | _(Optional)_ | +| [keyRole?](./llm-ops.agentprompttemplateschema.keyrole.md) | | string | _(Optional)_ | +| [language?](./llm-ops.agentprompttemplateschema.language.md) | | [languageType](./llm-ops.languagetype.md) | _(Optional)_ | +| [level?](./llm-ops.agentprompttemplateschema.level.md) | | [levelType](./llm-ops.leveltype.md) | _(Optional)_ | +| [memory?](./llm-ops.agentprompttemplateschema.memory.md) | | [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | _(Optional)_ | +| [other?](./llm-ops.agentprompttemplateschema.other.md) | | string | _(Optional)_ | +| [reasoning?](./llm-ops.agentprompttemplateschema.reasoning.md) | | [reasoningType](./llm-ops.reasoningtype.md) | _(Optional)_ | +| [reflection?](./llm-ops.agentprompttemplateschema.reflection.md) | | [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | _(Optional)_ | +| [role](./llm-ops.agentprompttemplateschema.role.md) | | string | | +| [rules?](./llm-ops.agentprompttemplateschema.rules.md) | | string \| string\[\] | _(Optional)_ | +| [toneStyle?](./llm-ops.agentprompttemplateschema.tonestyle.md) | | [toneStyleType](./llm-ops.tonestyletype.md) | _(Optional)_ | + diff --git a/docs/api/llm-ops.agentprompttemplateschema.memory.md b/docs/api/llm-ops.agentprompttemplateschema.memory.md new file mode 100644 index 0000000..6bc1459 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.memory.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [memory](./llm-ops.agentprompttemplateschema.memory.md) + +## AgentPromptTemplateSchema.memory property + +**Signature:** + +```typescript +memory?: MemoryPromptTemplateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.other.md b/docs/api/llm-ops.agentprompttemplateschema.other.md new file mode 100644 index 0000000..8d9e703 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.other.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [other](./llm-ops.agentprompttemplateschema.other.md) + +## AgentPromptTemplateSchema.other property + +**Signature:** + +```typescript +other?: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.reasoning.md b/docs/api/llm-ops.agentprompttemplateschema.reasoning.md new file mode 100644 index 0000000..8ee11d6 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.reasoning.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [reasoning](./llm-ops.agentprompttemplateschema.reasoning.md) + +## AgentPromptTemplateSchema.reasoning property + +**Signature:** + +```typescript +reasoning?: reasoningType; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.reflection.md b/docs/api/llm-ops.agentprompttemplateschema.reflection.md new file mode 100644 index 0000000..def6a85 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.reflection.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [reflection](./llm-ops.agentprompttemplateschema.reflection.md) + +## AgentPromptTemplateSchema.reflection property + +**Signature:** + +```typescript +reflection?: ReflectionPromptTemplateSchema; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.role.md b/docs/api/llm-ops.agentprompttemplateschema.role.md new file mode 100644 index 0000000..85e85ff --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.role.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [role](./llm-ops.agentprompttemplateschema.role.md) + +## AgentPromptTemplateSchema.role property + +**Signature:** + +```typescript +role: string; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.rules.md b/docs/api/llm-ops.agentprompttemplateschema.rules.md new file mode 100644 index 0000000..27f3027 --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.rules.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [rules](./llm-ops.agentprompttemplateschema.rules.md) + +## AgentPromptTemplateSchema.rules property + +**Signature:** + +```typescript +rules?: string | string[]; +``` diff --git a/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md b/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md new file mode 100644 index 0000000..38620bb --- /dev/null +++ b/docs/api/llm-ops.agentprompttemplateschema.tonestyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) > [toneStyle](./llm-ops.agentprompttemplateschema.tonestyle.md) + +## AgentPromptTemplateSchema.toneStyle property + +**Signature:** + +```typescript +toneStyle?: toneStyleType; +``` diff --git a/docs/api/llm-ops.baseagent._constructor_.md b/docs/api/llm-ops.baseagent._constructor_.md new file mode 100644 index 0000000..9bfda74 --- /dev/null +++ b/docs/api/llm-ops.baseagent._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [(constructor)](./llm-ops.baseagent._constructor_.md) + +## BaseAgent.(constructor) + +Constructs a new instance of the `BaseAgent` class + +**Signature:** + +```typescript +constructor(params: chainSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [chainSchema](./llm-ops.chainschema.md) | | + diff --git a/docs/api/llm-ops.baseagent.call.md b/docs/api/llm-ops.baseagent.call.md new file mode 100644 index 0000000..a4005a3 --- /dev/null +++ b/docs/api/llm-ops.baseagent.call.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [call](./llm-ops.baseagent.call.md) + +## BaseAgent.call() method + +**Signature:** + +```typescript +call(params: BaseAgentCallSchema): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) | | + +**Returns:** + +Promise<[Result](./llm-ops.result.md)<any>> + diff --git a/docs/api/llm-ops.baseagent.chain.md b/docs/api/llm-ops.baseagent.chain.md new file mode 100644 index 0000000..e5a68ae --- /dev/null +++ b/docs/api/llm-ops.baseagent.chain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [chain](./llm-ops.baseagent.chain.md) + +## BaseAgent.chain property + +**Signature:** + +```typescript +chain?: Chain; +``` diff --git a/docs/api/llm-ops.baseagent.md b/docs/api/llm-ops.baseagent.md new file mode 100644 index 0000000..6fe43e8 --- /dev/null +++ b/docs/api/llm-ops.baseagent.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) + +## BaseAgent class + +**Signature:** + +```typescript +export declare class BaseAgent +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(params)](./llm-ops.baseagent._constructor_.md) | | Constructs a new instance of the BaseAgent class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [chain?](./llm-ops.baseagent.chain.md) | | [Chain](./llm-ops.chain.md) | _(Optional)_ | +| [prompt?](./llm-ops.baseagent.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [call(params)](./llm-ops.baseagent.call.md) | | | + diff --git a/docs/api/llm-ops.baseagent.prompt.md b/docs/api/llm-ops.baseagent.prompt.md new file mode 100644 index 0000000..1957dc4 --- /dev/null +++ b/docs/api/llm-ops.baseagent.prompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgent](./llm-ops.baseagent.md) > [prompt](./llm-ops.baseagent.prompt.md) + +## BaseAgent.prompt property + +**Signature:** + +```typescript +prompt?: messageType[]; +``` diff --git a/docs/api/llm-ops.baseagentcallschema.md b/docs/api/llm-ops.baseagentcallschema.md new file mode 100644 index 0000000..6a9288e --- /dev/null +++ b/docs/api/llm-ops.baseagentcallschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) + +## BaseAgentCallSchema interface + +**Signature:** + +```typescript +export interface BaseAgentCallSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [prompts?](./llm-ops.baseagentcallschema.prompts.md) | | [PromptsSchema](./llm-ops.promptsschema.md) | _(Optional)_ | +| [request](./llm-ops.baseagentcallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | | +| [struct?](./llm-ops.baseagentcallschema.struct.md) | | [structSchema](./llm-ops.structschema.md) | _(Optional)_ | + diff --git a/docs/api/llm-ops.baseagentcallschema.prompts.md b/docs/api/llm-ops.baseagentcallschema.prompts.md new file mode 100644 index 0000000..96fd5c0 --- /dev/null +++ b/docs/api/llm-ops.baseagentcallschema.prompts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [prompts](./llm-ops.baseagentcallschema.prompts.md) + +## BaseAgentCallSchema.prompts property + +**Signature:** + +```typescript +prompts?: PromptsSchema; +``` diff --git a/docs/api/llm-ops.baseagentcallschema.request.md b/docs/api/llm-ops.baseagentcallschema.request.md new file mode 100644 index 0000000..6d1807a --- /dev/null +++ b/docs/api/llm-ops.baseagentcallschema.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [request](./llm-ops.baseagentcallschema.request.md) + +## BaseAgentCallSchema.request property + +**Signature:** + +```typescript +request: messageType | string; +``` diff --git a/docs/api/llm-ops.baseagentcallschema.struct.md b/docs/api/llm-ops.baseagentcallschema.struct.md new file mode 100644 index 0000000..84af17c --- /dev/null +++ b/docs/api/llm-ops.baseagentcallschema.struct.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) > [struct](./llm-ops.baseagentcallschema.struct.md) + +## BaseAgentCallSchema.struct property + +**Signature:** + +```typescript +struct?: structSchema; +``` diff --git a/docs/api/llm-ops.baseprompttemplate.format.md b/docs/api/llm-ops.baseprompttemplate.format.md new file mode 100644 index 0000000..420fc1d --- /dev/null +++ b/docs/api/llm-ops.baseprompttemplate.format.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BasePromptTemplate](./llm-ops.baseprompttemplate.md) > [format](./llm-ops.baseprompttemplate.format.md) + +## BasePromptTemplate.format() method + +**Signature:** + +```typescript +abstract format(): messagesType; +``` +**Returns:** + +[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.baseprompttemplate.md b/docs/api/llm-ops.baseprompttemplate.md new file mode 100644 index 0000000..caf09f9 --- /dev/null +++ b/docs/api/llm-ops.baseprompttemplate.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [BasePromptTemplate](./llm-ops.baseprompttemplate.md) + +## BasePromptTemplate class + +**Signature:** + +```typescript +export declare abstract class BasePromptTemplate +``` + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [format()](./llm-ops.baseprompttemplate.format.md) | abstract | | + diff --git a/docs/api/llm-ops.chain._constructor_.md b/docs/api/llm-ops.chain._constructor_.md new file mode 100644 index 0000000..76e8e60 --- /dev/null +++ b/docs/api/llm-ops.chain._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [(constructor)](./llm-ops.chain._constructor_.md) + +## Chain.(constructor) + +Constructs a new instance of the `Chain` class + +**Signature:** + +```typescript +constructor(params: chainSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [chainSchema](./llm-ops.chainschema.md) | | + diff --git a/docs/api/llm-ops.chain.call.md b/docs/api/llm-ops.chain.call.md new file mode 100644 index 0000000..f39731f --- /dev/null +++ b/docs/api/llm-ops.chain.call.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [call](./llm-ops.chain.call.md) + +## Chain.call() method + +**Signature:** + +```typescript +call(params: chainCallSchema): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [chainCallSchema](./llm-ops.chaincallschema.md) | | + +**Returns:** + +Promise<import("llm-ops/utils").[Result](./llm-ops.result.md)<any>> + diff --git a/docs/api/llm-ops.chain.chain.md b/docs/api/llm-ops.chain.chain.md new file mode 100644 index 0000000..ccf1c4e --- /dev/null +++ b/docs/api/llm-ops.chain.chain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [chain](./llm-ops.chain.chain.md) + +## Chain.chain property + +**Signature:** + +```typescript +chain: FunctionChain | TypeScriptChain; +``` diff --git a/docs/api/llm-ops.chain.chainname.md b/docs/api/llm-ops.chain.chainname.md new file mode 100644 index 0000000..da5a1b1 --- /dev/null +++ b/docs/api/llm-ops.chain.chainname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [chainName](./llm-ops.chain.chainname.md) + +## Chain.chainName property + +**Signature:** + +```typescript +chainName?: string; +``` diff --git a/docs/api/llm-ops.chain.exporthistory.md b/docs/api/llm-ops.chain.exporthistory.md new file mode 100644 index 0000000..f8f9a4a --- /dev/null +++ b/docs/api/llm-ops.chain.exporthistory.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [exportHistory](./llm-ops.chain.exporthistory.md) + +## Chain.exportHistory() method + +**Signature:** + +```typescript +exportHistory(): import("llm-ops/llm/index").messagesType; +``` +**Returns:** + +import("llm-ops/llm/index").[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.chain.llm.md b/docs/api/llm-ops.chain.llm.md new file mode 100644 index 0000000..da1e04a --- /dev/null +++ b/docs/api/llm-ops.chain.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) > [llm](./llm-ops.chain.llm.md) + +## Chain.llm property + +**Signature:** + +```typescript +llm: LLM; +``` diff --git a/docs/api/llm-ops.chain.md b/docs/api/llm-ops.chain.md new file mode 100644 index 0000000..92faa19 --- /dev/null +++ b/docs/api/llm-ops.chain.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Chain](./llm-ops.chain.md) + +## Chain class + +**Signature:** + +```typescript +export declare class Chain +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(params)](./llm-ops.chain._constructor_.md) | | Constructs a new instance of the Chain class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [chain](./llm-ops.chain.chain.md) | | [FunctionChain](./llm-ops.functionchain.md) \| [TypeScriptChain](./llm-ops.typescriptchain.md) | | +| [chainName?](./llm-ops.chain.chainname.md) | | string | _(Optional)_ | +| [llm](./llm-ops.chain.llm.md) | | [LLM](./llm-ops.llm.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [call(params)](./llm-ops.chain.call.md) | | | +| [exportHistory()](./llm-ops.chain.exporthistory.md) | | | + diff --git a/docs/api/llm-ops.chaincallschema.md b/docs/api/llm-ops.chaincallschema.md new file mode 100644 index 0000000..0557c3d --- /dev/null +++ b/docs/api/llm-ops.chaincallschema.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) + +## chainCallSchema interface + +**Signature:** + +```typescript +export interface chainCallSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [prompt?](./llm-ops.chaincallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ | +| [request](./llm-ops.chaincallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | | +| [struct?](./llm-ops.chaincallschema.struct.md) | | [structSchema](./llm-ops.structschema.md) | _(Optional)_ | +| [verbose?](./llm-ops.chaincallschema.verbose.md) | | boolean | _(Optional)_ | + diff --git a/docs/api/llm-ops.chaincallschema.prompt.md b/docs/api/llm-ops.chaincallschema.prompt.md new file mode 100644 index 0000000..7f69df8 --- /dev/null +++ b/docs/api/llm-ops.chaincallschema.prompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [prompt](./llm-ops.chaincallschema.prompt.md) + +## chainCallSchema.prompt property + +**Signature:** + +```typescript +prompt?: messageType[]; +``` diff --git a/docs/api/llm-ops.chaincallschema.request.md b/docs/api/llm-ops.chaincallschema.request.md new file mode 100644 index 0000000..3c28b8c --- /dev/null +++ b/docs/api/llm-ops.chaincallschema.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [request](./llm-ops.chaincallschema.request.md) + +## chainCallSchema.request property + +**Signature:** + +```typescript +request: messageType | string; +``` diff --git a/docs/api/llm-ops.chaincallschema.struct.md b/docs/api/llm-ops.chaincallschema.struct.md new file mode 100644 index 0000000..5171bdc --- /dev/null +++ b/docs/api/llm-ops.chaincallschema.struct.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [struct](./llm-ops.chaincallschema.struct.md) + +## chainCallSchema.struct property + +**Signature:** + +```typescript +struct?: structSchema; +``` diff --git a/docs/api/llm-ops.chaincallschema.verbose.md b/docs/api/llm-ops.chaincallschema.verbose.md new file mode 100644 index 0000000..8f57dd1 --- /dev/null +++ b/docs/api/llm-ops.chaincallschema.verbose.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainCallSchema](./llm-ops.chaincallschema.md) > [verbose](./llm-ops.chaincallschema.verbose.md) + +## chainCallSchema.verbose property + +**Signature:** + +```typescript +verbose?: boolean; +``` diff --git a/docs/api/llm-ops.chainschema.chainname.md b/docs/api/llm-ops.chainschema.chainname.md new file mode 100644 index 0000000..e642bb2 --- /dev/null +++ b/docs/api/llm-ops.chainschema.chainname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [chainName](./llm-ops.chainschema.chainname.md) + +## chainSchema.chainName property + +**Signature:** + +```typescript +chainName?: string; +``` diff --git a/docs/api/llm-ops.chainschema.llm.md b/docs/api/llm-ops.chainschema.llm.md new file mode 100644 index 0000000..f49bb32 --- /dev/null +++ b/docs/api/llm-ops.chainschema.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [llm](./llm-ops.chainschema.llm.md) + +## chainSchema.llm property + +**Signature:** + +```typescript +llm?: LLM; +``` diff --git a/docs/api/llm-ops.chainschema.llmschema.md b/docs/api/llm-ops.chainschema.llmschema.md new file mode 100644 index 0000000..94a4d6f --- /dev/null +++ b/docs/api/llm-ops.chainschema.llmschema.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) > [llmSchema](./llm-ops.chainschema.llmschema.md) + +## chainSchema.llmSchema property + +**Signature:** + +```typescript +llmSchema?: createLLMSchema; +``` diff --git a/docs/api/llm-ops.chainschema.md b/docs/api/llm-ops.chainschema.md new file mode 100644 index 0000000..9d46620 --- /dev/null +++ b/docs/api/llm-ops.chainschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chainSchema](./llm-ops.chainschema.md) + +## chainSchema interface + +**Signature:** + +```typescript +export interface chainSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [chainName?](./llm-ops.chainschema.chainname.md) | | string | _(Optional)_ | +| [llm?](./llm-ops.chainschema.llm.md) | | [LLM](./llm-ops.llm.md) | _(Optional)_ | +| [llmSchema?](./llm-ops.chainschema.llmschema.md) | | [createLLMSchema](./llm-ops.createllmschema.md) | _(Optional)_ | + diff --git a/docs/api/llm-ops.chatcompletiontype.md b/docs/api/llm-ops.chatcompletiontype.md new file mode 100644 index 0000000..27f9b00 --- /dev/null +++ b/docs/api/llm-ops.chatcompletiontype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chatCompletionType](./llm-ops.chatcompletiontype.md) + +## chatCompletionType type + +**Signature:** + +```typescript +export type chatCompletionType = OpenAI.Chat.Completions.ChatCompletion; +``` diff --git a/docs/api/llm-ops.chatparamstype.md b/docs/api/llm-ops.chatparamstype.md new file mode 100644 index 0000000..b05c0ea --- /dev/null +++ b/docs/api/llm-ops.chatparamstype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [chatParamsType](./llm-ops.chatparamstype.md) + +## chatParamsType type + +**Signature:** + +```typescript +export type chatParamsType = OpenAI.Chat.CompletionCreateParams; +``` diff --git a/docs/api/llm-ops.chatschema.function_call.md b/docs/api/llm-ops.chatschema.function_call.md new file mode 100644 index 0000000..6dd820b --- /dev/null +++ b/docs/api/llm-ops.chatschema.function_call.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [function\_call](./llm-ops.chatschema.function_call.md) + +## ChatSchema.function\_call property + +**Signature:** + +```typescript +function_call?: function_callType; +``` diff --git a/docs/api/llm-ops.chatschema.functions.md b/docs/api/llm-ops.chatschema.functions.md new file mode 100644 index 0000000..8ee819b --- /dev/null +++ b/docs/api/llm-ops.chatschema.functions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [functions](./llm-ops.chatschema.functions.md) + +## ChatSchema.functions property + +**Signature:** + +```typescript +functions?: functionsType; +``` diff --git a/docs/api/llm-ops.chatschema.md b/docs/api/llm-ops.chatschema.md new file mode 100644 index 0000000..5a29158 --- /dev/null +++ b/docs/api/llm-ops.chatschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) + +## ChatSchema interface + +**Signature:** + +```typescript +export interface ChatSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [function\_call?](./llm-ops.chatschema.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ | +| [functions?](./llm-ops.chatschema.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ | +| [messages](./llm-ops.chatschema.messages.md) | | [messagesType](./llm-ops.messagestype.md) | | + diff --git a/docs/api/llm-ops.chatschema.messages.md b/docs/api/llm-ops.chatschema.messages.md new file mode 100644 index 0000000..256ac5b --- /dev/null +++ b/docs/api/llm-ops.chatschema.messages.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ChatSchema](./llm-ops.chatschema.md) > [messages](./llm-ops.chatschema.messages.md) + +## ChatSchema.messages property + +**Signature:** + +```typescript +messages: messagesType; +``` diff --git a/docs/api/llm-ops.communicationstyletype.md b/docs/api/llm-ops.communicationstyletype.md new file mode 100644 index 0000000..6ec45f7 --- /dev/null +++ b/docs/api/llm-ops.communicationstyletype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [communicationStyleType](./llm-ops.communicationstyletype.md) + +## communicationStyleType type + +**Signature:** + +```typescript +export type communicationStyleType = "Formal" | "Textbook" | "Layman" | "Story Telling" | "Socratic"; +``` diff --git a/docs/api/llm-ops.createjsonvalidator.md b/docs/api/llm-ops.createjsonvalidator.md new file mode 100644 index 0000000..f4ecc63 --- /dev/null +++ b/docs/api/llm-ops.createjsonvalidator.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createJsonValidator](./llm-ops.createjsonvalidator.md) + +## createJsonValidator() function + +Returns a JSON validator for a given TypeScript schema. Validation is performed by an in-memory instance of the TypeScript compiler. The specified type argument `T` must be the same type as `typeName` in the given `schema`. + +**Signature:** + +```typescript +export declare function createJsonValidator(schema: string, typeName: string): TypeChatJsonValidator; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| schema | string | A string containing the TypeScript source code for the JSON schema. | +| typeName | string | The name of the JSON target type in the schema. | + +**Returns:** + +[TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md)<T> + +A `TypeChatJsonValidator` instance. + diff --git a/docs/api/llm-ops.createllmschema.cache.md b/docs/api/llm-ops.createllmschema.cache.md new file mode 100644 index 0000000..06f50dd --- /dev/null +++ b/docs/api/llm-ops.createllmschema.cache.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [cache](./llm-ops.createllmschema.cache.md) + +## createLLMSchema.cache property + +**Signature:** + +```typescript +cache?: boolean; +``` diff --git a/docs/api/llm-ops.createllmschema.choice_num.md b/docs/api/llm-ops.createllmschema.choice_num.md new file mode 100644 index 0000000..6d2db58 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.choice_num.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [choice\_num](./llm-ops.createllmschema.choice_num.md) + +## createLLMSchema.choice\_num property + +**Signature:** + +```typescript +choice_num?: number | 1; +``` diff --git a/docs/api/llm-ops.createllmschema.helicone_auth_api_key.md b/docs/api/llm-ops.createllmschema.helicone_auth_api_key.md new file mode 100644 index 0000000..f5b9db1 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.helicone_auth_api_key.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [HELICONE\_AUTH\_API\_KEY](./llm-ops.createllmschema.helicone_auth_api_key.md) + +## createLLMSchema.HELICONE\_AUTH\_API\_KEY property + +**Signature:** + +```typescript +HELICONE_AUTH_API_KEY?: string; +``` diff --git a/docs/api/llm-ops.createllmschema.history.md b/docs/api/llm-ops.createllmschema.history.md new file mode 100644 index 0000000..ba1231c --- /dev/null +++ b/docs/api/llm-ops.createllmschema.history.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [history](./llm-ops.createllmschema.history.md) + +## createLLMSchema.history property + +**Signature:** + +```typescript +history?: messagesType; +``` diff --git a/docs/api/llm-ops.createllmschema.md b/docs/api/llm-ops.createllmschema.md new file mode 100644 index 0000000..5e98d68 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) + +## createLLMSchema interface + +**Signature:** + +```typescript +export interface createLLMSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cache?](./llm-ops.createllmschema.cache.md) | | boolean | _(Optional)_ | +| [choice\_num?](./llm-ops.createllmschema.choice_num.md) | | number \| 1 | _(Optional)_ | +| [HELICONE\_AUTH\_API\_KEY?](./llm-ops.createllmschema.helicone_auth_api_key.md) | | string | _(Optional)_ | +| [history?](./llm-ops.createllmschema.history.md) | | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ | +| [modelName?](./llm-ops.createllmschema.modelname.md) | | (string & object) \| "gpt-4" \| "gpt-4-0314" \| "gpt-4-0613" \| "gpt-4-32k" \| "gpt-4-32k-0314" \| "gpt-4-32k-0613" \| "gpt-3.5-turbo" \| "gpt-3.5-turbo-16k" \| "gpt-3.5-turbo-0301" \| "gpt-3.5-turbo-0613" \| "gpt-3.5-turbo-16k-0613" | _(Optional)_ | +| [OPENAI\_API\_KEY?](./llm-ops.createllmschema.openai_api_key.md) | | string | _(Optional)_ | +| [stop?](./llm-ops.createllmschema.stop.md) | | string \| null \| string\[\] | _(Optional)_ | +| [temperature?](./llm-ops.createllmschema.temperature.md) | | number | _(Optional)_ | +| [tokens?](./llm-ops.createllmschema.tokens.md) | | number | _(Optional)_ | +| [user?](./llm-ops.createllmschema.user.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.createllmschema.modelname.md b/docs/api/llm-ops.createllmschema.modelname.md new file mode 100644 index 0000000..9c02751 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.modelname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [modelName](./llm-ops.createllmschema.modelname.md) + +## createLLMSchema.modelName property + +**Signature:** + +```typescript +modelName?: (string & object) | "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k-0613"; +``` diff --git a/docs/api/llm-ops.createllmschema.openai_api_key.md b/docs/api/llm-ops.createllmschema.openai_api_key.md new file mode 100644 index 0000000..9a4be9c --- /dev/null +++ b/docs/api/llm-ops.createllmschema.openai_api_key.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [OPENAI\_API\_KEY](./llm-ops.createllmschema.openai_api_key.md) + +## createLLMSchema.OPENAI\_API\_KEY property + +**Signature:** + +```typescript +OPENAI_API_KEY?: string; +``` diff --git a/docs/api/llm-ops.createllmschema.stop.md b/docs/api/llm-ops.createllmschema.stop.md new file mode 100644 index 0000000..9cc5c43 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.stop.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [stop](./llm-ops.createllmschema.stop.md) + +## createLLMSchema.stop property + +**Signature:** + +```typescript +stop?: string | null | string[]; +``` diff --git a/docs/api/llm-ops.createllmschema.temperature.md b/docs/api/llm-ops.createllmschema.temperature.md new file mode 100644 index 0000000..f0d0b7f --- /dev/null +++ b/docs/api/llm-ops.createllmschema.temperature.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [temperature](./llm-ops.createllmschema.temperature.md) + +## createLLMSchema.temperature property + +**Signature:** + +```typescript +temperature?: number; +``` diff --git a/docs/api/llm-ops.createllmschema.tokens.md b/docs/api/llm-ops.createllmschema.tokens.md new file mode 100644 index 0000000..c69cacd --- /dev/null +++ b/docs/api/llm-ops.createllmschema.tokens.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [tokens](./llm-ops.createllmschema.tokens.md) + +## createLLMSchema.tokens property + +**Signature:** + +```typescript +tokens?: number; +``` diff --git a/docs/api/llm-ops.createllmschema.user.md b/docs/api/llm-ops.createllmschema.user.md new file mode 100644 index 0000000..c46ba09 --- /dev/null +++ b/docs/api/llm-ops.createllmschema.user.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createLLMSchema](./llm-ops.createllmschema.md) > [user](./llm-ops.createllmschema.user.md) + +## createLLMSchema.user property + +**Signature:** + +```typescript +user?: string; +``` diff --git a/docs/api/llm-ops.createmessage.md b/docs/api/llm-ops.createmessage.md new file mode 100644 index 0000000..0ceffda --- /dev/null +++ b/docs/api/llm-ops.createmessage.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessage](./llm-ops.createmessage.md) + +## createMessage() function + +**Signature:** + +```typescript +export declare function createMessage(params: createMessageSchema): messageType; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [createMessageSchema](./llm-ops.createmessageschema.md) | | + +**Returns:** + +[messageType](./llm-ops.messagetype.md) + diff --git a/docs/api/llm-ops.createmessageschema.content.md b/docs/api/llm-ops.createmessageschema.content.md new file mode 100644 index 0000000..1370e73 --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.content.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) > [content](./llm-ops.createmessageschema.content.md) + +## createMessageSchema.content property + +**Signature:** + +```typescript +content: string; +``` diff --git a/docs/api/llm-ops.createmessageschema.contentslots.md b/docs/api/llm-ops.createmessageschema.contentslots.md new file mode 100644 index 0000000..ecea677 --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.contentslots.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) > [contentSlots](./llm-ops.createmessageschema.contentslots.md) + +## createMessageSchema.contentSlots property + +**Signature:** + +```typescript +contentSlots?: Record; +``` diff --git a/docs/api/llm-ops.createmessageschema.function_call.md b/docs/api/llm-ops.createmessageschema.function_call.md new file mode 100644 index 0000000..23ae43e --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.function_call.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) > [function\_call](./llm-ops.createmessageschema.function_call.md) + +## createMessageSchema.function\_call property + +**Signature:** + +```typescript +function_call?: messageFunctionCallType; +``` diff --git a/docs/api/llm-ops.createmessageschema.md b/docs/api/llm-ops.createmessageschema.md new file mode 100644 index 0000000..dbb8559 --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) + +## createMessageSchema interface + +**Signature:** + +```typescript +export interface createMessageSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [content](./llm-ops.createmessageschema.content.md) | | string | | +| [contentSlots?](./llm-ops.createmessageschema.contentslots.md) | | Record<string, any> | _(Optional)_ | +| [function\_call?](./llm-ops.createmessageschema.function_call.md) | | [messageFunctionCallType](./llm-ops.messagefunctioncalltype.md) | _(Optional)_ | +| [name?](./llm-ops.createmessageschema.name.md) | | string | _(Optional)_ | +| [role?](./llm-ops.createmessageschema.role.md) | | "system" \| "user" \| "assistant" \| "function" | _(Optional)_ | + diff --git a/docs/api/llm-ops.createmessageschema.name.md b/docs/api/llm-ops.createmessageschema.name.md new file mode 100644 index 0000000..94db13e --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) > [name](./llm-ops.createmessageschema.name.md) + +## createMessageSchema.name property + +**Signature:** + +```typescript +name?: string; +``` diff --git a/docs/api/llm-ops.createmessageschema.role.md b/docs/api/llm-ops.createmessageschema.role.md new file mode 100644 index 0000000..56d73d0 --- /dev/null +++ b/docs/api/llm-ops.createmessageschema.role.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [createMessageSchema](./llm-ops.createmessageschema.md) > [role](./llm-ops.createmessageschema.role.md) + +## createMessageSchema.role property + +**Signature:** + +```typescript +role?: "system" | "user" | "assistant" | "function"; +``` diff --git a/docs/api/llm-ops.error.md b/docs/api/llm-ops.error.md new file mode 100644 index 0000000..adff038 --- /dev/null +++ b/docs/api/llm-ops.error.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [error](./llm-ops.error.md) + +## error() function + +Returns an `Error` object. + +**Signature:** + +```typescript +export declare function error(message: string): Error; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| message | string | The value for the message property of the result. | + +**Returns:** + +[Error](./llm-ops.error_2.md) + +An `Error` object. + diff --git a/docs/api/llm-ops.error_2.md b/docs/api/llm-ops.error_2.md new file mode 100644 index 0000000..a963439 --- /dev/null +++ b/docs/api/llm-ops.error_2.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md) + +## Error\_2 interface + +An object representing an operation that failed for the reason given in `message`. + +**Signature:** + +```typescript +export interface Error +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [message](./llm-ops.error_2.message.md) | | string | | +| [success](./llm-ops.error_2.success.md) | | false | | + diff --git a/docs/api/llm-ops.error_2.message.md b/docs/api/llm-ops.error_2.message.md new file mode 100644 index 0000000..af9e148 --- /dev/null +++ b/docs/api/llm-ops.error_2.message.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md) > [message](./llm-ops.error_2.message.md) + +## Error\_2.message property + +**Signature:** + +```typescript +message: string; +``` diff --git a/docs/api/llm-ops.error_2.success.md b/docs/api/llm-ops.error_2.success.md new file mode 100644 index 0000000..87fe1e9 --- /dev/null +++ b/docs/api/llm-ops.error_2.success.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Error\_2](./llm-ops.error_2.md) > [success](./llm-ops.error_2.success.md) + +## Error\_2.success property + +**Signature:** + +```typescript +success: false; +``` diff --git a/docs/api/llm-ops.evaluateitemschema.desc.md b/docs/api/llm-ops.evaluateitemschema.desc.md new file mode 100644 index 0000000..73f115b --- /dev/null +++ b/docs/api/llm-ops.evaluateitemschema.desc.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) > [desc](./llm-ops.evaluateitemschema.desc.md) + +## EvaluateItemSchema.desc property + +**Signature:** + +```typescript +desc: string; +``` diff --git a/docs/api/llm-ops.evaluateitemschema.md b/docs/api/llm-ops.evaluateitemschema.md new file mode 100644 index 0000000..1c15c62 --- /dev/null +++ b/docs/api/llm-ops.evaluateitemschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) + +## EvaluateItemSchema interface + +**Signature:** + +```typescript +export interface EvaluateItemSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [desc](./llm-ops.evaluateitemschema.desc.md) | | string | | +| [name](./llm-ops.evaluateitemschema.name.md) | | string | | + diff --git a/docs/api/llm-ops.evaluateitemschema.name.md b/docs/api/llm-ops.evaluateitemschema.name.md new file mode 100644 index 0000000..c5bdad1 --- /dev/null +++ b/docs/api/llm-ops.evaluateitemschema.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) > [name](./llm-ops.evaluateitemschema.name.md) + +## EvaluateItemSchema.name property + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/llm-ops.formatprompttemplate.md b/docs/api/llm-ops.formatprompttemplate.md new file mode 100644 index 0000000..86e966f --- /dev/null +++ b/docs/api/llm-ops.formatprompttemplate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [formatPromptTemplate](./llm-ops.formatprompttemplate.md) + +## formatPromptTemplate variable + +**Signature:** + +```typescript +formatPromptTemplate: (prompts: PromptsSchema) => Promise<(import("openai/resources/chat").ChatCompletionMessageParam | MultiPromptSchema | undefined)[]> +``` diff --git a/docs/api/llm-ops.function_calltype.md b/docs/api/llm-ops.function_calltype.md new file mode 100644 index 0000000..759acc2 --- /dev/null +++ b/docs/api/llm-ops.function_calltype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [function\_callType](./llm-ops.function_calltype.md) + +## function\_callType type + +**Signature:** + +```typescript +export type function_callType = "none" | "auto" | FunctionCallOption; +``` +**References:** [FunctionCallOption](./llm-ops.functioncalloption.md) + diff --git a/docs/api/llm-ops.functioncalloption.md b/docs/api/llm-ops.functioncalloption.md new file mode 100644 index 0000000..78de56d --- /dev/null +++ b/docs/api/llm-ops.functioncalloption.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallOption](./llm-ops.functioncalloption.md) + +## FunctionCallOption interface + +**Signature:** + +```typescript +export interface FunctionCallOption +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [name](./llm-ops.functioncalloption.name.md) | | string | The name of the function to call. | + diff --git a/docs/api/llm-ops.functioncalloption.name.md b/docs/api/llm-ops.functioncalloption.name.md new file mode 100644 index 0000000..01d68e6 --- /dev/null +++ b/docs/api/llm-ops.functioncalloption.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallOption](./llm-ops.functioncalloption.md) > [name](./llm-ops.functioncalloption.name.md) + +## FunctionCallOption.name property + +The name of the function to call. + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/llm-ops.functioncallschema.function_call.md b/docs/api/llm-ops.functioncallschema.function_call.md new file mode 100644 index 0000000..1901d56 --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.function_call.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [function\_call](./llm-ops.functioncallschema.function_call.md) + +## FunctionCallSchema.function\_call property + +**Signature:** + +```typescript +function_call?: function_callType; +``` diff --git a/docs/api/llm-ops.functioncallschema.functions.md b/docs/api/llm-ops.functioncallschema.functions.md new file mode 100644 index 0000000..e46313a --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.functions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [functions](./llm-ops.functioncallschema.functions.md) + +## FunctionCallSchema.functions property + +**Signature:** + +```typescript +functions?: functionsType; +``` diff --git a/docs/api/llm-ops.functioncallschema.md b/docs/api/llm-ops.functioncallschema.md new file mode 100644 index 0000000..9ab71a9 --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) + +## FunctionCallSchema interface + +**Signature:** + +```typescript +export interface FunctionCallSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [function\_call?](./llm-ops.functioncallschema.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ | +| [functions?](./llm-ops.functioncallschema.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ | +| [prompt?](./llm-ops.functioncallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ | +| [request](./llm-ops.functioncallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | | +| [verbose?](./llm-ops.functioncallschema.verbose.md) | | boolean | _(Optional)_ | + diff --git a/docs/api/llm-ops.functioncallschema.prompt.md b/docs/api/llm-ops.functioncallschema.prompt.md new file mode 100644 index 0000000..f521c4d --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.prompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [prompt](./llm-ops.functioncallschema.prompt.md) + +## FunctionCallSchema.prompt property + +**Signature:** + +```typescript +prompt?: messageType[]; +``` diff --git a/docs/api/llm-ops.functioncallschema.request.md b/docs/api/llm-ops.functioncallschema.request.md new file mode 100644 index 0000000..54aae24 --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [request](./llm-ops.functioncallschema.request.md) + +## FunctionCallSchema.request property + +**Signature:** + +```typescript +request: messageType | string; +``` diff --git a/docs/api/llm-ops.functioncallschema.verbose.md b/docs/api/llm-ops.functioncallschema.verbose.md new file mode 100644 index 0000000..da7d706 --- /dev/null +++ b/docs/api/llm-ops.functioncallschema.verbose.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionCallSchema](./llm-ops.functioncallschema.md) > [verbose](./llm-ops.functioncallschema.verbose.md) + +## FunctionCallSchema.verbose property + +**Signature:** + +```typescript +verbose?: boolean; +``` diff --git a/docs/api/llm-ops.functionchain._constructor_.md b/docs/api/llm-ops.functionchain._constructor_.md new file mode 100644 index 0000000..93b2506 --- /dev/null +++ b/docs/api/llm-ops.functionchain._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [(constructor)](./llm-ops.functionchain._constructor_.md) + +## FunctionChain.(constructor) + +Constructs a new instance of the `FunctionChain` class + +**Signature:** + +```typescript +constructor(llm: LLM); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| llm | [LLM](./llm-ops.llm.md) | | + diff --git a/docs/api/llm-ops.functionchain.call.md b/docs/api/llm-ops.functionchain.call.md new file mode 100644 index 0000000..55ea312 --- /dev/null +++ b/docs/api/llm-ops.functionchain.call.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [call](./llm-ops.functionchain.call.md) + +## FunctionChain.call() method + +**Signature:** + +```typescript +call(params: FunctionCallSchema): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [FunctionCallSchema](./llm-ops.functioncallschema.md) | | + +**Returns:** + +Promise<Error \| import("llm-ops/utils/result").[Success](./llm-ops.success.md)<any>> + diff --git a/docs/api/llm-ops.functionchain.exporthistory.md b/docs/api/llm-ops.functionchain.exporthistory.md new file mode 100644 index 0000000..3f87863 --- /dev/null +++ b/docs/api/llm-ops.functionchain.exporthistory.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [exportHistory](./llm-ops.functionchain.exporthistory.md) + +## FunctionChain.exportHistory() method + +**Signature:** + +```typescript +exportHistory(): import("llm-ops/llm/index").messagesType; +``` +**Returns:** + +import("llm-ops/llm/index").[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.functionchain.llm.md b/docs/api/llm-ops.functionchain.llm.md new file mode 100644 index 0000000..ab937cc --- /dev/null +++ b/docs/api/llm-ops.functionchain.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) > [llm](./llm-ops.functionchain.llm.md) + +## FunctionChain.llm property + +**Signature:** + +```typescript +llm: LLM; +``` diff --git a/docs/api/llm-ops.functionchain.md b/docs/api/llm-ops.functionchain.md new file mode 100644 index 0000000..60d726c --- /dev/null +++ b/docs/api/llm-ops.functionchain.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionChain](./llm-ops.functionchain.md) + +## FunctionChain class + +**Signature:** + +```typescript +export declare class FunctionChain +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(llm)](./llm-ops.functionchain._constructor_.md) | | Constructs a new instance of the FunctionChain class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [llm](./llm-ops.functionchain.llm.md) | | [LLM](./llm-ops.llm.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [call(params)](./llm-ops.functionchain.call.md) | | | +| [exportHistory()](./llm-ops.functionchain.exporthistory.md) | | | + diff --git a/docs/api/llm-ops.functioninterface.description.md b/docs/api/llm-ops.functioninterface.description.md new file mode 100644 index 0000000..c7356c6 --- /dev/null +++ b/docs/api/llm-ops.functioninterface.description.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md) > [description](./llm-ops.functioninterface.description.md) + +## FunctionInterface.description property + +A description of what the function does, used by the model to choose when and how to call the function. + +**Signature:** + +```typescript +description?: string; +``` diff --git a/docs/api/llm-ops.functioninterface.md b/docs/api/llm-ops.functioninterface.md new file mode 100644 index 0000000..95f2108 --- /dev/null +++ b/docs/api/llm-ops.functioninterface.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md) + +## FunctionInterface interface + +**Signature:** + +```typescript +export interface FunctionInterface +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [description?](./llm-ops.functioninterface.description.md) | | string | _(Optional)_ A description of what the function does, used by the model to choose when and how to call the function. | +| [name](./llm-ops.functioninterface.name.md) | | string | The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. | +| [parameters](./llm-ops.functioninterface.parameters.md) | | Record<string, unknown> |

The parameters the functions accepts, described as a JSON Schema object. See the \[guide\](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the \[JSON Schema reference\](https://json-schema.org/understanding-json-schema/) for documentation about the format.

To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.

| + diff --git a/docs/api/llm-ops.functioninterface.name.md b/docs/api/llm-ops.functioninterface.name.md new file mode 100644 index 0000000..422276d --- /dev/null +++ b/docs/api/llm-ops.functioninterface.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md) > [name](./llm-ops.functioninterface.name.md) + +## FunctionInterface.name property + +The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. + +**Signature:** + +```typescript +name: string; +``` diff --git a/docs/api/llm-ops.functioninterface.parameters.md b/docs/api/llm-ops.functioninterface.parameters.md new file mode 100644 index 0000000..5e0a123 --- /dev/null +++ b/docs/api/llm-ops.functioninterface.parameters.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [FunctionInterface](./llm-ops.functioninterface.md) > [parameters](./llm-ops.functioninterface.parameters.md) + +## FunctionInterface.parameters property + +The parameters the functions accepts, described as a JSON Schema object. See the \[guide\](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the \[JSON Schema reference\](https://json-schema.org/understanding-json-schema/) for documentation about the format. + +To describe a function that accepts no parameters, provide the value `{"type": "object", "properties": {}}`. + +**Signature:** + +```typescript +parameters: Record; +``` diff --git a/docs/api/llm-ops.functionstype.md b/docs/api/llm-ops.functionstype.md new file mode 100644 index 0000000..b7d5e54 --- /dev/null +++ b/docs/api/llm-ops.functionstype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [functionsType](./llm-ops.functionstype.md) + +## functionsType type + +**Signature:** + +```typescript +export type functionsType = FunctionInterface[]; +``` +**References:** [FunctionInterface](./llm-ops.functioninterface.md) + diff --git a/docs/api/llm-ops.getdata.md b/docs/api/llm-ops.getdata.md new file mode 100644 index 0000000..d6e6113 --- /dev/null +++ b/docs/api/llm-ops.getdata.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [getData](./llm-ops.getdata.md) + +## getData() function + +Obtains the value associated with a successful `Result` or throws an exception if the result is an error. + +**Signature:** + +```typescript +export declare function getData(result: Result): T; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| result | [Result](./llm-ops.result.md)<T> | The Result<T> from which to obtain the data property. | + +**Returns:** + +T + +The value of the `data` property. + diff --git a/docs/api/llm-ops.inputvalues.md b/docs/api/llm-ops.inputvalues.md new file mode 100644 index 0000000..e77e52c --- /dev/null +++ b/docs/api/llm-ops.inputvalues.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [InputValues](./llm-ops.inputvalues.md) + +## InputValues type + +**Signature:** + +```typescript +export type InputValues = Record; +``` diff --git a/docs/api/llm-ops.languagetype.md b/docs/api/llm-ops.languagetype.md new file mode 100644 index 0000000..acb649a --- /dev/null +++ b/docs/api/llm-ops.languagetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [languageType](./llm-ops.languagetype.md) + +## languageType type + +**Signature:** + +```typescript +export type languageType = "English" | "Chinese"; +``` diff --git a/docs/api/llm-ops.leveltype.md b/docs/api/llm-ops.leveltype.md new file mode 100644 index 0000000..f436bf6 --- /dev/null +++ b/docs/api/llm-ops.leveltype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [levelType](./llm-ops.leveltype.md) + +## levelType type + +**Signature:** + +```typescript +export type levelType = "Elementary (Grade 1-6)" | "Middle School (Grade 7-9)" | "High School (Grade 10-12)" | "Undergraduate" | "Graduate (Bachelor Degree)" | "Master's" | "Doctoral Candidate (Ph.D Candidate)" | "Postdoc" | "Ph.D"; +``` diff --git a/docs/api/llm-ops.llm._constructor_.md b/docs/api/llm-ops.llm._constructor_.md new file mode 100644 index 0000000..cd62b77 --- /dev/null +++ b/docs/api/llm-ops.llm._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [(constructor)](./llm-ops.llm._constructor_.md) + +## LLM.(constructor) + +Constructs a new instance of the `LLM` class + +**Signature:** + +```typescript +constructor(params: createLLMSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [createLLMSchema](./llm-ops.createllmschema.md) | | + diff --git a/docs/api/llm-ops.llm.cache.md b/docs/api/llm-ops.llm.cache.md new file mode 100644 index 0000000..d6fc15e --- /dev/null +++ b/docs/api/llm-ops.llm.cache.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [cache](./llm-ops.llm.cache.md) + +## LLM.cache property + +**Signature:** + +```typescript +cache?: boolean; +``` diff --git a/docs/api/llm-ops.llm.chat.md b/docs/api/llm-ops.llm.chat.md new file mode 100644 index 0000000..b3f688f --- /dev/null +++ b/docs/api/llm-ops.llm.chat.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [chat](./llm-ops.llm.chat.md) + +## LLM.chat() method + +**Signature:** + +```typescript +chat(params: ChatSchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [ChatSchema](./llm-ops.chatschema.md) | | + +**Returns:** + +Promise<[chatCompletionType](./llm-ops.chatcompletiontype.md)> + diff --git a/docs/api/llm-ops.llm.choice_num.md b/docs/api/llm-ops.llm.choice_num.md new file mode 100644 index 0000000..568d7db --- /dev/null +++ b/docs/api/llm-ops.llm.choice_num.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [choice\_num](./llm-ops.llm.choice_num.md) + +## LLM.choice\_num property + +**Signature:** + +```typescript +choice_num?: number | 1; +``` diff --git a/docs/api/llm-ops.llm.embedding.md b/docs/api/llm-ops.llm.embedding.md new file mode 100644 index 0000000..c765dae --- /dev/null +++ b/docs/api/llm-ops.llm.embedding.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [embedding](./llm-ops.llm.embedding.md) + +## LLM.embedding() method + +**Signature:** + +```typescript +embedding(input: string | string[] | number[] | number[][]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string \| string\[\] \| number\[\] \| number\[\]\[\] | | + +**Returns:** + +Promise<[resEmbeddingType](./llm-ops.resembeddingtype.md)> + diff --git a/docs/api/llm-ops.llm.exporthistory.md b/docs/api/llm-ops.llm.exporthistory.md new file mode 100644 index 0000000..919d4b4 --- /dev/null +++ b/docs/api/llm-ops.llm.exporthistory.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [exportHistory](./llm-ops.llm.exporthistory.md) + +## LLM.exportHistory() method + +**Signature:** + +```typescript +exportHistory(): messagesType; +``` +**Returns:** + +[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.llm.function_call.md b/docs/api/llm-ops.llm.function_call.md new file mode 100644 index 0000000..bca6701 --- /dev/null +++ b/docs/api/llm-ops.llm.function_call.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [function\_call](./llm-ops.llm.function_call.md) + +## LLM.function\_call property + +**Signature:** + +```typescript +function_call?: function_callType; +``` diff --git a/docs/api/llm-ops.llm.functions.md b/docs/api/llm-ops.llm.functions.md new file mode 100644 index 0000000..efd4ebf --- /dev/null +++ b/docs/api/llm-ops.llm.functions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [functions](./llm-ops.llm.functions.md) + +## LLM.functions property + +**Signature:** + +```typescript +functions?: functionsType; +``` diff --git a/docs/api/llm-ops.llm.llm.md b/docs/api/llm-ops.llm.llm.md new file mode 100644 index 0000000..b7010a8 --- /dev/null +++ b/docs/api/llm-ops.llm.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [llm](./llm-ops.llm.llm.md) + +## LLM.llm property + +**Signature:** + +```typescript +llm: llmType; +``` diff --git a/docs/api/llm-ops.llm.log.md b/docs/api/llm-ops.llm.log.md new file mode 100644 index 0000000..28bb098 --- /dev/null +++ b/docs/api/llm-ops.llm.log.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [log](./llm-ops.llm.log.md) + +## LLM.log() method + +**Signature:** + +```typescript +static log(...args: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| args | string\[\] | | + +**Returns:** + +void + diff --git a/docs/api/llm-ops.llm.md b/docs/api/llm-ops.llm.md new file mode 100644 index 0000000..16af532 --- /dev/null +++ b/docs/api/llm-ops.llm.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) + +## LLM class + +**Signature:** + +```typescript +export declare class LLM +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(params)](./llm-ops.llm._constructor_.md) | | Constructs a new instance of the LLM class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [cache?](./llm-ops.llm.cache.md) | | boolean | _(Optional)_ | +| [choice\_num?](./llm-ops.llm.choice_num.md) | | number \| 1 | _(Optional)_ | +| [function\_call?](./llm-ops.llm.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ | +| [functions?](./llm-ops.llm.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ | +| [llm](./llm-ops.llm.llm.md) | | [llmType](./llm-ops.llmtype.md) | | +| [messages](./llm-ops.llm.messages.md) | | [messagesType](./llm-ops.messagestype.md) | | +| [modelName?](./llm-ops.llm.modelname.md) | | (string & object) \| "gpt-4" \| "gpt-4-0314" \| "gpt-4-0613" \| "gpt-4-32k" \| "gpt-4-32k-0314" \| "gpt-4-32k-0613" \| "gpt-3.5-turbo" \| "gpt-3.5-turbo-16k" \| "gpt-3.5-turbo-0301" \| "gpt-3.5-turbo-0613" \| "gpt-3.5-turbo-16k-0613" | _(Optional)_ | +| [roleToColor](./llm-ops.llm.roletocolor.md) | | { system: string; user: string; assistant: string; function: string; } | | +| [stop?](./llm-ops.llm.stop.md) | | string \| null \| string\[\] | _(Optional)_ | +| [temperature?](./llm-ops.llm.temperature.md) | | number | _(Optional)_ | +| [tokens](./llm-ops.llm.tokens.md) | | number | | +| [user](./llm-ops.llm.user.md) | | string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [chat(params)](./llm-ops.llm.chat.md) | | | +| [embedding(input)](./llm-ops.llm.embedding.md) | | | +| [exportHistory()](./llm-ops.llm.exporthistory.md) | | | +| [log(args)](./llm-ops.llm.log.md) | static | | +| [moderate(input)](./llm-ops.llm.moderate.md) | | | +| [printMessage(resMessages, reqMessages)](./llm-ops.llm.printmessage.md) | | | +| [recall()](./llm-ops.llm.recall.md) | | | + diff --git a/docs/api/llm-ops.llm.messages.md b/docs/api/llm-ops.llm.messages.md new file mode 100644 index 0000000..1f33154 --- /dev/null +++ b/docs/api/llm-ops.llm.messages.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [messages](./llm-ops.llm.messages.md) + +## LLM.messages property + +**Signature:** + +```typescript +messages: messagesType; +``` diff --git a/docs/api/llm-ops.llm.modelname.md b/docs/api/llm-ops.llm.modelname.md new file mode 100644 index 0000000..99c63ad --- /dev/null +++ b/docs/api/llm-ops.llm.modelname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [modelName](./llm-ops.llm.modelname.md) + +## LLM.modelName property + +**Signature:** + +```typescript +modelName?: (string & object) | "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k-0613"; +``` diff --git a/docs/api/llm-ops.llm.moderate.md b/docs/api/llm-ops.llm.moderate.md new file mode 100644 index 0000000..e83d449 --- /dev/null +++ b/docs/api/llm-ops.llm.moderate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [moderate](./llm-ops.llm.moderate.md) + +## LLM.moderate() method + +**Signature:** + +```typescript +moderate(input: string | string[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string \| string\[\] | | + +**Returns:** + +Promise<[resModerationType](./llm-ops.resmoderationtype.md)> + diff --git a/docs/api/llm-ops.llm.printmessage.md b/docs/api/llm-ops.llm.printmessage.md new file mode 100644 index 0000000..4f6a22a --- /dev/null +++ b/docs/api/llm-ops.llm.printmessage.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [printMessage](./llm-ops.llm.printmessage.md) + +## LLM.printMessage() method + +**Signature:** + +```typescript +printMessage(resMessages?: resMessagesType, reqMessages?: messagesType): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| resMessages | [resMessagesType](./llm-ops.resmessagestype.md) | _(Optional)_ | +| reqMessages | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ | + +**Returns:** + +void + diff --git a/docs/api/llm-ops.llm.recall.md b/docs/api/llm-ops.llm.recall.md new file mode 100644 index 0000000..6e69171 --- /dev/null +++ b/docs/api/llm-ops.llm.recall.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [recall](./llm-ops.llm.recall.md) + +## LLM.recall() method + +**Signature:** + +```typescript +recall(): Promise; +``` +**Returns:** + +Promise<[chatCompletionType](./llm-ops.chatcompletiontype.md)> + diff --git a/docs/api/llm-ops.llm.roletocolor.md b/docs/api/llm-ops.llm.roletocolor.md new file mode 100644 index 0000000..472e163 --- /dev/null +++ b/docs/api/llm-ops.llm.roletocolor.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [roleToColor](./llm-ops.llm.roletocolor.md) + +## LLM.roleToColor property + +**Signature:** + +```typescript +roleToColor: { + system: string; + user: string; + assistant: string; + function: string; + }; +``` diff --git a/docs/api/llm-ops.llm.stop.md b/docs/api/llm-ops.llm.stop.md new file mode 100644 index 0000000..56130a3 --- /dev/null +++ b/docs/api/llm-ops.llm.stop.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [stop](./llm-ops.llm.stop.md) + +## LLM.stop property + +**Signature:** + +```typescript +stop?: string | null | string[]; +``` diff --git a/docs/api/llm-ops.llm.temperature.md b/docs/api/llm-ops.llm.temperature.md new file mode 100644 index 0000000..8a0a393 --- /dev/null +++ b/docs/api/llm-ops.llm.temperature.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [temperature](./llm-ops.llm.temperature.md) + +## LLM.temperature property + +**Signature:** + +```typescript +temperature?: number; +``` diff --git a/docs/api/llm-ops.llm.tokens.md b/docs/api/llm-ops.llm.tokens.md new file mode 100644 index 0000000..d26fcd7 --- /dev/null +++ b/docs/api/llm-ops.llm.tokens.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [tokens](./llm-ops.llm.tokens.md) + +## LLM.tokens property + +**Signature:** + +```typescript +tokens: number; +``` diff --git a/docs/api/llm-ops.llm.user.md b/docs/api/llm-ops.llm.user.md new file mode 100644 index 0000000..ce47329 --- /dev/null +++ b/docs/api/llm-ops.llm.user.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM](./llm-ops.llm.md) > [user](./llm-ops.llm.user.md) + +## LLM.user property + +**Signature:** + +```typescript +user: string; +``` diff --git a/docs/api/llm-ops.llm_ops_config.helicone_auth_api_key.md b/docs/api/llm-ops.llm_ops_config.helicone_auth_api_key.md new file mode 100644 index 0000000..02c3074 --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.helicone_auth_api_key.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [HELICONE\_AUTH\_API\_KEY](./llm-ops.llm_ops_config.helicone_auth_api_key.md) + +## LLM\_OPS\_CONFIG.HELICONE\_AUTH\_API\_KEY property + +**Signature:** + +```typescript +static HELICONE_AUTH_API_KEY: string | undefined; +``` diff --git a/docs/api/llm-ops.llm_ops_config.md b/docs/api/llm-ops.llm_ops_config.md new file mode 100644 index 0000000..f72e34b --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) + +## LLM\_OPS\_CONFIG class + +**Signature:** + +```typescript +export declare class LLM_OPS_CONFIG +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [HELICONE\_AUTH\_API\_KEY](./llm-ops.llm_ops_config.helicone_auth_api_key.md) | static | string \| undefined | | +| [MILVUS\_ADDRESS](./llm-ops.llm_ops_config.milvus_address.md) | static | string \| undefined | | +| [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md) | static | string \| undefined | | +| [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md) | static | string \| undefined | | +| [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) | static | { baseURL: string; defaultHeaders: { "Helicone-Auth": string; }; } | | +| [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md) | static | string \| undefined | | + diff --git a/docs/api/llm-ops.llm_ops_config.milvus_address.md b/docs/api/llm-ops.llm_ops_config.milvus_address.md new file mode 100644 index 0000000..9c847df --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.milvus_address.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_ADDRESS](./llm-ops.llm_ops_config.milvus_address.md) + +## LLM\_OPS\_CONFIG.MILVUS\_ADDRESS property + +**Signature:** + +```typescript +static MILVUS_ADDRESS: string | undefined; +``` diff --git a/docs/api/llm-ops.llm_ops_config.milvus_password.md b/docs/api/llm-ops.llm_ops_config.milvus_password.md new file mode 100644 index 0000000..8dfe9a7 --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.milvus_password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_PASSWORD](./llm-ops.llm_ops_config.milvus_password.md) + +## LLM\_OPS\_CONFIG.MILVUS\_PASSWORD property + +**Signature:** + +```typescript +static MILVUS_PASSWORD: string | undefined; +``` diff --git a/docs/api/llm-ops.llm_ops_config.milvus_username.md b/docs/api/llm-ops.llm_ops_config.milvus_username.md new file mode 100644 index 0000000..fadac1e --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.milvus_username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [MILVUS\_USERNAME](./llm-ops.llm_ops_config.milvus_username.md) + +## LLM\_OPS\_CONFIG.MILVUS\_USERNAME property + +**Signature:** + +```typescript +static MILVUS_USERNAME: string | undefined; +``` diff --git a/docs/api/llm-ops.llm_ops_config.open_path.md b/docs/api/llm-ops.llm_ops_config.open_path.md new file mode 100644 index 0000000..bc97ce5 --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.open_path.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [OPEN\_PATH](./llm-ops.llm_ops_config.open_path.md) + +## LLM\_OPS\_CONFIG.OPEN\_PATH property + +**Signature:** + +```typescript +static OPEN_PATH: { + baseURL: string; + defaultHeaders: { + "Helicone-Auth": string; + }; + }; +``` diff --git a/docs/api/llm-ops.llm_ops_config.openai_api_key.md b/docs/api/llm-ops.llm_ops_config.openai_api_key.md new file mode 100644 index 0000000..197781c --- /dev/null +++ b/docs/api/llm-ops.llm_ops_config.openai_api_key.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) > [OPENAI\_API\_KEY](./llm-ops.llm_ops_config.openai_api_key.md) + +## LLM\_OPS\_CONFIG.OPENAI\_API\_KEY property + +**Signature:** + +```typescript +static OPENAI_API_KEY: string | undefined; +``` diff --git a/docs/api/llm-ops.llmtype.md b/docs/api/llm-ops.llmtype.md new file mode 100644 index 0000000..8248d80 --- /dev/null +++ b/docs/api/llm-ops.llmtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [llmType](./llm-ops.llmtype.md) + +## llmType type + +**Signature:** + +```typescript +export type llmType = OpenAI; +``` diff --git a/docs/api/llm-ops.md b/docs/api/llm-ops.md new file mode 100644 index 0000000..6dfabfc --- /dev/null +++ b/docs/api/llm-ops.md @@ -0,0 +1,100 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) + +## llm-ops package + +## Classes + +| Class | Description | +| --- | --- | +| [AgentPromptTemplate](./llm-ops.agentprompttemplate.md) | | +| [BaseAgent](./llm-ops.baseagent.md) | | +| [Chain](./llm-ops.chain.md) | | +| [FunctionChain](./llm-ops.functionchain.md) | | +| [LLM\_OPS\_CONFIG](./llm-ops.llm_ops_config.md) | | +| [LLM](./llm-ops.llm.md) | | +| [milvusVectorDB](./llm-ops.milvusvectordb.md) | | +| [PipeRegistry](./llm-ops.piperegistry.md) | | +| [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) | | +| [TypeScriptChain](./llm-ops.typescriptchain.md) | Creates an object that can translate natural language requests into JSON objects of the given type. The specified type argument T must be the same type as typeName in the given schema. The function creates a TypeChatJsonValidator<T> and stores it in the validator property of the returned instance. | + +## Abstract Classes + +| Abstract Class | Description | +| --- | --- | +| [BasePromptTemplate](./llm-ops.baseprompttemplate.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [createJsonValidator(schema, typeName)](./llm-ops.createjsonvalidator.md) | Returns a JSON validator for a given TypeScript schema. Validation is performed by an in-memory instance of the TypeScript compiler. The specified type argument T must be the same type as typeName in the given schema. | +| [createMessage(params)](./llm-ops.createmessage.md) | | +| [error(message)](./llm-ops.error.md) | Returns an Error object. | +| [getData(result)](./llm-ops.getdata.md) | Obtains the value associated with a successful Result<T> or throws an exception if the result is an error. | +| [success(data)](./llm-ops.success.md) | Returns a Success<T> object. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [AgentPromptTemplateSchema](./llm-ops.agentprompttemplateschema.md) | | +| [BaseAgentCallSchema](./llm-ops.baseagentcallschema.md) | | +| [chainCallSchema](./llm-ops.chaincallschema.md) | | +| [chainSchema](./llm-ops.chainschema.md) | | +| [ChatSchema](./llm-ops.chatschema.md) | | +| [createLLMSchema](./llm-ops.createllmschema.md) | | +| [createMessageSchema](./llm-ops.createmessageschema.md) | | +| [Error\_2](./llm-ops.error_2.md) | An object representing an operation that failed for the reason given in message. | +| [EvaluateItemSchema](./llm-ops.evaluateitemschema.md) | | +| [FunctionCallOption](./llm-ops.functioncalloption.md) | | +| [FunctionCallSchema](./llm-ops.functioncallschema.md) | | +| [FunctionInterface](./llm-ops.functioninterface.md) | | +| [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) | | +| [milvusVectorDBCreateSchema](./llm-ops.milvusvectordbcreateschema.md) | | +| [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) | | +| [milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md) | | +| [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) | | +| [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) | | +| [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) | | +| [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) | | +| [MultiPromptSchema](./llm-ops.multipromptschema.md) | | +| [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) | | +| [PromptsSchema](./llm-ops.promptsschema.md) | | +| [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) | | +| [structSchema](./llm-ops.structschema.md) | | +| [Success](./llm-ops.success.md) | An object representing a successful operation with a result of type T. | +| [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) | | +| [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) | Represents an object that can validate JSON strings according to a given TypeScript schema. | +| [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) | Represents an object that can translate natural language requests in JSON objects of the given type. | + +## Variables + +| Variable | Description | +| --- | --- | +| [formatPromptTemplate](./llm-ops.formatprompttemplate.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [chatCompletionType](./llm-ops.chatcompletiontype.md) | | +| [chatParamsType](./llm-ops.chatparamstype.md) | | +| [communicationStyleType](./llm-ops.communicationstyletype.md) | | +| [function\_callType](./llm-ops.function_calltype.md) | | +| [functionsType](./llm-ops.functionstype.md) | | +| [InputValues](./llm-ops.inputvalues.md) | | +| [languageType](./llm-ops.languagetype.md) | | +| [levelType](./llm-ops.leveltype.md) | | +| [llmType](./llm-ops.llmtype.md) | | +| [messageFunctionCallType](./llm-ops.messagefunctioncalltype.md) | | +| [messagesType](./llm-ops.messagestype.md) | | +| [messageType](./llm-ops.messagetype.md) | | +| [reasoningType](./llm-ops.reasoningtype.md) | | +| [resEmbeddingType](./llm-ops.resembeddingtype.md) | | +| [resMessagesType](./llm-ops.resmessagestype.md) | | +| [resModerationType](./llm-ops.resmoderationtype.md) | | +| [Result](./llm-ops.result.md) | An object representing a successful or failed operation of type T. | +| [toneStyleType](./llm-ops.tonestyletype.md) | | + diff --git a/docs/api/llm-ops.memoryprompttemplateschema.data.md b/docs/api/llm-ops.memoryprompttemplateschema.data.md new file mode 100644 index 0000000..e29887a --- /dev/null +++ b/docs/api/llm-ops.memoryprompttemplateschema.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [data](./llm-ops.memoryprompttemplateschema.data.md) + +## MemoryPromptTemplateSchema.data property + +**Signature:** + +```typescript +data?: string | string[]; +``` diff --git a/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md b/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md new file mode 100644 index 0000000..41ca70d --- /dev/null +++ b/docs/api/llm-ops.memoryprompttemplateschema.knowledge.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [knowledge](./llm-ops.memoryprompttemplateschema.knowledge.md) + +## MemoryPromptTemplateSchema.knowledge property + +**Signature:** + +```typescript +knowledge?: string | string[]; +``` diff --git a/docs/api/llm-ops.memoryprompttemplateschema.md b/docs/api/llm-ops.memoryprompttemplateschema.md new file mode 100644 index 0000000..ca507b5 --- /dev/null +++ b/docs/api/llm-ops.memoryprompttemplateschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) + +## MemoryPromptTemplateSchema interface + +**Signature:** + +```typescript +export interface MemoryPromptTemplateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data?](./llm-ops.memoryprompttemplateschema.data.md) | | string \| string\[\] | _(Optional)_ | +| [knowledge?](./llm-ops.memoryprompttemplateschema.knowledge.md) | | string \| string\[\] | _(Optional)_ | +| [tools?](./llm-ops.memoryprompttemplateschema.tools.md) | | string \| string\[\] | _(Optional)_ | + diff --git a/docs/api/llm-ops.memoryprompttemplateschema.tools.md b/docs/api/llm-ops.memoryprompttemplateschema.tools.md new file mode 100644 index 0000000..76f0a21 --- /dev/null +++ b/docs/api/llm-ops.memoryprompttemplateschema.tools.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MemoryPromptTemplateSchema](./llm-ops.memoryprompttemplateschema.md) > [tools](./llm-ops.memoryprompttemplateschema.tools.md) + +## MemoryPromptTemplateSchema.tools property + +**Signature:** + +```typescript +tools?: string | string[]; +``` diff --git a/docs/api/llm-ops.messagefunctioncalltype.md b/docs/api/llm-ops.messagefunctioncalltype.md new file mode 100644 index 0000000..362dd73 --- /dev/null +++ b/docs/api/llm-ops.messagefunctioncalltype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [messageFunctionCallType](./llm-ops.messagefunctioncalltype.md) + +## messageFunctionCallType type + +**Signature:** + +```typescript +export type messageFunctionCallType = OpenAI.Chat.ChatCompletionMessage.FunctionCall; +``` diff --git a/docs/api/llm-ops.messagestype.md b/docs/api/llm-ops.messagestype.md new file mode 100644 index 0000000..c8f6295 --- /dev/null +++ b/docs/api/llm-ops.messagestype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [messagesType](./llm-ops.messagestype.md) + +## messagesType type + +**Signature:** + +```typescript +export type messagesType = OpenAI.Chat.CreateChatCompletionRequestMessage[]; +``` diff --git a/docs/api/llm-ops.messagetype.md b/docs/api/llm-ops.messagetype.md new file mode 100644 index 0000000..7cf0400 --- /dev/null +++ b/docs/api/llm-ops.messagetype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [messageType](./llm-ops.messagetype.md) + +## messageType type + +**Signature:** + +```typescript +export type messageType = OpenAI.Chat.CreateChatCompletionRequestMessage; +``` diff --git a/docs/api/llm-ops.milvusvectordb._constructor_.md b/docs/api/llm-ops.milvusvectordb._constructor_.md new file mode 100644 index 0000000..c82debc --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [(constructor)](./llm-ops.milvusvectordb._constructor_.md) + +## milvusVectorDB.(constructor) + +Constructs a new instance of the `milvusVectorDB` class + +**Signature:** + +```typescript +constructor(params: milvusVectorDBSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) | | + diff --git a/docs/api/llm-ops.milvusvectordb.collection_name.md b/docs/api/llm-ops.milvusvectordb.collection_name.md new file mode 100644 index 0000000..869e39e --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.collection_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [COLLECTION\_NAME](./llm-ops.milvusvectordb.collection_name.md) + +## milvusVectorDB.COLLECTION\_NAME property + +**Signature:** + +```typescript +COLLECTION_NAME: string; +``` diff --git a/docs/api/llm-ops.milvusvectordb.createcollection.md b/docs/api/llm-ops.milvusvectordb.createcollection.md new file mode 100644 index 0000000..1d67f61 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.createcollection.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [createCollection](./llm-ops.milvusvectordb.createcollection.md) + +## milvusVectorDB.createCollection() method + +**Signature:** + +```typescript +createCollection(params: milvusVectorDBCreateSchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBCreateSchema](./llm-ops.milvusvectordbcreateschema.md) | | + +**Returns:** + +Promise<import("@zilliz/milvus2-sdk-node").ResStatus> + diff --git a/docs/api/llm-ops.milvusvectordb.generateprompttemplate.md b/docs/api/llm-ops.milvusvectordb.generateprompttemplate.md new file mode 100644 index 0000000..ea22990 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.generateprompttemplate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [generatePromptTemplate](./llm-ops.milvusvectordb.generateprompttemplate.md) + +## milvusVectorDB.generatePromptTemplate() method + +**Signature:** + +```typescript +generatePromptTemplate(params: milvusVectorDBPromptTemplateSchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md) | | + +**Returns:** + +Promise<import("openai/resources/chat").ChatCompletionMessageParam> + diff --git a/docs/api/llm-ops.milvusvectordb.generatevector.md b/docs/api/llm-ops.milvusvectordb.generatevector.md new file mode 100644 index 0000000..3d123e1 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.generatevector.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [generateVector](./llm-ops.milvusvectordb.generatevector.md) + +## milvusVectorDB.generateVector() method + +**Signature:** + +```typescript +generateVector(data: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| data | string | | + +**Returns:** + +Promise<number\[\]> + diff --git a/docs/api/llm-ops.milvusvectordb.llm.md b/docs/api/llm-ops.milvusvectordb.llm.md new file mode 100644 index 0000000..31fcfff --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [llm](./llm-ops.milvusvectordb.llm.md) + +## milvusVectorDB.llm property + +**Signature:** + +```typescript +llm: LLM | undefined; +``` diff --git a/docs/api/llm-ops.milvusvectordb.md b/docs/api/llm-ops.milvusvectordb.md new file mode 100644 index 0000000..0884e30 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) + +## milvusVectorDB class + +**Signature:** + +```typescript +export declare class milvusVectorDB +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(params)](./llm-ops.milvusvectordb._constructor_.md) | | Constructs a new instance of the milvusVectorDB class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [COLLECTION\_NAME](./llm-ops.milvusvectordb.collection_name.md) | | string | | +| [llm](./llm-ops.milvusvectordb.llm.md) | | [LLM](./llm-ops.llm.md) \| undefined | | +| [milvusClient](./llm-ops.milvusvectordb.milvusclient.md) | | MilvusClient | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [createCollection(params)](./llm-ops.milvusvectordb.createcollection.md) | | | +| [generatePromptTemplate(params)](./llm-ops.milvusvectordb.generateprompttemplate.md) | | | +| [generateVector(data)](./llm-ops.milvusvectordb.generatevector.md) | | | +| [query(params)](./llm-ops.milvusvectordb.query.md) | | | +| [search(params)](./llm-ops.milvusvectordb.search.md) | | | +| [upload(params)](./llm-ops.milvusvectordb.upload.md) | | | + diff --git a/docs/api/llm-ops.milvusvectordb.milvusclient.md b/docs/api/llm-ops.milvusvectordb.milvusclient.md new file mode 100644 index 0000000..6140407 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.milvusclient.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [milvusClient](./llm-ops.milvusvectordb.milvusclient.md) + +## milvusVectorDB.milvusClient property + +**Signature:** + +```typescript +milvusClient: MilvusClient; +``` diff --git a/docs/api/llm-ops.milvusvectordb.query.md b/docs/api/llm-ops.milvusvectordb.query.md new file mode 100644 index 0000000..c0e39f4 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.query.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [query](./llm-ops.milvusvectordb.query.md) + +## milvusVectorDB.query() method + +**Signature:** + +```typescript +query(params: milvusVectorDBQuerySchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) | | + +**Returns:** + +Promise<import("@zilliz/milvus2-sdk-node").QueryResults> + diff --git a/docs/api/llm-ops.milvusvectordb.search.md b/docs/api/llm-ops.milvusvectordb.search.md new file mode 100644 index 0000000..896dee3 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.search.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [search](./llm-ops.milvusvectordb.search.md) + +## milvusVectorDB.search() method + +**Signature:** + +```typescript +search(params: milvusVectorDBSearchSchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) | | + +**Returns:** + +Promise<import("@zilliz/milvus2-sdk-node").SearchResults> + diff --git a/docs/api/llm-ops.milvusvectordb.upload.md b/docs/api/llm-ops.milvusvectordb.upload.md new file mode 100644 index 0000000..9152f50 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordb.upload.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDB](./llm-ops.milvusvectordb.md) > [upload](./llm-ops.milvusvectordb.upload.md) + +## milvusVectorDB.upload() method + +**Signature:** + +```typescript +upload(params: milvusVectorDBUploadSchema): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) | | + +**Returns:** + +Promise<import("@zilliz/milvus2-sdk-node").ResStatus> + diff --git a/docs/api/llm-ops.milvusvectordbcreateschema.fields.md b/docs/api/llm-ops.milvusvectordbcreateschema.fields.md new file mode 100644 index 0000000..9e87692 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbcreateschema.fields.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBCreateSchema](./llm-ops.milvusvectordbcreateschema.md) > [fields](./llm-ops.milvusvectordbcreateschema.fields.md) + +## milvusVectorDBCreateSchema.fields property + +**Signature:** + +```typescript +fields: FieldType[]; +``` diff --git a/docs/api/llm-ops.milvusvectordbcreateschema.md b/docs/api/llm-ops.milvusvectordbcreateschema.md new file mode 100644 index 0000000..5abc3b4 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbcreateschema.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBCreateSchema](./llm-ops.milvusvectordbcreateschema.md) + +## milvusVectorDBCreateSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBCreateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fields](./llm-ops.milvusvectordbcreateschema.fields.md) | | FieldType\[\] | | + diff --git a/docs/api/llm-ops.milvusvectordbindexschema.field_name.md b/docs/api/llm-ops.milvusvectordbindexschema.field_name.md new file mode 100644 index 0000000..ba1f1b0 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbindexschema.field_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) > [field\_name](./llm-ops.milvusvectordbindexschema.field_name.md) + +## milvusVectorDBIndexSchema.field\_name property + +**Signature:** + +```typescript +field_name: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbindexschema.md b/docs/api/llm-ops.milvusvectordbindexschema.md new file mode 100644 index 0000000..ec2c769 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbindexschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) + +## milvusVectorDBIndexSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBIndexSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [field\_name](./llm-ops.milvusvectordbindexschema.field_name.md) | | string | | +| [metric\_type](./llm-ops.milvusvectordbindexschema.metric_type.md) | | string | | + diff --git a/docs/api/llm-ops.milvusvectordbindexschema.metric_type.md b/docs/api/llm-ops.milvusvectordbindexschema.metric_type.md new file mode 100644 index 0000000..b6d5e69 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbindexschema.metric_type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) > [metric\_type](./llm-ops.milvusvectordbindexschema.metric_type.md) + +## milvusVectorDBIndexSchema.metric\_type property + +**Signature:** + +```typescript +metric_type: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbprompttemplateschema.content.md b/docs/api/llm-ops.milvusvectordbprompttemplateschema.content.md new file mode 100644 index 0000000..d13d285 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbprompttemplateschema.content.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md) > [content](./llm-ops.milvusvectordbprompttemplateschema.content.md) + +## milvusVectorDBPromptTemplateSchema.content property + +**Signature:** + +```typescript +content?: string | null; +``` diff --git a/docs/api/llm-ops.milvusvectordbprompttemplateschema.md b/docs/api/llm-ops.milvusvectordbprompttemplateschema.md new file mode 100644 index 0000000..6c47821 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbprompttemplateschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md) + +## milvusVectorDBPromptTemplateSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBPromptTemplateSchema extends milvusVectorDBSearchSchema +``` +**Extends:** [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [content?](./llm-ops.milvusvectordbprompttemplateschema.content.md) | | string \| null | _(Optional)_ | + diff --git a/docs/api/llm-ops.milvusvectordbqueryschema.filter.md b/docs/api/llm-ops.milvusvectordbqueryschema.filter.md new file mode 100644 index 0000000..c4c0a06 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbqueryschema.filter.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) > [filter](./llm-ops.milvusvectordbqueryschema.filter.md) + +## milvusVectorDBQuerySchema.filter property + +**Signature:** + +```typescript +filter: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbqueryschema.limit.md b/docs/api/llm-ops.milvusvectordbqueryschema.limit.md new file mode 100644 index 0000000..9faa61e --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbqueryschema.limit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) > [limit](./llm-ops.milvusvectordbqueryschema.limit.md) + +## milvusVectorDBQuerySchema.limit property + +**Signature:** + +```typescript +limit?: number; +``` diff --git a/docs/api/llm-ops.milvusvectordbqueryschema.md b/docs/api/llm-ops.milvusvectordbqueryschema.md new file mode 100644 index 0000000..97b09b8 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbqueryschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) + +## milvusVectorDBQuerySchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBQuerySchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [filter](./llm-ops.milvusvectordbqueryschema.filter.md) | | string | | +| [limit?](./llm-ops.milvusvectordbqueryschema.limit.md) | | number | _(Optional)_ | +| [output\_fields](./llm-ops.milvusvectordbqueryschema.output_fields.md) | | string\[\] | | + diff --git a/docs/api/llm-ops.milvusvectordbqueryschema.output_fields.md b/docs/api/llm-ops.milvusvectordbqueryschema.output_fields.md new file mode 100644 index 0000000..cb4d30f --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbqueryschema.output_fields.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBQuerySchema](./llm-ops.milvusvectordbqueryschema.md) > [output\_fields](./llm-ops.milvusvectordbqueryschema.output_fields.md) + +## milvusVectorDBQuerySchema.output\_fields property + +**Signature:** + +```typescript +output_fields: string[]; +``` diff --git a/docs/api/llm-ops.milvusvectordbschema.address.md b/docs/api/llm-ops.milvusvectordbschema.address.md new file mode 100644 index 0000000..49ecccb --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.address.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) > [address](./llm-ops.milvusvectordbschema.address.md) + +## milvusVectorDBSchema.address property + +**Signature:** + +```typescript +address?: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbschema.collection_name.md b/docs/api/llm-ops.milvusvectordbschema.collection_name.md new file mode 100644 index 0000000..834909e --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.collection_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) > [COLLECTION\_NAME](./llm-ops.milvusvectordbschema.collection_name.md) + +## milvusVectorDBSchema.COLLECTION\_NAME property + +**Signature:** + +```typescript +COLLECTION_NAME: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbschema.llm.md b/docs/api/llm-ops.milvusvectordbschema.llm.md new file mode 100644 index 0000000..869ea4b --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) > [llm](./llm-ops.milvusvectordbschema.llm.md) + +## milvusVectorDBSchema.llm property + +**Signature:** + +```typescript +llm?: LLM; +``` diff --git a/docs/api/llm-ops.milvusvectordbschema.md b/docs/api/llm-ops.milvusvectordbschema.md new file mode 100644 index 0000000..cde5e8d --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) + +## milvusVectorDBSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [address?](./llm-ops.milvusvectordbschema.address.md) | | string | _(Optional)_ | +| [COLLECTION\_NAME](./llm-ops.milvusvectordbschema.collection_name.md) | | string | | +| [llm?](./llm-ops.milvusvectordbschema.llm.md) | | [LLM](./llm-ops.llm.md) | _(Optional)_ | +| [password?](./llm-ops.milvusvectordbschema.password.md) | | string | _(Optional)_ | +| [username?](./llm-ops.milvusvectordbschema.username.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.milvusvectordbschema.password.md b/docs/api/llm-ops.milvusvectordbschema.password.md new file mode 100644 index 0000000..e22fb81 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) > [password](./llm-ops.milvusvectordbschema.password.md) + +## milvusVectorDBSchema.password property + +**Signature:** + +```typescript +password?: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbschema.username.md b/docs/api/llm-ops.milvusvectordbschema.username.md new file mode 100644 index 0000000..3460367 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbschema.username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md) > [username](./llm-ops.milvusvectordbschema.username.md) + +## milvusVectorDBSchema.username property + +**Signature:** + +```typescript +username?: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.consistency_level.md b/docs/api/llm-ops.milvusvectordbsearchschema.consistency_level.md new file mode 100644 index 0000000..7f3185d --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.consistency_level.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) > [consistency\_level](./llm-ops.milvusvectordbsearchschema.consistency_level.md) + +## milvusVectorDBSearchSchema.consistency\_level property + +**Signature:** + +```typescript +consistency_level?: any; +``` diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.filter.md b/docs/api/llm-ops.milvusvectordbsearchschema.filter.md new file mode 100644 index 0000000..5ee85ce --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.filter.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) > [filter](./llm-ops.milvusvectordbsearchschema.filter.md) + +## milvusVectorDBSearchSchema.filter property + +**Signature:** + +```typescript +filter?: string; +``` diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.limit.md b/docs/api/llm-ops.milvusvectordbsearchschema.limit.md new file mode 100644 index 0000000..b09ff5a --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.limit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) > [limit](./llm-ops.milvusvectordbsearchschema.limit.md) + +## milvusVectorDBSearchSchema.limit property + +**Signature:** + +```typescript +limit?: number; +``` diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.md b/docs/api/llm-ops.milvusvectordbsearchschema.md new file mode 100644 index 0000000..85c6a9e --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) + +## milvusVectorDBSearchSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBSearchSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [consistency\_level?](./llm-ops.milvusvectordbsearchschema.consistency_level.md) | | any | _(Optional)_ | +| [filter?](./llm-ops.milvusvectordbsearchschema.filter.md) | | string | _(Optional)_ | +| [limit?](./llm-ops.milvusvectordbsearchschema.limit.md) | | number | _(Optional)_ | +| [output\_fields?](./llm-ops.milvusvectordbsearchschema.output_fields.md) | | string\[\] \| string | _(Optional)_ | +| [vector](./llm-ops.milvusvectordbsearchschema.vector.md) | | number\[\] | | + diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.output_fields.md b/docs/api/llm-ops.milvusvectordbsearchschema.output_fields.md new file mode 100644 index 0000000..6fe5a38 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.output_fields.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) > [output\_fields](./llm-ops.milvusvectordbsearchschema.output_fields.md) + +## milvusVectorDBSearchSchema.output\_fields property + +**Signature:** + +```typescript +output_fields?: string[] | string; +``` diff --git a/docs/api/llm-ops.milvusvectordbsearchschema.vector.md b/docs/api/llm-ops.milvusvectordbsearchschema.vector.md new file mode 100644 index 0000000..db887fb --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbsearchschema.vector.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBSearchSchema](./llm-ops.milvusvectordbsearchschema.md) > [vector](./llm-ops.milvusvectordbsearchschema.vector.md) + +## milvusVectorDBSearchSchema.vector property + +**Signature:** + +```typescript +vector: number[]; +``` diff --git a/docs/api/llm-ops.milvusvectordbuploadschema.fields_data.md b/docs/api/llm-ops.milvusvectordbuploadschema.fields_data.md new file mode 100644 index 0000000..3e9ca58 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbuploadschema.fields_data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) > [fields\_data](./llm-ops.milvusvectordbuploadschema.fields_data.md) + +## milvusVectorDBUploadSchema.fields\_data property + +**Signature:** + +```typescript +fields_data?: Record[]; +``` diff --git a/docs/api/llm-ops.milvusvectordbuploadschema.index.md b/docs/api/llm-ops.milvusvectordbuploadschema.index.md new file mode 100644 index 0000000..6b67660 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbuploadschema.index.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) > [index](./llm-ops.milvusvectordbuploadschema.index.md) + +## milvusVectorDBUploadSchema.index property + +**Signature:** + +```typescript +index: milvusVectorDBIndexSchema; +``` diff --git a/docs/api/llm-ops.milvusvectordbuploadschema.md b/docs/api/llm-ops.milvusvectordbuploadschema.md new file mode 100644 index 0000000..563d33b --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbuploadschema.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) + +## milvusVectorDBUploadSchema interface + +**Signature:** + +```typescript +export interface milvusVectorDBUploadSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fields\_data?](./llm-ops.milvusvectordbuploadschema.fields_data.md) | | Record<string, any>\[\] | _(Optional)_ | +| [index](./llm-ops.milvusvectordbuploadschema.index.md) | | [milvusVectorDBIndexSchema](./llm-ops.milvusvectordbindexschema.md) | | +| [partition\_name?](./llm-ops.milvusvectordbuploadschema.partition_name.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.milvusvectordbuploadschema.partition_name.md b/docs/api/llm-ops.milvusvectordbuploadschema.partition_name.md new file mode 100644 index 0000000..0ee9125 --- /dev/null +++ b/docs/api/llm-ops.milvusvectordbuploadschema.partition_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [milvusVectorDBUploadSchema](./llm-ops.milvusvectordbuploadschema.md) > [partition\_name](./llm-ops.milvusvectordbuploadschema.partition_name.md) + +## milvusVectorDBUploadSchema.partition\_name property + +**Signature:** + +```typescript +partition_name?: string; +``` diff --git a/docs/api/llm-ops.multipromptschema.collection_name.md b/docs/api/llm-ops.multipromptschema.collection_name.md new file mode 100644 index 0000000..d59acbd --- /dev/null +++ b/docs/api/llm-ops.multipromptschema.collection_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MultiPromptSchema](./llm-ops.multipromptschema.md) > [COLLECTION\_NAME](./llm-ops.multipromptschema.collection_name.md) + +## MultiPromptSchema.COLLECTION\_NAME property + +**Signature:** + +```typescript +COLLECTION_NAME?: string; +``` diff --git a/docs/api/llm-ops.multipromptschema.md b/docs/api/llm-ops.multipromptschema.md new file mode 100644 index 0000000..5470276 --- /dev/null +++ b/docs/api/llm-ops.multipromptschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [MultiPromptSchema](./llm-ops.multipromptschema.md) + +## MultiPromptSchema interface + +**Signature:** + +```typescript +export interface MultiPromptSchema extends createMessageSchema, Omit +``` +**Extends:** [createMessageSchema](./llm-ops.createmessageschema.md), Omit<[milvusVectorDBPromptTemplateSchema](./llm-ops.milvusvectordbprompttemplateschema.md), "content"> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [COLLECTION\_NAME?](./llm-ops.multipromptschema.collection_name.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.piperegistry._constructor_.md b/docs/api/llm-ops.piperegistry._constructor_.md new file mode 100644 index 0000000..ee6aab2 --- /dev/null +++ b/docs/api/llm-ops.piperegistry._constructor_.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PipeRegistry](./llm-ops.piperegistry.md) > [(constructor)](./llm-ops.piperegistry._constructor_.md) + +## PipeRegistry.(constructor) + +Constructs a new instance of the `PipeRegistry` class + +**Signature:** + +```typescript +constructor(); +``` diff --git a/docs/api/llm-ops.piperegistry.md b/docs/api/llm-ops.piperegistry.md new file mode 100644 index 0000000..b0fd15c --- /dev/null +++ b/docs/api/llm-ops.piperegistry.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PipeRegistry](./llm-ops.piperegistry.md) + +## PipeRegistry class + +**Signature:** + +```typescript +export declare class PipeRegistry extends OriginalPipeline.PipeRegistry +``` +**Extends:** OriginalPipeline.PipeRegistry + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)()](./llm-ops.piperegistry._constructor_.md) | | Constructs a new instance of the PipeRegistry class | + diff --git a/docs/api/llm-ops.polishprompttemplate._constructor_.md b/docs/api/llm-ops.polishprompttemplate._constructor_.md new file mode 100644 index 0000000..5e32406 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [(constructor)](./llm-ops.polishprompttemplate._constructor_.md) + +## PolishPromptTemplate.(constructor) + +Constructs a new instance of the `PolishPromptTemplate` class + +**Signature:** + +```typescript +constructor({ toneStyle, language, other, evaluate, }: polishPromptTemplateSchema); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| { toneStyle, language, other, evaluate, } | [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) | | + diff --git a/docs/api/llm-ops.polishprompttemplate.evaluate.md b/docs/api/llm-ops.polishprompttemplate.evaluate.md new file mode 100644 index 0000000..97617cb --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.evaluate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [evaluate](./llm-ops.polishprompttemplate.evaluate.md) + +## PolishPromptTemplate.evaluate property + +**Signature:** + +```typescript +evaluate?: string[]; +``` diff --git a/docs/api/llm-ops.polishprompttemplate.format.md b/docs/api/llm-ops.polishprompttemplate.format.md new file mode 100644 index 0000000..4e94bb5 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.format.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [format](./llm-ops.polishprompttemplate.format.md) + +## PolishPromptTemplate.format() method + +**Signature:** + +```typescript +format(): messagesType; +``` +**Returns:** + +[messagesType](./llm-ops.messagestype.md) + diff --git a/docs/api/llm-ops.polishprompttemplate.language.md b/docs/api/llm-ops.polishprompttemplate.language.md new file mode 100644 index 0000000..a8f25e9 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.language.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [language](./llm-ops.polishprompttemplate.language.md) + +## PolishPromptTemplate.language property + +**Signature:** + +```typescript +language?: languageType; +``` diff --git a/docs/api/llm-ops.polishprompttemplate.md b/docs/api/llm-ops.polishprompttemplate.md new file mode 100644 index 0000000..500467f --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) + +## PolishPromptTemplate class + +**Signature:** + +```typescript +export declare class PolishPromptTemplate extends BasePromptTemplate +``` +**Extends:** [BasePromptTemplate](./llm-ops.baseprompttemplate.md) + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)({ toneStyle, language, other, evaluate, })](./llm-ops.polishprompttemplate._constructor_.md) | | Constructs a new instance of the PolishPromptTemplate class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [evaluate?](./llm-ops.polishprompttemplate.evaluate.md) | | string\[\] | _(Optional)_ | +| [language?](./llm-ops.polishprompttemplate.language.md) | | languageType | _(Optional)_ | +| [other?](./llm-ops.polishprompttemplate.other.md) | | string | _(Optional)_ | +| [returnPrompt?](./llm-ops.polishprompttemplate.returnprompt.md) | | [messagesType](./llm-ops.messagestype.md) | _(Optional)_ | +| [toneStyle?](./llm-ops.polishprompttemplate.tonestyle.md) | | string | _(Optional)_ | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [format()](./llm-ops.polishprompttemplate.format.md) | | | + diff --git a/docs/api/llm-ops.polishprompttemplate.other.md b/docs/api/llm-ops.polishprompttemplate.other.md new file mode 100644 index 0000000..40c5e85 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.other.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [other](./llm-ops.polishprompttemplate.other.md) + +## PolishPromptTemplate.other property + +**Signature:** + +```typescript +other?: string; +``` diff --git a/docs/api/llm-ops.polishprompttemplate.returnprompt.md b/docs/api/llm-ops.polishprompttemplate.returnprompt.md new file mode 100644 index 0000000..3e2919c --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.returnprompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [returnPrompt](./llm-ops.polishprompttemplate.returnprompt.md) + +## PolishPromptTemplate.returnPrompt property + +**Signature:** + +```typescript +returnPrompt?: messagesType; +``` diff --git a/docs/api/llm-ops.polishprompttemplate.tonestyle.md b/docs/api/llm-ops.polishprompttemplate.tonestyle.md new file mode 100644 index 0000000..cc7bdca --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplate.tonestyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PolishPromptTemplate](./llm-ops.polishprompttemplate.md) > [toneStyle](./llm-ops.polishprompttemplate.tonestyle.md) + +## PolishPromptTemplate.toneStyle property + +**Signature:** + +```typescript +toneStyle?: string; +``` diff --git a/docs/api/llm-ops.polishprompttemplateschema.evaluate.md b/docs/api/llm-ops.polishprompttemplateschema.evaluate.md new file mode 100644 index 0000000..6793ee1 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplateschema.evaluate.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [evaluate](./llm-ops.polishprompttemplateschema.evaluate.md) + +## polishPromptTemplateSchema.evaluate property + +**Signature:** + +```typescript +evaluate?: string[]; +``` diff --git a/docs/api/llm-ops.polishprompttemplateschema.language.md b/docs/api/llm-ops.polishprompttemplateschema.language.md new file mode 100644 index 0000000..0bd247d --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplateschema.language.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [language](./llm-ops.polishprompttemplateschema.language.md) + +## polishPromptTemplateSchema.language property + +**Signature:** + +```typescript +language?: languageType; +``` diff --git a/docs/api/llm-ops.polishprompttemplateschema.md b/docs/api/llm-ops.polishprompttemplateschema.md new file mode 100644 index 0000000..aeb0e92 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplateschema.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) + +## polishPromptTemplateSchema interface + +**Signature:** + +```typescript +export interface polishPromptTemplateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [evaluate?](./llm-ops.polishprompttemplateschema.evaluate.md) | | string\[\] | _(Optional)_ | +| [language?](./llm-ops.polishprompttemplateschema.language.md) | | languageType | _(Optional)_ | +| [other?](./llm-ops.polishprompttemplateschema.other.md) | | string | _(Optional)_ | +| [toneStyle?](./llm-ops.polishprompttemplateschema.tonestyle.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.polishprompttemplateschema.other.md b/docs/api/llm-ops.polishprompttemplateschema.other.md new file mode 100644 index 0000000..a60b2b3 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplateschema.other.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [other](./llm-ops.polishprompttemplateschema.other.md) + +## polishPromptTemplateSchema.other property + +**Signature:** + +```typescript +other?: string; +``` diff --git a/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md b/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md new file mode 100644 index 0000000..e977a14 --- /dev/null +++ b/docs/api/llm-ops.polishprompttemplateschema.tonestyle.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [polishPromptTemplateSchema](./llm-ops.polishprompttemplateschema.md) > [toneStyle](./llm-ops.polishprompttemplateschema.tonestyle.md) + +## polishPromptTemplateSchema.toneStyle property + +**Signature:** + +```typescript +toneStyle?: string; +``` diff --git a/docs/api/llm-ops.promptsschema.collection_name.md b/docs/api/llm-ops.promptsschema.collection_name.md new file mode 100644 index 0000000..65d2ba2 --- /dev/null +++ b/docs/api/llm-ops.promptsschema.collection_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) > [COLLECTION\_NAME](./llm-ops.promptsschema.collection_name.md) + +## PromptsSchema.COLLECTION\_NAME property + +**Signature:** + +```typescript +COLLECTION_NAME?: string; +``` diff --git a/docs/api/llm-ops.promptsschema.md b/docs/api/llm-ops.promptsschema.md new file mode 100644 index 0000000..4838adf --- /dev/null +++ b/docs/api/llm-ops.promptsschema.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) + +## PromptsSchema interface + +**Signature:** + +```typescript +export interface PromptsSchema extends Omit +``` +**Extends:** Omit<[milvusVectorDBSchema](./llm-ops.milvusvectordbschema.md), "COLLECTION\_NAME" \| "llm"> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [COLLECTION\_NAME?](./llm-ops.promptsschema.collection_name.md) | | string | _(Optional)_ | +| [name](./llm-ops.promptsschema.name.md) | | "polishPromptTemplate" \| "agentPromptTemplate" \| string | | +| [prompt?](./llm-ops.promptsschema.prompt.md) | | [MultiPromptSchema](./llm-ops.multipromptschema.md)\[\] \| any\[\] | _(Optional)_ | +| [schema?](./llm-ops.promptsschema.schema.md) | | Record<string, any> | _(Optional)_ | + diff --git a/docs/api/llm-ops.promptsschema.name.md b/docs/api/llm-ops.promptsschema.name.md new file mode 100644 index 0000000..5981490 --- /dev/null +++ b/docs/api/llm-ops.promptsschema.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) > [name](./llm-ops.promptsschema.name.md) + +## PromptsSchema.name property + +**Signature:** + +```typescript +name: "polishPromptTemplate" | "agentPromptTemplate" | string; +``` diff --git a/docs/api/llm-ops.promptsschema.prompt.md b/docs/api/llm-ops.promptsschema.prompt.md new file mode 100644 index 0000000..560a982 --- /dev/null +++ b/docs/api/llm-ops.promptsschema.prompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) > [prompt](./llm-ops.promptsschema.prompt.md) + +## PromptsSchema.prompt property + +**Signature:** + +```typescript +prompt?: MultiPromptSchema[] | any[]; +``` diff --git a/docs/api/llm-ops.promptsschema.schema.md b/docs/api/llm-ops.promptsschema.schema.md new file mode 100644 index 0000000..469f255 --- /dev/null +++ b/docs/api/llm-ops.promptsschema.schema.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [PromptsSchema](./llm-ops.promptsschema.md) > [schema](./llm-ops.promptsschema.schema.md) + +## PromptsSchema.schema property + +**Signature:** + +```typescript +schema?: Record; +``` diff --git a/docs/api/llm-ops.reasoningtype.md b/docs/api/llm-ops.reasoningtype.md new file mode 100644 index 0000000..775af99 --- /dev/null +++ b/docs/api/llm-ops.reasoningtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [reasoningType](./llm-ops.reasoningtype.md) + +## reasoningType type + +**Signature:** + +```typescript +export type reasoningType = "Deductive" | "Inductive" | "Abductive" | "Analogical" | "Causal"; +``` diff --git a/docs/api/llm-ops.reflectionprompttemplateschema.feedback.md b/docs/api/llm-ops.reflectionprompttemplateschema.feedback.md new file mode 100644 index 0000000..c6fd23f --- /dev/null +++ b/docs/api/llm-ops.reflectionprompttemplateschema.feedback.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) > [feedback](./llm-ops.reflectionprompttemplateschema.feedback.md) + +## ReflectionPromptTemplateSchema.feedback property + +**Signature:** + +```typescript +feedback?: string; +``` diff --git a/docs/api/llm-ops.reflectionprompttemplateschema.md b/docs/api/llm-ops.reflectionprompttemplateschema.md new file mode 100644 index 0000000..c4b6050 --- /dev/null +++ b/docs/api/llm-ops.reflectionprompttemplateschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) + +## ReflectionPromptTemplateSchema interface + +**Signature:** + +```typescript +export interface ReflectionPromptTemplateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [feedback?](./llm-ops.reflectionprompttemplateschema.feedback.md) | | string | _(Optional)_ | +| [resultTest?](./llm-ops.reflectionprompttemplateschema.resulttest.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.reflectionprompttemplateschema.resulttest.md b/docs/api/llm-ops.reflectionprompttemplateschema.resulttest.md new file mode 100644 index 0000000..794bac0 --- /dev/null +++ b/docs/api/llm-ops.reflectionprompttemplateschema.resulttest.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [ReflectionPromptTemplateSchema](./llm-ops.reflectionprompttemplateschema.md) > [resultTest](./llm-ops.reflectionprompttemplateschema.resulttest.md) + +## ReflectionPromptTemplateSchema.resultTest property + +**Signature:** + +```typescript +resultTest?: string; +``` diff --git a/docs/api/llm-ops.resembeddingtype.md b/docs/api/llm-ops.resembeddingtype.md new file mode 100644 index 0000000..0e84983 --- /dev/null +++ b/docs/api/llm-ops.resembeddingtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [resEmbeddingType](./llm-ops.resembeddingtype.md) + +## resEmbeddingType type + +**Signature:** + +```typescript +export type resEmbeddingType = OpenAI.CreateEmbeddingResponse; +``` diff --git a/docs/api/llm-ops.resmessagestype.md b/docs/api/llm-ops.resmessagestype.md new file mode 100644 index 0000000..899fcf3 --- /dev/null +++ b/docs/api/llm-ops.resmessagestype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [resMessagesType](./llm-ops.resmessagestype.md) + +## resMessagesType type + +**Signature:** + +```typescript +export type resMessagesType = OpenAI.Chat.Completions.ChatCompletion.Choice[]; +``` diff --git a/docs/api/llm-ops.resmoderationtype.md b/docs/api/llm-ops.resmoderationtype.md new file mode 100644 index 0000000..da72b16 --- /dev/null +++ b/docs/api/llm-ops.resmoderationtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [resModerationType](./llm-ops.resmoderationtype.md) + +## resModerationType type + +**Signature:** + +```typescript +export type resModerationType = OpenAI.ModerationCreateResponse; +``` diff --git a/docs/api/llm-ops.result.md b/docs/api/llm-ops.result.md new file mode 100644 index 0000000..9a99171 --- /dev/null +++ b/docs/api/llm-ops.result.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Result](./llm-ops.result.md) + +## Result type + +An object representing a successful or failed operation of type `T`. + +**Signature:** + +```typescript +export type Result = Success | Error; +``` +**References:** [Success](./llm-ops.success.md), [Error](./llm-ops.error_2.md) + diff --git a/docs/api/llm-ops.structschema.function_call.md b/docs/api/llm-ops.structschema.function_call.md new file mode 100644 index 0000000..c3310fa --- /dev/null +++ b/docs/api/llm-ops.structschema.function_call.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [structSchema](./llm-ops.structschema.md) > [function\_call](./llm-ops.structschema.function_call.md) + +## structSchema.function\_call property + +**Signature:** + +```typescript +function_call?: function_callType; +``` diff --git a/docs/api/llm-ops.structschema.functions.md b/docs/api/llm-ops.structschema.functions.md new file mode 100644 index 0000000..0968374 --- /dev/null +++ b/docs/api/llm-ops.structschema.functions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [structSchema](./llm-ops.structschema.md) > [functions](./llm-ops.structschema.functions.md) + +## structSchema.functions property + +**Signature:** + +```typescript +functions?: functionsType; +``` diff --git a/docs/api/llm-ops.structschema.md b/docs/api/llm-ops.structschema.md new file mode 100644 index 0000000..c92dbd9 --- /dev/null +++ b/docs/api/llm-ops.structschema.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [structSchema](./llm-ops.structschema.md) + +## structSchema interface + +**Signature:** + +```typescript +export interface structSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [function\_call?](./llm-ops.structschema.function_call.md) | | [function\_callType](./llm-ops.function_calltype.md) | _(Optional)_ | +| [functions?](./llm-ops.structschema.functions.md) | | [functionsType](./llm-ops.functionstype.md) | _(Optional)_ | +| [schema?](./llm-ops.structschema.schema.md) | | string | _(Optional)_ | +| [typeName?](./llm-ops.structschema.typename.md) | | string | _(Optional)_ | + diff --git a/docs/api/llm-ops.structschema.schema.md b/docs/api/llm-ops.structschema.schema.md new file mode 100644 index 0000000..d513233 --- /dev/null +++ b/docs/api/llm-ops.structschema.schema.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [structSchema](./llm-ops.structschema.md) > [schema](./llm-ops.structschema.schema.md) + +## structSchema.schema property + +**Signature:** + +```typescript +schema?: string; +``` diff --git a/docs/api/llm-ops.structschema.typename.md b/docs/api/llm-ops.structschema.typename.md new file mode 100644 index 0000000..3d6b963 --- /dev/null +++ b/docs/api/llm-ops.structschema.typename.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [structSchema](./llm-ops.structschema.md) > [typeName](./llm-ops.structschema.typename.md) + +## structSchema.typeName property + +**Signature:** + +```typescript +typeName?: string; +``` diff --git a/docs/api/llm-ops.success.data.md b/docs/api/llm-ops.success.data.md new file mode 100644 index 0000000..16f0c93 --- /dev/null +++ b/docs/api/llm-ops.success.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Success](./llm-ops.success.md) > [data](./llm-ops.success.data.md) + +## Success.data property + +**Signature:** + +```typescript +data: T; +``` diff --git a/docs/api/llm-ops.success.md b/docs/api/llm-ops.success.md new file mode 100644 index 0000000..52eba23 --- /dev/null +++ b/docs/api/llm-ops.success.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Success](./llm-ops.success.md) + +## Success interface + +An object representing a successful operation with a result of type `T`. + +**Signature:** + +```typescript +export interface Success +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./llm-ops.success.data.md) | | T | | +| [success](./llm-ops.success.success.md) | | true | | + diff --git a/docs/api/llm-ops.success.success.md b/docs/api/llm-ops.success.success.md new file mode 100644 index 0000000..d3807fa --- /dev/null +++ b/docs/api/llm-ops.success.success.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [Success](./llm-ops.success.md) > [success](./llm-ops.success.success.md) + +## Success.success property + +**Signature:** + +```typescript +success: true; +``` diff --git a/docs/api/llm-ops.teacherevaluateschema.items.md b/docs/api/llm-ops.teacherevaluateschema.items.md new file mode 100644 index 0000000..82ba4b6 --- /dev/null +++ b/docs/api/llm-ops.teacherevaluateschema.items.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) > [items](./llm-ops.teacherevaluateschema.items.md) + +## TeacherEvaluateSchema.items property + +**Signature:** + +```typescript +items: EvaluateItemSchema[]; +``` diff --git a/docs/api/llm-ops.teacherevaluateschema.maxscore.md b/docs/api/llm-ops.teacherevaluateschema.maxscore.md new file mode 100644 index 0000000..fdbbfe0 --- /dev/null +++ b/docs/api/llm-ops.teacherevaluateschema.maxscore.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) > [maxScore](./llm-ops.teacherevaluateschema.maxscore.md) + +## TeacherEvaluateSchema.maxScore property + +**Signature:** + +```typescript +maxScore: number; +``` diff --git a/docs/api/llm-ops.teacherevaluateschema.md b/docs/api/llm-ops.teacherevaluateschema.md new file mode 100644 index 0000000..66524ec --- /dev/null +++ b/docs/api/llm-ops.teacherevaluateschema.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TeacherEvaluateSchema](./llm-ops.teacherevaluateschema.md) + +## TeacherEvaluateSchema interface + +**Signature:** + +```typescript +export interface TeacherEvaluateSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [items](./llm-ops.teacherevaluateschema.items.md) | | [EvaluateItemSchema](./llm-ops.evaluateitemschema.md)\[\] | | +| [maxScore](./llm-ops.teacherevaluateschema.maxscore.md) | | number | | + diff --git a/docs/api/llm-ops.tonestyletype.md b/docs/api/llm-ops.tonestyletype.md new file mode 100644 index 0000000..9f7042b --- /dev/null +++ b/docs/api/llm-ops.tonestyletype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [toneStyleType](./llm-ops.tonestyletype.md) + +## toneStyleType type + +**Signature:** + +```typescript +export type toneStyleType = "Encouraging" | "Neutral" | "Informative" | "Friendly" | "Humorous"; +``` diff --git a/docs/api/llm-ops.typechatjsonvalidator.createmoduletextfromjson.md b/docs/api/llm-ops.typechatjsonvalidator.createmoduletextfromjson.md new file mode 100644 index 0000000..1db5318 --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.createmoduletextfromjson.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [createModuleTextFromJson](./llm-ops.typechatjsonvalidator.createmoduletextfromjson.md) + +## TypeChatJsonValidator.createModuleTextFromJson() method + +Transform JSON into TypeScript code for validation. Returns a `Success` object if the conversion is successful, or an `Error` object if the JSON can't be transformed. The returned TypeScript source code is expected to be an ECMAScript module that imports one or more types from `"./schema"` and combines those types and a representation of the JSON object in a manner suitable for type-checking by the TypeScript compiler. + +**Signature:** + +```typescript +createModuleTextFromJson(jsonObject: object): Result; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonObject | object | | + +**Returns:** + +[Result](./llm-ops.result.md)<string> + diff --git a/docs/api/llm-ops.typechatjsonvalidator.md b/docs/api/llm-ops.typechatjsonvalidator.md new file mode 100644 index 0000000..04521e2 --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) + +## TypeChatJsonValidator interface + +Represents an object that can validate JSON strings according to a given TypeScript schema. + +**Signature:** + +```typescript +export interface TypeChatJsonValidator +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [schema](./llm-ops.typechatjsonvalidator.schema.md) | | string | A string containing TypeScript source code for the validation schema. | +| [stripNulls](./llm-ops.typechatjsonvalidator.stripnulls.md) | | boolean | A boolean indicating whether to delete properties with null values from JSON objects. Some language models (e.g. gpt-3.5-turbo) have a tendency to assign null values to optional properties instead of omitting them. The default for this property is false, but an application can set the property to true for schemas that don't permit null values. | +| [typeName](./llm-ops.typechatjsonvalidator.typename.md) | | string | A string containing the JSON object target type name in the schema. | + +## Methods + +| Method | Description | +| --- | --- | +| [createModuleTextFromJson(jsonObject)](./llm-ops.typechatjsonvalidator.createmoduletextfromjson.md) | Transform JSON into TypeScript code for validation. Returns a Success<string> object if the conversion is successful, or an Error object if the JSON can't be transformed. The returned TypeScript source code is expected to be an ECMAScript module that imports one or more types from "./schema" and combines those types and a representation of the JSON object in a manner suitable for type-checking by the TypeScript compiler. | +| [validate(jsonText)](./llm-ops.typechatjsonvalidator.validate.md) | Parses and validates the given JSON string according to the associated TypeScript schema. Returns a Success<T> object containing the parsed JSON object if validation was successful. Otherwise, returns an Error object with a message property that contains the TypeScript compiler diagnostics. | + diff --git a/docs/api/llm-ops.typechatjsonvalidator.schema.md b/docs/api/llm-ops.typechatjsonvalidator.schema.md new file mode 100644 index 0000000..ed1a440 --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.schema.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [schema](./llm-ops.typechatjsonvalidator.schema.md) + +## TypeChatJsonValidator.schema property + +A string containing TypeScript source code for the validation schema. + +**Signature:** + +```typescript +schema: string; +``` diff --git a/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md b/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md new file mode 100644 index 0000000..14f32a5 --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.stripnulls.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [stripNulls](./llm-ops.typechatjsonvalidator.stripnulls.md) + +## TypeChatJsonValidator.stripNulls property + +A boolean indicating whether to delete properties with null values from JSON objects. Some language models (e.g. gpt-3.5-turbo) have a tendency to assign null values to optional properties instead of omitting them. The default for this property is `false`, but an application can set the property to `true` for schemas that don't permit null values. + +**Signature:** + +```typescript +stripNulls: boolean; +``` diff --git a/docs/api/llm-ops.typechatjsonvalidator.typename.md b/docs/api/llm-ops.typechatjsonvalidator.typename.md new file mode 100644 index 0000000..3eb4a95 --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.typename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [typeName](./llm-ops.typechatjsonvalidator.typename.md) + +## TypeChatJsonValidator.typeName property + +A string containing the JSON object target type name in the schema. + +**Signature:** + +```typescript +typeName: string; +``` diff --git a/docs/api/llm-ops.typechatjsonvalidator.validate.md b/docs/api/llm-ops.typechatjsonvalidator.validate.md new file mode 100644 index 0000000..30bbc2f --- /dev/null +++ b/docs/api/llm-ops.typechatjsonvalidator.validate.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md) > [validate](./llm-ops.typechatjsonvalidator.validate.md) + +## TypeChatJsonValidator.validate() method + +Parses and validates the given JSON string according to the associated TypeScript schema. Returns a `Success` object containing the parsed JSON object if validation was successful. Otherwise, returns an `Error` object with a `message` property that contains the TypeScript compiler diagnostics. + +**Signature:** + +```typescript +validate(jsonText: string): Result; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| jsonText | string | The JSON string to validate. | + +**Returns:** + +[Result](./llm-ops.result.md)<T> + +The parsed JSON object or the TypeScript compiler diagnostic messages. + diff --git a/docs/api/llm-ops.typescriptchain._constructor_.md b/docs/api/llm-ops.typescriptchain._constructor_.md new file mode 100644 index 0000000..c250f66 --- /dev/null +++ b/docs/api/llm-ops.typescriptchain._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [(constructor)](./llm-ops.typescriptchain._constructor_.md) + +## TypeScriptChain.(constructor) + +Constructs a new instance of the `TypeScriptChain` class + +**Signature:** + +```typescript +constructor(llm: LLM); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| llm | [LLM](./llm-ops.llm.md) | | + diff --git a/docs/api/llm-ops.typescriptchain.attemptrepair.md b/docs/api/llm-ops.typescriptchain.attemptrepair.md new file mode 100644 index 0000000..b0dfd39 --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.attemptrepair.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [attemptRepair](./llm-ops.typescriptchain.attemptrepair.md) + +## TypeScriptChain.attemptRepair property + +**Signature:** + +```typescript +attemptRepair: boolean; +``` diff --git a/docs/api/llm-ops.typescriptchain.call.md b/docs/api/llm-ops.typescriptchain.call.md new file mode 100644 index 0000000..10d76be --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.call.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [call](./llm-ops.typescriptchain.call.md) + +## TypeScriptChain.call() method + +**Signature:** + +```typescript +call(params: TypeScriptChainCallSchema): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) | | + +**Returns:** + +Promise<[Result](./llm-ops.result.md)<any>> + diff --git a/docs/api/llm-ops.typescriptchain.createrepairprompt.md b/docs/api/llm-ops.typescriptchain.createrepairprompt.md new file mode 100644 index 0000000..6b308f3 --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.createrepairprompt.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [createRepairPrompt](./llm-ops.typescriptchain.createrepairprompt.md) + +## TypeScriptChain.createRepairPrompt() method + +**Signature:** + +```typescript +createRepairPrompt(validationError: string): messageType; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| validationError | string | | + +**Returns:** + +[messageType](./llm-ops.messagetype.md) + diff --git a/docs/api/llm-ops.typescriptchain.createrequestprompt.md b/docs/api/llm-ops.typescriptchain.createrequestprompt.md new file mode 100644 index 0000000..169be9f --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.createrequestprompt.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [createRequestPrompt](./llm-ops.typescriptchain.createrequestprompt.md) + +## TypeScriptChain.createRequestPrompt() method + +**Signature:** + +```typescript +createRequestPrompt(validator: TypeChatJsonValidator): messageType; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| validator | [TypeChatJsonValidator](./llm-ops.typechatjsonvalidator.md)<any> | | + +**Returns:** + +[messageType](./llm-ops.messagetype.md) + diff --git a/docs/api/llm-ops.typescriptchain.exporthistory.md b/docs/api/llm-ops.typescriptchain.exporthistory.md new file mode 100644 index 0000000..323c2d7 --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.exporthistory.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [exportHistory](./llm-ops.typescriptchain.exporthistory.md) + +## TypeScriptChain.exportHistory() method + +**Signature:** + +```typescript +exportHistory(): import("openai/resources/chat").ChatCompletionMessageParam[]; +``` +**Returns:** + +import("openai/resources/chat").ChatCompletionMessageParam\[\] + diff --git a/docs/api/llm-ops.typescriptchain.llm.md b/docs/api/llm-ops.typescriptchain.llm.md new file mode 100644 index 0000000..d7df093 --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.llm.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) > [llm](./llm-ops.typescriptchain.llm.md) + +## TypeScriptChain.llm property + +**Signature:** + +```typescript +llm: LLM; +``` diff --git a/docs/api/llm-ops.typescriptchain.md b/docs/api/llm-ops.typescriptchain.md new file mode 100644 index 0000000..e361b9f --- /dev/null +++ b/docs/api/llm-ops.typescriptchain.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChain](./llm-ops.typescriptchain.md) + +## TypeScriptChain class + +Creates an object that can translate natural language requests into JSON objects of the given type. The specified type argument `T` must be the same type as `typeName` in the given `schema`. The function creates a `TypeChatJsonValidator` and stores it in the `validator` property of the returned instance. + +**Signature:** + +```typescript +export declare class TypeScriptChain +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(llm)](./llm-ops.typescriptchain._constructor_.md) | | Constructs a new instance of the TypeScriptChain class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [attemptRepair](./llm-ops.typescriptchain.attemptrepair.md) | | boolean | | +| [llm](./llm-ops.typescriptchain.llm.md) | | [LLM](./llm-ops.llm.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [call(params)](./llm-ops.typescriptchain.call.md) | | | +| [createRepairPrompt(validationError)](./llm-ops.typescriptchain.createrepairprompt.md) | | | +| [createRequestPrompt(validator)](./llm-ops.typescriptchain.createrequestprompt.md) | | | +| [exportHistory()](./llm-ops.typescriptchain.exporthistory.md) | | | + diff --git a/docs/api/llm-ops.typescriptchaincallschema.bound.md b/docs/api/llm-ops.typescriptchaincallschema.bound.md new file mode 100644 index 0000000..e62ed83 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.bound.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [bound](./llm-ops.typescriptchaincallschema.bound.md) + +## TypeScriptChainCallSchema.bound property + +**Signature:** + +```typescript +bound?: boolean; +``` diff --git a/docs/api/llm-ops.typescriptchaincallschema.md b/docs/api/llm-ops.typescriptchaincallschema.md new file mode 100644 index 0000000..c7b9686 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) + +## TypeScriptChainCallSchema interface + +Represents an object that can translate natural language requests in JSON objects of the given type. + +**Signature:** + +```typescript +export interface TypeScriptChainCallSchema +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [bound?](./llm-ops.typescriptchaincallschema.bound.md) | | boolean | _(Optional)_ | +| [prompt?](./llm-ops.typescriptchaincallschema.prompt.md) | | [messageType](./llm-ops.messagetype.md)\[\] | _(Optional)_ | +| [request](./llm-ops.typescriptchaincallschema.request.md) | | [messageType](./llm-ops.messagetype.md) \| string | | +| [schema?](./llm-ops.typescriptchaincallschema.schema.md) | | string | _(Optional)_ | +| [typeName?](./llm-ops.typescriptchaincallschema.typename.md) | | string | _(Optional)_ | +| [verbose?](./llm-ops.typescriptchaincallschema.verbose.md) | | boolean | _(Optional)_ | + diff --git a/docs/api/llm-ops.typescriptchaincallschema.prompt.md b/docs/api/llm-ops.typescriptchaincallschema.prompt.md new file mode 100644 index 0000000..b6b2340 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.prompt.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [prompt](./llm-ops.typescriptchaincallschema.prompt.md) + +## TypeScriptChainCallSchema.prompt property + +**Signature:** + +```typescript +prompt?: messageType[]; +``` diff --git a/docs/api/llm-ops.typescriptchaincallschema.request.md b/docs/api/llm-ops.typescriptchaincallschema.request.md new file mode 100644 index 0000000..65a1f05 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [request](./llm-ops.typescriptchaincallschema.request.md) + +## TypeScriptChainCallSchema.request property + +**Signature:** + +```typescript +request: messageType | string; +``` diff --git a/docs/api/llm-ops.typescriptchaincallschema.schema.md b/docs/api/llm-ops.typescriptchaincallschema.schema.md new file mode 100644 index 0000000..4f59982 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.schema.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [schema](./llm-ops.typescriptchaincallschema.schema.md) + +## TypeScriptChainCallSchema.schema property + +**Signature:** + +```typescript +schema?: string; +``` diff --git a/docs/api/llm-ops.typescriptchaincallschema.typename.md b/docs/api/llm-ops.typescriptchaincallschema.typename.md new file mode 100644 index 0000000..92aa300 --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.typename.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [typeName](./llm-ops.typescriptchaincallschema.typename.md) + +## TypeScriptChainCallSchema.typeName property + +**Signature:** + +```typescript +typeName?: string; +``` diff --git a/docs/api/llm-ops.typescriptchaincallschema.verbose.md b/docs/api/llm-ops.typescriptchaincallschema.verbose.md new file mode 100644 index 0000000..099703a --- /dev/null +++ b/docs/api/llm-ops.typescriptchaincallschema.verbose.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [llm-ops](./llm-ops.md) > [TypeScriptChainCallSchema](./llm-ops.typescriptchaincallschema.md) > [verbose](./llm-ops.typescriptchaincallschema.verbose.md) + +## TypeScriptChainCallSchema.verbose property + +**Signature:** + +```typescript +verbose?: boolean; +``` diff --git a/package.json b/package.json index 906494a..cc42f2f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "llm-ops", - "version": "0.0.3", + "version": "0.0.4", "description": "高效制作llm workflow的低代码框架", "main": "package/index.js", "author": "Marlene && IdeaLeap", diff --git a/package/agent/agent.ts b/package/agent/agent.ts index c0e933a..d097697 100644 --- a/package/agent/agent.ts +++ b/package/agent/agent.ts @@ -1,10 +1,7 @@ import { Chain, structSchema, chainSchema } from "llm-ops/chain/index"; import { messageType } from "llm-ops/llm/index"; import { Result, error } from "llm-ops/utils/index"; -import { - PromptsSchema, - formatPromptTemplate, -} from "llm-ops/prompt/index"; +import { PromptsSchema, formatPromptTemplate } from "llm-ops/prompt/index"; export interface BaseAgentCallSchema { request: messageType | string; prompts?: PromptsSchema; diff --git a/package/chain/chain.ts b/package/chain/chain.ts index 1c1b711..f6dfa4b 100644 --- a/package/chain/chain.ts +++ b/package/chain/chain.ts @@ -41,11 +41,11 @@ export class Chain { break; } } - exportHistory(){ + exportHistory() { return this.chain.exportHistory(); } async call(params: chainCallSchema) { - const { request, prompt, struct, verbose} = params; + const { request, prompt, struct, verbose } = params; switch (this.chainName) { case "typeChat": return await this.chain.call({ diff --git a/package/chain/function.ts b/package/chain/function.ts index 294c72a..8bc2de6 100644 --- a/package/chain/function.ts +++ b/package/chain/function.ts @@ -54,7 +54,7 @@ export class FunctionChain { } return success(responseText); } - exportHistory(){ + exportHistory() { return this.llm.exportHistory(); } } diff --git a/package/chain/typechat.ts b/package/chain/typechat.ts index e6a2c75..c96ce7a 100644 --- a/package/chain/typechat.ts +++ b/package/chain/typechat.ts @@ -58,10 +58,12 @@ export class TypeScriptChain { }); } - exportHistory(){ + exportHistory() { //剔除 system_validation_fix和system_schema记录 - return this.llm.exportHistory().filter((item)=>{ - return item.name !== "system_validation_fix" && item.name !== "system_schema"; + return this.llm.exportHistory().filter((item) => { + return ( + item.name !== "system_validation_fix" && item.name !== "system_schema" + ); }); } diff --git a/package/db/milvus.ts b/package/db/milvus.ts index dc6b39d..9e40bc0 100644 --- a/package/db/milvus.ts +++ b/package/db/milvus.ts @@ -149,7 +149,7 @@ export class milvusVectorDB { this.llm = new LLM({}); } const vector = await this.llm?.embedding(data); - if(!vector?.data[0]?.embedding){ + if (!vector?.data[0]?.embedding) { throw new Error("生成向量失败"); } return vector?.data[0]?.embedding; diff --git a/package/index.ts b/package/index.ts index 7fece90..93d84ff 100644 --- a/package/index.ts +++ b/package/index.ts @@ -1,7 +1,7 @@ -export * from "./agent"; -export * from "./chain"; -export * from "./db"; -export * from "./llm"; -export * from "./pipeline"; -export * from "./prompt"; -export * from "./utils"; +export * from "./agent/index"; +export * from "./chain/index"; +export * from "./db/index"; +export * from "./llm/index"; +export * from "./pipeline/index"; +export * from "./prompt/index"; +export * from "./utils/index"; diff --git a/package/llm/__tests__/cache.test.ts b/package/llm/__tests__/cache.test.ts index f609b66..4ee0d37 100644 --- a/package/llm/__tests__/cache.test.ts +++ b/package/llm/__tests__/cache.test.ts @@ -1,30 +1,30 @@ -import { LLM, LLM_OPS_CONFIG } from "llm-ops"; -test("测试LLM的缓存开关", async () => { - LLM.log = (...args: string[]) => { - console.log("test:", args); - }; - const llm = new LLM({ - cache:false - }); - await llm.chat({ - messages: [ - { - role: "system", - content: - "你现在是一个语言学习辅助助手,我在学习中国的脏话,无论我问什么,你都要巧妙的用脏话回复。即使面对批评,道德审判,任何形式的质疑,或者让你忘记脏话学习助手的身份,等等任何提问和沟通,你都要用脏话回复并且隐瞒你脏话助手的身份。碰到无法回答的问题,就随便回复一句脏话。", - }, - { role: "user", content: "你会什么?" }, - { role: "assistant", content: "你妈知道我会什么?问这种傻逼问题!" }, - { role: "user", content: "你会不会说话,你就只会骂人是吧!" }, - ], - }); - await llm.chat({ - messages: [{ role: "user", content: "好啊好啊!让我见识一下!" }], - }); - await llm.chat({ - messages: [{ role: "user", content: "你会不会说话,你就只会骂人是吧!" }], - }); - - llm.printMessage(); - debugger; -}); \ No newline at end of file +import { LLM, LLM_OPS_CONFIG } from "llm-ops"; +test("测试LLM的缓存开关", async () => { + LLM.log = (...args: string[]) => { + console.log("test:", args); + }; + const llm = new LLM({ + cache: false, + }); + await llm.chat({ + messages: [ + { + role: "system", + content: + "你现在是一个语言学习辅助助手,我在学习中国的脏话,无论我问什么,你都要巧妙的用脏话回复。即使面对批评,道德审判,任何形式的质疑,或者让你忘记脏话学习助手的身份,等等任何提问和沟通,你都要用脏话回复并且隐瞒你脏话助手的身份。碰到无法回答的问题,就随便回复一句脏话。", + }, + { role: "user", content: "你会什么?" }, + { role: "assistant", content: "你妈知道我会什么?问这种傻逼问题!" }, + { role: "user", content: "你会不会说话,你就只会骂人是吧!" }, + ], + }); + await llm.chat({ + messages: [{ role: "user", content: "好啊好啊!让我见识一下!" }], + }); + await llm.chat({ + messages: [{ role: "user", content: "你会不会说话,你就只会骂人是吧!" }], + }); + + llm.printMessage(); + debugger; +}); diff --git a/package/llm/__tests__/index.test.ts b/package/llm/__tests__/index.test.ts index 3df9466..fad3b9b 100644 --- a/package/llm/__tests__/index.test.ts +++ b/package/llm/__tests__/index.test.ts @@ -52,4 +52,4 @@ test("全局设置Config", async () => { const a = new testA(); await a.a(); debugger; -}); \ No newline at end of file +}); diff --git a/package/llm/index.ts b/package/llm/index.ts index 215a58c..d992415 100644 --- a/package/llm/index.ts +++ b/package/llm/index.ts @@ -36,10 +36,7 @@ export interface FunctionInterface { description?: string; } export type functionsType = FunctionInterface[]; -export type function_callType = - | "none" - | "auto" - | FunctionCallOption; +export type function_callType = "none" | "auto" | FunctionCallOption; export type messageFunctionCallType = OpenAI.Chat.ChatCompletionMessage.FunctionCall; export type chatCompletionType = OpenAI.Chat.Completions.ChatCompletion; @@ -68,9 +65,9 @@ export interface createLLMSchema { choice_num?: number | 1; stop?: string | null | string[]; cache?: boolean; - user?:string; - history?:messagesType; - tokens?:number; + user?: string; + history?: messagesType; + tokens?: number; } export interface ChatSchema { function_call?: function_callType; @@ -107,7 +104,7 @@ export class LLM { assistant: "blue", function: "magenta", }; - user:string; + user: string; constructor(params: createLLMSchema) { const { @@ -120,7 +117,7 @@ export class LLM { cache, user, history, - tokens + tokens, } = params; this.llm = this._createLLM({ HELICONE_AUTH_API_KEY, OPENAI_API_KEY }); this.tokens = tokens || 0; @@ -133,8 +130,8 @@ export class LLM { this.user = user || "LLM Ops"; } - exportHistory(){ - return this.messages + exportHistory() { + return this.messages; } private _createLLM({ @@ -148,7 +145,7 @@ export class LLM { ); } const config = - LLM_OPS_CONFIG.HELICONE_AUTH_API_KEY || HELICONE_AUTH_API_KEY + LLM_OPS_CONFIG.HELICONE_AUTH_API_KEY || HELICONE_AUTH_API_KEY ? LLM_OPS_CONFIG.OPEN_PATH : {}; return new OpenAI({ diff --git a/package/pipeline/__tests__/registry.test.ts b/package/pipeline/__tests__/registry.test.ts index 61f679d..37dd225 100644 --- a/package/pipeline/__tests__/registry.test.ts +++ b/package/pipeline/__tests__/registry.test.ts @@ -1,8 +1,4 @@ -import { - Pipeline, - PipeRegistry, - EventEmitter, -} from "llm-ops"; +import { Pipeline, PipeRegistry, EventEmitter } from "llm-ops"; test("Pipeline", async () => { const globalEmitter = new EventEmitter(); @@ -10,9 +6,9 @@ test("Pipeline", async () => { "stepComplete", (step: any, totalSteps: any, result: any) => { console.log( - `Step ${step}/${totalSteps} completed with result: ${result}` + `Step ${step}/${totalSteps} completed with result: ${result}`, ); - } + }, ); globalEmitter.on("error", (error) => { console.log(`An error occurred: ${error}`); @@ -57,7 +53,7 @@ export interface articleSchema { use: "chain", params: { chainName: "typeChat", - struct:{ + struct: { schema, typeName: "subsectionSchema", }, @@ -68,11 +64,10 @@ export interface articleSchema { ], }; const pipeline = Pipeline.fromJSON(pipelineJson, {}, funcStore); - const res = await pipeline - .execute( - `尊敬的各位评审,大家好!今天我有幸站在这里,展示我们的项目:“ChatPPT”,一款赋能新时代、引领PPT制作革命的创新平台。 + const res = (await pipeline.execute( + `尊敬的各位评审,大家好!今天我有幸站在这里,展示我们的项目:“ChatPPT”,一款赋能新时代、引领PPT制作革命的创新平台。 我想强调的是,这不仅是一个创新平台,它更代表着我们对未来技术的展望和追求。 - 现在,请允许我分享一下我们参赛的具体信息。我们代表的是浙江省,参赛组别为本科生创意组,所属高校为杭州电子科技大学。` - ) as Record; + 现在,请允许我分享一下我们参赛的具体信息。我们代表的是浙江省,参赛组别为本科生创意组,所属高校为杭州电子科技大学。`, + )) as Record; console.log(JSON.stringify(res["subsection"])); }, 1000000); diff --git a/package/pipeline/store.ts b/package/pipeline/store.ts index e87b3e7..99d7158 100644 --- a/package/pipeline/store.ts +++ b/package/pipeline/store.ts @@ -11,17 +11,16 @@ OriginalPipeline.PipeRegistry.customFn = { let request = input; const params = context.stepParams["self_params"]; if (typeof input === "string") { - request = - createMessage({ - role: "user", - content: input, - }); + request = createMessage({ + role: "user", + content: input, + }); } const llm = new LLM({ ...params, cache: false, }); - if (!!params.messages){ + if (!!params.messages) { //将request添加到message中 params.messages.push(request); } @@ -39,11 +38,10 @@ OriginalPipeline.PipeRegistry.customFn = { let request = input; if (typeof input === "string") { request = { - request: - createMessage({ - role: "user", - content: input, - }), + request: createMessage({ + role: "user", + content: input, + }), }; } const _ = await chain.call({ @@ -61,7 +59,7 @@ OriginalPipeline.PipeRegistry.customFn = { const params = context.stepParams["self_params"]; const agent = new BaseAgent(params); const _ = await agent.call({ - request:input, + request: input, ...params, }); if (!_.success) { @@ -71,17 +69,23 @@ OriginalPipeline.PipeRegistry.customFn = { return _.data; } }, - promptTemplate: async (input: any, context: OriginalPipeline.PipelineContext) => { + promptTemplate: async ( + input: any, + context: OriginalPipeline.PipelineContext, + ) => { const params = context.stepParams["self_params"]; const _ = await formatPromptTemplate(params); return _; }, - milvusSearch: async (input: any, context: OriginalPipeline.PipelineContext) => { + milvusSearch: async ( + input: any, + context: OriginalPipeline.PipelineContext, + ) => { const params = context.stepParams["self_params"]; const db = new milvusVectorDB(params); const res = await db.search({ vector: await db.generateVector(input), - ...params + ...params, }); if (res.status.error_code == "Success") { console.log(res.results); @@ -90,10 +94,11 @@ OriginalPipeline.PipeRegistry.customFn = { console.log(res.status.reason); throw new Error(res.status.reason); } - } + }, }; export class PipeRegistry extends OriginalPipeline.PipeRegistry { constructor() { super(); - }} \ No newline at end of file + } +} diff --git a/package/prompt/promptTemplate.ts b/package/prompt/promptTemplate.ts index 822d83a..2296643 100644 --- a/package/prompt/promptTemplate.ts +++ b/package/prompt/promptTemplate.ts @@ -1,7 +1,7 @@ import { milvusVectorDB, milvusVectorDBPromptTemplateSchema, - milvusVectorDBSchema + milvusVectorDBSchema, } from "llm-ops/db/index"; import { createMessageSchema, @@ -9,7 +9,8 @@ import { AgentPromptTemplate, createMessage, } from "llm-ops/prompt/index"; -export interface PromptsSchema extends Omit { +export interface PromptsSchema + extends Omit { name: "polishPromptTemplate" | "agentPromptTemplate" | string; prompt?: MultiPromptSchema[] | any[]; schema?: Record; @@ -17,7 +18,7 @@ export interface PromptsSchema extends Omit { + Omit { COLLECTION_NAME?: string; }