Rename cases of ReturnValue

Author: intitni

Tool/Sources/LangChain/Agent.swift

@@ -48,8 +48,8 @@ public extension CallbackEvents {
 
 public struct AgentFinish<Output: AgentOutputParsable> {
     public enum ReturnValue {
-        case success(Output)
-        case failure(String)
+        case structured(Output)
+        case unstructured(String)
     }
 
     public var returnValue: ReturnValue
@@ -132,7 +132,7 @@ public extension Agent {
         switch earlyStoppedHandleType {
         case .force:
             return AgentFinish(
-                returnValue: .failure("Agent stopped due to iteration limit or time limit."),
+                returnValue: .unstructured("Agent stopped due to iteration limit or time limit."),
                 log: ""
             )
         case .generate:
@@ -144,7 +144,7 @@ public extension Agent {
             case let .finish(finish):
                 return finish
             case .actions:
-                return .init(returnValue: .failure(output.content ?? ""), log: output.content ?? "")
+                return .init(returnValue: .unstructured(output.content ?? ""), log: output.content ?? "")
             }
         }
     }

Tool/Sources/LangChain/AgentExecutor.swift

@@ -101,8 +101,8 @@ public actor AgentExecutor<InnerAgent: Agent>: Chain
 
     public nonisolated func parseOutput(_ output: Output) -> String {
         switch output.finalOutput {
-        case let .failure(error): return error
-        case let .success(output): return output.botReadableContent
+        case let .unstructured(error): return error
+        case let .structured(output): return output.botReadableContent
         }
     }
 
@@ -173,10 +173,10 @@ extension AgentExecutor {
 
         do {
             let result = try InnerAgent.Output.parse(action.observation ?? "")
-            return .init(returnValue: .success(result), log: action.observation ?? "")
+            return .init(returnValue: .structured(result), log: action.observation ?? "")
         } catch {
             return .init(
-                returnValue: .failure(action.observation ?? "no observation"),
+                returnValue: .unstructured(action.observation ?? "no observation"),
                 log: action.observation ?? ""
             )
         }

Tool/Sources/LangChain/Agents/ChatAgent.swift

@@ -134,7 +134,7 @@ public class ChatAgent: Agent {
                 _ = try throughAnswerParser.parse(&parsableContent)
                 let answer = String(parsableContent)
                 let output = answer.trimmingCharacters(in: .whitespacesAndNewlines)
-                return .finish(AgentFinish(returnValue: .success(output), log: text))
+                return .finish(AgentFinish(returnValue: .structured(output), log: text))
             } catch {
                 Logger.langchain.info("Could not parse LLM output final answer: \(error)")
                 return nil
@@ -188,7 +188,7 @@ public class ChatAgent: Agent {
             answer = "Sorry, I don't know."
         }
 
-        return .finish(AgentFinish(returnValue: .success(String(answer)), log: text))
+        return .finish(AgentFinish(returnValue: .structured(String(answer)), log: text))
     }
 }
 

Tool/Sources/LangChain/Agents/FunctionCallingChatAgent.swift

@@ -167,12 +167,12 @@ public class FunctionCallingChatAgent<Output: AgentOutputParsable & Decodable>:
                     do {
                         let output = try Output.parse(functionCall.arguments)
                         return .finish(.init(
-                            returnValue: .success(output),
+                            returnValue: .structured(output),
                             log: functionCall.arguments
                         ))
                     } catch {
                         return .finish(.init(
-                            returnValue: .failure(error.localizedDescription),
+                            returnValue: .unstructured(error.localizedDescription),
                             log: functionCall.arguments
                         ))
                     }
@@ -201,8 +201,8 @@ public class FunctionCallingChatAgent<Output: AgentOutputParsable & Decodable>:
             return .actions(actions)
         case let .finish(finish):
             switch finish.returnValue {
-            case let .failure(x), let .success(x):
-                return .finish(.init(returnValue: .failure(x), log: finish.log))
+            case let .unstructured(x), let .structured(x):
+                return .finish(.init(returnValue: .unstructured(x), log: finish.log))
             }
         }
     }