add swift docc header

Author: sebsto

Sources/BedrockService/BedrockService+AgentRuntime.swift

@@ -36,12 +36,16 @@ extension BedrockService {
         )
         return BedrockAgentRuntimeClient(config: config)
     }
-    /// Retrieves information from a knowledge base
+    /// Retrieves information from a knowledge base for RAG applications
+    /// 
+    /// This method queries an Amazon Bedrock knowledge base to retrieve relevant information
+    /// that can be used for Retrieval-Augmented Generation (RAG) applications.
+    /// 
     /// - Parameters:
     ///   - knowledgeBaseId: The unique identifier of the knowledge base to query
     ///   - retrievalQuery: The query to search for in the knowledge base
     ///   - numberOfResults: The number of results to return (optional, defaults to 3)
-    /// - Returns: RetrieveResult containing the retrieved results
+    /// - Returns: RetrieveResult containing the retrieved results with convenience methods
     /// - Throws: BedrockLibraryError or other errors from the underlying service
     public func retrieve(
         knowledgeBaseId: String,

Sources/BedrockService/Protocols/BedrockAgentRuntimeProtocol.swift

@@ -22,8 +22,15 @@ import FoundationEssentials
 import Foundation
 #endif
 
-// Protocol allows writing mocks for unit tests
+/// Protocol for Amazon Bedrock Agent Runtime operations
+/// 
+/// This protocol allows writing mocks for unit tests and provides a clean interface
+/// for knowledge base retrieval operations.
 public protocol BedrockAgentRuntimeProtocol: Sendable {
+    /// Retrieves information from a knowledge base
+    /// - Parameter input: The retrieve input containing query and configuration
+    /// - Returns: RetrieveOutput with the retrieved results
+    /// - Throws: Error if the retrieval operation fails
     func retrieve(input: RetrieveInput) async throws -> RetrieveOutput
 }
 

Sources/BedrockService/RetrieveRequest.swift

@@ -15,11 +15,20 @@
 
 @preconcurrency import AWSBedrockAgentRuntime
 
+/// A request for retrieving information from a knowledge base
 public struct RetrieveRequest: Sendable {
+    /// The unique identifier of the knowledge base to query
     public let knowledgeBaseId: String
+    /// The query text to search for in the knowledge base
     public let retrievalQuery: String
+    /// The number of results to return
     public let numberOfResults: Int
 
+    /// Creates a new retrieve request
+    /// - Parameters:
+    ///   - knowledgeBaseId: The unique identifier of the knowledge base to query
+    ///   - retrievalQuery: The query text to search for in the knowledge base
+    ///   - numberOfResults: The number of results to return (defaults to 3)
     public init(
         knowledgeBaseId: String,
         retrievalQuery: String,

Sources/BedrockService/RetrieveResult.swift

@@ -21,6 +21,7 @@ import FoundationEssentials
 import Foundation
 #endif
 
+/// Type alias for knowledge base retrieval result
 public typealias RAGRetrievalResult = BedrockAgentRuntimeClientTypes.KnowledgeBaseRetrievalResult
 
 internal struct SerializableResult: Codable {
@@ -29,21 +30,31 @@ internal struct SerializableResult: Codable {
     let source: String?
 }
 
+/// A wrapper around RetrieveOutput providing convenient access to retrieval results
 public struct RetrieveResult: Sendable {
+    /// The underlying AWS SDK RetrieveOutput
     public let output: RetrieveOutput
 
+    /// Creates a new RetrieveResult from a RetrieveOutput
+    /// - Parameter output: The AWS SDK RetrieveOutput to wrap
     public init(_ output: RetrieveOutput) {
         self.output = output
     }
 
+    /// The retrieval results from the knowledge base query
     public var results: [RAGRetrievalResult]? {
         output.retrievalResults
     }
 
+    /// Returns the retrieval result with the highest relevance score
+    /// - Returns: The best matching result, or nil if no results
     public func bestMatch() -> RAGRetrievalResult? {
         output.retrievalResults?.max { ($0.score ?? 0) < ($1.score ?? 0) }
     }
 
+    /// Converts the retrieval results to JSON format for use with language models
+    /// - Returns: JSON string representation of the results
+    /// - Throws: Error if JSON encoding fails
     public func toJSON() throws -> String {
         guard let results = output.retrievalResults else { return "[]" }