From 56c09c09a3d1df11c7ccccaf19b2a5ea6e5444a2 Mon Sep 17 00:00:00 2001
From: jacqueline-98 <jacqueline-98@hotmail.com>
Date: Thu, 7 Dec 2023 10:46:28 +0100
Subject: [PATCH] return value added. example added

---
 R/setupAgent.R    | 8 ++++----
 man/setupAgent.Rd | 9 ++++++---
 2 files changed, 10 insertions(+), 7 deletions(-)

diff --git a/R/setupAgent.R b/R/setupAgent.R
index 066981e..7b05f61 100644
--- a/R/setupAgent.R
+++ b/R/setupAgent.R
@@ -53,14 +53,14 @@ setupopenaiAgent<-function(model,type=c("chat","completion"),
 #'  \href{https://platform.openai.com/docs/models/overview}{click here}. For a full list of Replicate models,
 #'  \href{https://replicate.com/collections/language-models}{click here}.
 #' @param ai_api_key personal API key for accessing LLM
-#'
+#' @return A list holding agent information.
 #' @examples
-#' \dontrun{
-#' myAgent <- setupAgent(name="openai",type="chat",model="gpt-4",ai_api_key=Sys.getenv("AI_API_KEY"))
+#' {
+#' myAgent <- setupAgent(name="openai",type="chat",model="gpt-4",ai_api_key="my_key")
 #'
 #' myAgent <- setupAgent(name="replicate",type=NULL,
 #'                      model="02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3",
-#'                      ai_api_key=Sys.getenv("AI_API_KEY"))
+#'                      ai_api_key="my_key")
 #' }
 #' @export
 
diff --git a/man/setupAgent.Rd b/man/setupAgent.Rd
index 8586646..91d0810 100644
--- a/man/setupAgent.Rd
+++ b/man/setupAgent.Rd
@@ -34,15 +34,18 @@ For replicate models examples are:\itemize{
 
 \item{ai_api_key}{personal API key for accessing LLM}
 }
+\value{
+A list holding agent information.
+}
 \description{
 This function sets up an large language model API for tasks.
 }
 \examples{
-\dontrun{
-myAgent <- setupAgent(name="openai",type="chat",model="gpt-4",ai_api_key=Sys.getenv("AI_API_KEY"))
+{
+myAgent <- setupAgent(name="openai",type="chat",model="gpt-4",ai_api_key="my_key")
 
 myAgent <- setupAgent(name="replicate",type=NULL,
                      model="02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3",
-                     ai_api_key=Sys.getenv("AI_API_KEY"))
+                     ai_api_key="my_key")
 }
 }