async-ollama 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48c03b349a35f753bc070a075d69b6d6b56090830115ff219ecb275238d0092d
-  data.tar.gz: 68219ece8502ab454ceced00fd20d3c878b145e5dd712da47eff5620ca18c141
+  metadata.gz: 1e1e52839defa45793d0099a223261d94f3a5cdfc7d5ca1f859defc943608f65
+  data.tar.gz: e8f8c3aa9e16f368e7f0a68b7be2e66d7d899bc635e31f9f62bd09aa67a434f2
 SHA512:
-  metadata.gz: a71b7b32bbb34b670a41d52aa8ea03e54a9ef8ba90b2a0c18e86163f44ced131818c2e96ddb742fed1e77559f17781a3c3f50c197ffd6044dccf71f4492a4881
-  data.tar.gz: '059344b7fc623d8fc857e5761cbe511c2a5a1b9201027302d232e573d4cc3e76a0766a3e0568d879bd35a427574fc4970a77e620f89431f59b7ce123abcb2ad2'
+  metadata.gz: 1b1266042797be83ef0317b42d155b72ff9431cb6368f9f0528aaab435d26e62ced79d326bd76d35a493b32a50c43753db404a3cb4c37e6e0e0a35b0fd5b4759
+  data.tar.gz: ca36a8d5d4762b65de815a8920a7bdf73b30be48a7cecc229d217da2d52566bd76d3909db8895a0f0d103366c38785454aeb29c5d9c454413561b1b7e4302e64

data/lib/async/ollama/client.rb

@@ -3,20 +3,23 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'async/rest/resource'
-require_relative 'generate'
+require "async/rest/resource"
+require_relative "generate"
 
 module Async
 	module Ollama
 		# Represents a connection to the Ollama service.
 		class Client < Async::REST::Resource
-			ENDPOINT = Async::HTTP::Endpoint.parse('http://localhost:11434')
+			# 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] ||= 'llama2'
+				options[:model] ||= "llama3"
 				
-				Generate.post(self.with(path: '/api/generate'), options, &block)
+				Generate.post(self.with(path: "/api/generate"), options, &block)
 			end
 		end
 	end

data/lib/async/ollama/generate.rb

@@ -3,24 +3,30 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'async/rest/representation'
-require_relative 'wrapper'
+require "async/rest/representation"
+require_relative "wrapper"
 
 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

data/lib/async/ollama/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Ollama
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

data/lib/async/ollama/wrapper.rb

@@ -3,13 +3,13 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require 'async/rest/wrapper/generic'
-require 'async/rest/wrapper/json'
+require "async/rest/wrapper/generic"
+require "async/rest/wrapper/json"
 
-require 'protocol/http/body/wrapper'
-require 'protocol/http/body/buffered'
+require "protocol/http/body/wrapper"
+require "protocol/http/body/buffered"
 
-require 'json'
+require "json"
 
 module Async
 	module Ollama
@@ -18,11 +18,11 @@ module Async
 			APPLICATION_JSON_STREAM = "application/x-ndjson"
 			
 			def prepare_request(request, payload)
-				request.headers.add('accept', APPLICATION_JSON)
-				request.headers.add('accept', APPLICATION_JSON_STREAM)
+				request.headers.add("accept", APPLICATION_JSON)
+				request.headers.add("accept", APPLICATION_JSON_STREAM)
 				
 				if payload
-					request.headers['content-type'] = APPLICATION_JSON
+					request.headers["content-type"] = APPLICATION_JSON
 					
 					request.body = ::Protocol::HTTP::Body::Buffered.new([
 						::JSON.dump(payload)
@@ -85,7 +85,7 @@ module Async
 			end
 			
 			def parser_for(response)
-				case response.headers['content-type']
+				case response.headers["content-type"]
 				when APPLICATION_JSON
 					return Async::REST::Wrapper::JSON::Parser
 				when APPLICATION_JSON_STREAM

data/lib/async/ollama.rb

@@ -3,5 +3,5 @@
 # Released under the MIT License.
 # Copyright, 2024, by Samuel Williams.
 
-require_relative 'ollama/version'
-require_relative 'ollama/client'
+require_relative "ollama/version"
+require_relative "ollama/client"

data/readme.md

@@ -8,6 +8,8 @@ Provides an interface for accessing the Ollama HTTP interface.
 
 Please see the [project documentation](https://socketry.github.io/async-ollama/) for more details.
 
+  - [Getting Started](https://socketry.github.io/async-ollama/guides/getting-started/index) - This guide explains how to get started with the `async-ollama` gem.
+
 ## Contributing
 
 We welcome contributions to this project.
@@ -20,8 +22,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: async-ollama
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -36,7 +37,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-09 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -58,14 +59,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.15'
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,8 +84,9 @@ homepage: https://github.com/socketry/async-ollama
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://socketry.github.io/falcon/
+  documentation_uri: https://socketry.github.io/async-ollama/
   source_code_uri: https://github.com/socketry/async-ollama.git
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,7 +101,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: A asynchronous interface to the ollama chat service
 test_files: []