xfyun-spark 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2102ae80fc0527c40e5d1b527bce6220811a7f37b3fec31c71f22c088c3f0aa6
-  data.tar.gz: 27de89212f5ae2f16e59ef8a6c504d4595409a0e3b11055d87d516ec613df8a4
+  metadata.gz: 2f24573cb26d274cbefe3bee747507c5bd550f41ddbb7b8624fed75ae416a01f
+  data.tar.gz: a5ed7ff6ce9f969d62dff486d972030cbbb376e3fb898c04cc122d9ae89de7dd
 SHA512:
-  metadata.gz: fe0d3454e91e8f0cf9f16f98aae6c7a72fb7407eabcf72d22557b20f0ea1c297278552b0595829b3e20a478061f6aed603531a4273ad210bea13d8338ab57efd
-  data.tar.gz: 18cd8d389212e1eed574d15ec5ac31044c86e42883c8e2ddd10a37d64ce910ef8b9b5ad43762fa4949a39dbaa337b146a6b330a67521995ab6ccfc65798fb329
+  metadata.gz: 27006a4e25e71673980feb8ac737c36c812718ca059b6dd7d1be0a1718f9b7ab08915832dc13ee57b29f9ecfe2ac6b301a5d9db24923696aae2cc3583f520623
+  data.tar.gz: f68550d6ba619f3c770d565cb266f1902c24ed547bd6987968f9e00a777b7c05568b725ce1bdb5cce4c4c4c6cf7e3158055caaa677415d2b36674219d39085e7

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.3] - 2023-09-22
+
+### Changed
+
+- config add logger option
+- chat function add stream option
+
 ## [0.1.2] - 2023-09-20
 
 ### Fixed

data/README.md

@@ -29,6 +29,7 @@ Xfyun::Spark.configure do |config|
   # config.model = 'V1.5'
   # config.host = 'your host'
   # config.request_timeout = 10
+  # config.logger = Logger.new($stdout)
 end
 ```
 
@@ -68,10 +69,10 @@ Chat with custom header and parameter
 
 ```ruby
 response_body = client.chat(
+  header: {
+    uid: "12345"
+  },
   parameter: {
-    header: {
-      uid: "12345"
-    },
     chat: {
       temperature: 0.5,
       max_tokens: 1024,
@@ -86,6 +87,21 @@ response_body = client.chat(
 answer = response_body.dig('payload', 'choices', 'text', 0, 'content')
 ```
 
+Chat with stream
+
+```ruby
+client.chat(
+  payload: {
+    message: {
+      text: [{"role": "user", "content": "你是谁"}]
+    }
+  },
+  stream: proc do |chunk|
+    puts chunk
+  end
+)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/xfyun/spark/client.rb

@@ -3,7 +3,7 @@ module Xfyun
     class Client
       include Xfyun::Spark::Request
 
-      CONFIG_KEYS = %i[appid api_key api_secret model host request_timeout].freeze
+      CONFIG_KEYS = %i[appid api_key api_secret model host request_timeout logger].freeze
       attr_reader *CONFIG_KEYS, :request_version, :request_domain
 
       def initialize(config = {})
@@ -22,16 +22,16 @@ module Xfyun
         }.fetch(@model)
       end
 
-      def chat(header: {}, parameter: {}, payload: {})
+      def chat(header: {}, parameter: {}, payload: {}, stream: nil)
         header = default_header.merge(header)
         parameter = default_parameter.map do |k, v|
-          [k, v.merge(parameter.fetch(k))]
+          [k, v.merge(parameter[k] || {})]
         end.to_h
         request(path: "/chat", parameters: {
           header: header,
           parameter: parameter,
-          payload: payload
-        })
+          payload: payload,
+        }, stream: stream)
       end
 
       def default_header
@@ -46,6 +46,10 @@ module Xfyun
         }
       end
 
+      def logging(level, msg)
+        @logger.send(level, msg) if @logger != nil
+      end
+
     end
   end
 end

data/lib/xfyun/spark/request.rb

@@ -9,13 +9,12 @@ module Xfyun
   module Spark
     module Request
 
-      def request(path:, parameters:)
+      def request(path:, parameters:, stream:)
         content = ""
         data = nil
         EM.run {
           url = authorization_url(path)
-          # puts url
-          # puts parameters
+          logging(:info, "request url: #{url}, parameters: #{parameters}")
           ws = Faye::WebSocket::Client.new(url)
 
           ws.on(:open) do |event|
@@ -24,18 +23,24 @@ module Xfyun
           end
 
           ws.on(:close) do |event|
+            logging(:info, "ws close: #{event.code} #{event.reason}")
             # p [:close, event.code, event.reason]
             EM.stop
           end
 
           ws.on(:error) do |event|
+            logging(:info, "ws error: #{event.message}")
             # p [:error, event.message]
             raise Xfyun::Spark::Error.new(event.message)
           end
 
           ws.on(:message) do |event|
             # p [:message, event.data]
+            logging(:info, "ws message: #{event.data}")
             response_data = JSON.parse(event.data)
+            if stream.respond_to?(:call)
+              stream.call(response_data)
+            end
             code = response_data.dig('header', 'code')
             if code == 0
               status = response_data.dig('header', 'status')

data/lib/xfyun/spark/version.rb

@@ -1,5 +1,5 @@
 module Xfyun
   module Spark
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/xfyun/spark.rb

@@ -1,13 +1,14 @@
 require_relative "spark/version"
 require_relative "spark/request"
 require_relative "spark/client"
+require 'logger'
 
 module Xfyun
   module Spark
     class Error < StandardError; end
 
     class Configuration
-      attr_accessor :appid, :api_key, :api_secret, :model, :host, :request_timeout
+      attr_accessor :appid, :api_key, :api_secret, :model, :host, :request_timeout, :logger
 
       DEFAULT_MODEL = "V1.5".freeze
       DEFAULT_HOST = "spark-api.xf-yun.com".freeze
@@ -20,6 +21,7 @@ module Xfyun
         @model = DEFAULT_MODEL
         @host = DEFAULT_HOST
         @request_timeout = DEFAULT_REQUEST_TIMEOUT
+        @logger = nil # Logger.new($stdout)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xfyun-spark
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - chaucerling
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - chaucerling@gmail.com
 executables: []
@@ -44,14 +44,13 @@ files:
 - lib/xfyun/spark/request.rb
 - lib/xfyun/spark/version.rb
 - sig/xfyun/spark.rbs
-- xfyun-spark.gemspec
 homepage: https://github.com/chaucerling/xfyun-spark
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/chaucerling/xfyun-spark
   source_code_uri: https://github.com/chaucerling/xfyun-spark/blob/main/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: xfyun spark ruby sdk
 test_files: []

data/xfyun-spark.gemspec

@@ -1,35 +0,0 @@
-require_relative "lib/xfyun/spark/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "xfyun-spark"
-  spec.version = Xfyun::Spark::VERSION
-  spec.authors = ["chaucerling"]
-  spec.email = ["chaucerling@gmail.com"]
-
-  spec.summary = "xfyun spark ruby sdk"
-  spec.homepage = "https://github.com/chaucerling/xfyun-spark"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-
-  spec.add_dependency "faye-websocket"
-end