xfyun-spark 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a8d6ec5b1f030402777262e0e03f6ebffcf43bc047affbdff5881597add161
-  data.tar.gz: 51ed1d8d10046614f919e50b72cbbf773cf04b13cbfb39c4ddb78eb4e225711b
+  metadata.gz: 3cac8e5659bd9a13198a6efa899fd07ae8cdb00a4fa0281ce210dd57e39e1100
+  data.tar.gz: fe72c126c9a13ea62bf09103bd1e0633a43e291b553a26ad17cd82d1e8cceef6
 SHA512:
-  metadata.gz: 3ea278d2d0a8f30d87007cc582dbbe904ffabfb9fa55270b3a0da26853342fe4001986190261f7c09c234d393799cdf654e95013da82f00908a79020921d282e
-  data.tar.gz: e784fd961bdcb93d8da6f0148726f8dfff4dfabdbc205216bd83f264afd48b59a44b08f331007834ffaefbd57a8b56d5b04ce828eb77100477fb194170d804d5
+  metadata.gz: de7070e1e4be16c2e44fab3ef2eab7fac21976bcf45b3976647a86d4ae80b217d85fccde809e9b2d1f37edd12f66ea0d49bd81b22e182ce8eb067f3230a2031b
+  data.tar.gz: 0ede79ecff4548733a9c06dc741a5d0da606e09740c2083468d8a1c6bdb9eb1de4126d886b9eabcf95ca787deba95bf734cbb3c8074ad122362a893d9e691f11

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.1] - 2023-09-19
+
+### Changed
+
+- return error resonse
+- update default config and update chat funciton
+
 ## [0.1.0] - 2023-09-18
 
 ### Added

data/README.md

@@ -8,24 +8,81 @@
 
 Install the gem and add to the application's Gemfile by executing:
 
-$ bundle add xfyun-spark
+`bundle add xfyun-spark`
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-$ gem install xfyun-spark
+`gem install xfyun-spark`
 
 ## Usage
 
-xfyun spark ruby sdk
+### Configure
+
+Configure the gem in initializer file
+
+```ruby
+Xfyun::Spark.configure do |config|
+  config.appid = 'appid'
+  config.api_secret = 'api_secret'
+  config.api_key = 'api_key'
+  # Optional configs
+  # config.model = 'V1.5'
+  # config.host = 'your host'
+  # config.request_timeout = 10
+end
+```
+
+Create a client
+
+```ruby
+client = Xfyun::Spark::Client.new
+```
+
+Create a client overriding the default config
 
 ```ruby
 client = Xfyun::Spark::Client.new({
   appid: 'appid',
   api_secret: 'api_secreti',
   api_key: 'api_key'
+  model: 'V2' # use V2 model
 })
+```
+
+### Chat
+
+Chat with simple payload, using default header and parameter
 
-response_body = client.chat([{"role": "user", "content": "你是谁"}])
+```ruby
+response_body = client.chat(
+  payload: {
+    message: {
+      text: [{"role": "user", "content": "你是谁"}]
+    }
+  }
+)
+answer = response_body.dig('payload', 'choices', 'text', 0, 'content')
+```
+
+Chat with custom header and parameter
+
+```ruby
+response_body = client.chat(
+  parameter: {
+    header: {
+      uid: "12345"
+    },
+    chat: {
+      temperature: 0.5,
+      max_tokens: 1024,
+    }
+  },
+  payload: {
+    message: {
+      text: [{"role": "user", "content": "你是谁"}]
+    }
+  }
+)
 answer = response_body.dig('payload', 'choices', 'text', 0, 'content')
 ```
 
@@ -33,7 +90,7 @@ answer = response_body.dig('payload', 'choices', 'text', 0, 'content')
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/xfyun/spark/client.rb

@@ -3,17 +3,47 @@ module Xfyun
     class Client
       include Xfyun::Spark::Request
 
-      CONFIG_KEYS = %i[appid api_key api_secret api_type api_version uri_base request_timeout].freeze
-      attr_reader *CONFIG_KEYS
+      CONFIG_KEYS = %i[appid api_key api_secret model host request_timeout].freeze
+      attr_reader *CONFIG_KEYS, :request_version, :request_domain
 
       def initialize(config = {})
         CONFIG_KEYS.each do |key|
           instance_variable_set("@#{key}", config[key] || Xfyun::Spark.configuration.send(key))
         end
+
+        @request_version = {
+          "V1.5" => "v1.1",
+          "V2" => "v2.1",
+        }.fetch(@model)
+
+        @request_domain = {
+          "V1.5" => "general",
+          "V2" => "generalv2",
+        }.fetch(@model)
+      end
+
+      def chat(header: {}, parameter: {}, payload: {})
+        header = default_header.merge(header)
+        parameter = default_parameter.map do |k, v|
+          [k, v.merge(parameter.fetch(k))]
+        end.to_h
+        request(path: "/chat", parameters: {
+          header: header,
+          parameter: parameter,
+          payload: payload
+        })
+      end
+
+      def default_header
+        {app_id: @appid}
       end
 
-      def chat(question)
-        request(path: "/chat", parameters: gen_params(question))
+      def default_parameter
+        {
+          chat: {
+            domain: @request_domain,
+          }
+        }
       end
 
     end

data/lib/xfyun/spark/request.rb

@@ -9,25 +9,6 @@ module Xfyun
   module Spark
     module Request
 
-      def gen_params(question)
-        data = {
-          "header": {
-              "app_id": @appid,
-              "uid": "1234"
-          },
-          "parameter": {
-              "chat": {
-                  "domain": @api_type,
-              }
-          },
-          "payload": {
-              "message": {
-                  "text": question
-              }
-          }
-        }
-      end
-
       def request(path:, parameters:)
         content = ""
         data = nil
@@ -54,13 +35,18 @@ module Xfyun
           ws.on(:message) do |event|
             p [:message, event.data]
             response_data = JSON.parse(event.data)
-            status = response_data.dig('header', 'status')
-            case status
-            when 0, 1
-              content << response_data.dig('payload', 'choices', 'text', 0, 'content')
-            when 2
-              # last message
-              response_data['payload']['choices']['text'][0]['content'] = content
+            code = response_data.dig('header', 'code')
+            if code == 0
+              status = response_data.dig('header', 'status')
+              case status
+              when 0, 1
+                content << response_data.dig('payload', 'choices', 'text', 0, 'content')
+              when 2
+                # last message
+                response_data['payload']['choices']['text'][0]['content'] = content
+                data = response_data
+              end
+            else
               data = response_data
             end
           end
@@ -72,9 +58,9 @@ module Xfyun
         def authorization_url(path)
           httpdate = Time.now.httpdate
 
-          tmp_str = "host: #{@uri_base}\n"
+          tmp_str = "host: #{@host}\n"
           tmp_str << "date: #{httpdate}\n"
-          tmp_str << "GET /#{api_version}#{path} HTTP/1.1"
+          tmp_str << "GET /#{@request_version}#{path} HTTP/1.1"
 
           tmp_sha = OpenSSL::HMAC.digest('sha256', @api_secret, tmp_str)
           signature = Base64.strict_encode64(tmp_sha)
@@ -85,10 +71,10 @@ module Xfyun
           query = URI.encode_www_form({
             authorization: authorization,
             date: httpdate,
-            host: @uri_base,
+            host: @host,
           })
 
-          url = "wss://#{@uri_base}/#{@api_version}#{path}?#{query}"
+          url = "wss://#{@host}/#{@request_version}#{path}?#{query}"
         end
 
     end

data/lib/xfyun/spark/version.rb

@@ -1,5 +1,5 @@
 module Xfyun
   module Spark
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/xfyun/spark.rb

@@ -7,20 +7,18 @@ module Xfyun
     class Error < StandardError; end
 
     class Configuration
-      attr_accessor :appid, :api_key, :api_secret, :api_type, :api_version, :uri_base, :request_timeout
+      attr_accessor :appid, :api_key, :api_secret, :model, :host, :request_timeout
 
-      DEFAULT_API_TYPE = "general".freeze
-      DEFAULT_API_VERSION = "v1.1".freeze
-      DEFAULT_URI_BASE = "spark-api.xf-yun.com".freeze
+      DEFAULT_MODEL = "V1.5".freeze
+      DEFAULT_HOST = "spark-api.xf-yun.com".freeze
       DEFAULT_REQUEST_TIMEOUT = 120
 
       def initialize
         @appid = nil
         @api_key = nil
         @api_secret = nil
-        @api_type = DEFAULT_API_TYPE
-        @api_version = DEFAULT_API_VERSION
-        @uri_base = DEFAULT_URI_BASE
+        @model = DEFAULT_MODEL
+        @host = DEFAULT_HOST
         @request_timeout = DEFAULT_REQUEST_TIMEOUT
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xfyun-spark
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - chaucerling