More documentation.

lib/async/ollama/client.rb

@@ -10,8 +10,11 @@ module Async
 	module Ollama
 		# Represents a connection to the Ollama service.
 		class Client < Async::REST::Resource
+			# The default endpoint to connect to.
 			ENDPOINT = Async::HTTP::Endpoint.parse('http://localhost:11434')
 
+			# Generate a response from the given prompt.
+			# @parameter prompt [String] The prompt to generate a response from.
 			def generate(prompt, **options, &block)
 				options[:prompt] = prompt
 				options[:model] ||= 'llama3'

lib/async/ollama/generate.rb

@@ -9,18 +9,24 @@
 module Async
 	module Ollama
 		class Generate < Async::REST::Representation[Wrapper]
+			# The response to the prompt.
 			def response
 				self.value[:response]
 			end
 
+			# The conversation context. Used to maintain state between prompts.
 			def context
 				self.value[:context]
 			end
 
+			# The model used to generate the response.
 			def model
 				self.value[:model]
 			end
 
+			# Generate a new response from the given prompt.
+			# @parameter prompt [String] The prompt to generate a response from.
+			# @yields {|response| ...} Optional streaming response.
 			def generate(prompt, &block)
 				self.class.post(self.resource, prompt: prompt, context: self.context, model: self.model, &block)
 			end