ragie_ruby_sdk 1.0.13 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19f78a0aaabe1d16350f7dfa53223077f6b8a79b743c5c7264c27421d844cb3f
-  data.tar.gz: faa262957488dc7be955e383c77b2775cb9b6fccf7fb0ac03fbb4c233eb48346
+  metadata.gz: 17873019808725418e224defcf9e3818132ee8addcefb0141f70f65eb3367077
+  data.tar.gz: 73d8514f89ce01aa8912fe9a9c10b12116073fc3e4cfb619a53f4f63882b2702
 SHA512:
-  metadata.gz: 82dc5689d3a0529b9371c5d4b72131fef0729fa3a149a98175313a1f08a04175f8d96426639cf6e5a47d6f00becb467c48e0e6b63803fc524e03a39f1306ae9e
-  data.tar.gz: 927fe56dd0e94ee403b4322ae9d40cb65dbc35e0cc532bb4bcf905d53088878d5a791929b2b474b8045ba7aed1de9cd1636679f820a05dccc903e6e62a6312d4
+  metadata.gz: 4c9bf30d59bfe88509f9696075480fc3f8efebc5d24953e21a74779cf64adcfd14c18ab834ad6ab4d07279b98c5fcc2392d46a37f76190139d0be728ddd2dab9
+  data.tar.gz: af09b17a96e59577570352f306bd754a3eb5325a7c106e6ce5c654b744074c22646fc91a4bc9b8e8e6cd5747d661969b744cb1dcfff889f9ad193824e56ae7b9

data/README.md

@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.12
+- Package version: 1.0.13
 - Generator version: 7.16.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -24,16 +24,16 @@ gem build ragie_ruby_sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ragie_ruby_sdk-1.0.12.gem
+gem install ./ragie_ruby_sdk-1.0.13.gem
 ```
 
-(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.12.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.13.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ragie_ruby_sdk', '~> 1.0.12'
+    gem 'ragie_ruby_sdk', '~> 1.0.13'
 
 ### Install from Git
 

data/docs/Answer.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **text** | **String** |  |  |
-| **evidence** | **Array<String>** |  |  |
+| **text** | **String** | An answer to a question. |  |
+| **evidence** | **Array<String>** | The evidence used to derive the answer. | [optional] |
 
 ## Example
 

data/docs/CodeInterpreterEvidence.md

@@ -6,9 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional][default to 'code_interpreter'] |
 | **text** | **String** |  |  |
-| **code** | **String** |  |  |
-| **code_issue** | **String** |  |  |
-| **code_result** | **String** |  |  |
+| **code** | **String** | The code that was executed. |  |
+| **code_issue** | **String** | The issue that the code was written to solve. |  |
+| **code_result** | **String** | The result of the code that was executed. |  |
 
 ## Example
 

data/docs/FinalAnswer.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **text** | **String** |  |  |
-| **evidence** | [**Array<FinalAnswerEvidenceInner>**](FinalAnswerEvidenceInner.md) |  |  |
-| **steps** | [**Array<FinalAnswerStepsInner>**](FinalAnswerStepsInner.md) |  |  |
-| **usage** | [**AgentHoppsModelsModelsUsage**](AgentHoppsModelsModelsUsage.md) |  |  |
+| **text** | **String** | The final answer to the question. |  |
+| **evidence** | [**Array<FinalAnswerEvidenceInner>**](FinalAnswerEvidenceInner.md) | The evidence used to derive the answer. | [optional] |
+| **steps** | [**Array<FinalAnswerStepsInner>**](FinalAnswerStepsInner.md) | The steps that led to the answer. | [optional] |
+| **usage** | [**AgentHoppsModelsModelsUsage**](AgentHoppsModelsModelsUsage.md) | The usage of the models. | [optional] |
 
 ## Example
 

data/docs/FinalAnswerEvidenceInner.md

@@ -6,16 +6,16 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional][default to 'code_interpreter'] |
 | **text** | **String** |  |  |
-| **code** | **String** |  |  |
-| **code_issue** | **String** |  |  |
-| **code_result** | **String** |  |  |
-| **id** | **String** |  |  |
-| **index** | **Integer** |  |  |
-| **document_id** | **String** |  |  |
-| **document_name** | **String** |  |  |
-| **metadata** | **Hash<String, Object>** |  | [optional] |
-| **document_metadata** | **Hash<String, Object>** |  | [optional] |
-| **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) |  | [optional] |
+| **code** | **String** | The code that was executed. |  |
+| **code_issue** | **String** | The issue that the code was written to solve. |  |
+| **code_result** | **String** | The result of the code that was executed. |  |
+| **id** | **String** | The chunk id of the evidence. |  |
+| **index** | **Integer** | The index of the chunk in the document. |  |
+| **document_id** | **String** | The document id of the document containing the chunk being used as evidence. |  |
+| **document_name** | **String** | The name of the document that contains the chunk being used as evidence. |  |
+| **metadata** | **Hash<String, Object>** | The metadata of the chunk being used as evidence. | [optional] |
+| **document_metadata** | **Hash<String, Object>** | The metadata of the document that contains the evidence. | [optional] |
+| **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | The links to the evidence. | [optional] |
 
 ## Example
 

data/docs/FinalAnswerStepsInner.md

@@ -9,12 +9,12 @@
 | **current_question** | **String** |  |  |
 | **other_resolved_question_ids** | **Array<String>** | A list of questions ids that are no longer relevant to the current answer referenced by their IDs. | [optional] |
 | **answer** | [**Answer**](Answer.md) |  |  |
-| **search** | [**Search**](Search.md) |  |  |
-| **questions_to_answer** | **Array<String>** |  |  |
+| **search** | [**Search**](Search.md) | The search request to be made. |  |
+| **questions_to_answer** | **Array<String>** | The questions that need to be answered to answer the original question. | [optional] |
 | **code_issue** | **String** | The natural language description of the code issue you need to solve. |  |
 | **code** | **String** | The code you generated to solve the code issue. | [optional][default to ''] |
 | **code_result** | **String** | The result of the code you generated after executing it. | [optional][default to ''] |
-| **partial_answer** | [**Answer**](Answer.md) |  |  |
+| **partial_answer** | [**Answer**](Answer.md) | The a potential partial answer when a full answer was not possible. |  |
 | **eval_passed** | **Boolean** |  |  |
 | **eval_reason** | **String** |  |  |
 

data/docs/PlanStep.md

@@ -7,7 +7,7 @@
 | **type** | **String** |  | [optional][default to 'plan'] |
 | **think** | **String** |  |  |
 | **current_question** | **String** |  |  |
-| **questions_to_answer** | **Array<String>** |  |  |
+| **questions_to_answer** | **Array<String>** | The questions that need to be answered to answer the original question. | [optional] |
 
 ## Example
 

data/docs/RagieEvidence.md

@@ -6,13 +6,13 @@
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** |  | [optional][default to 'ragie'] |
 | **text** | **String** |  |  |
-| **id** | **String** |  |  |
-| **index** | **Integer** |  |  |
-| **document_id** | **String** |  |  |
-| **document_name** | **String** |  |  |
-| **metadata** | **Hash<String, Object>** |  | [optional] |
-| **document_metadata** | **Hash<String, Object>** |  | [optional] |
-| **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) |  | [optional] |
+| **id** | **String** | The chunk id of the evidence. |  |
+| **index** | **Integer** | The index of the chunk in the document. |  |
+| **document_id** | **String** | The document id of the document containing the chunk being used as evidence. |  |
+| **document_name** | **String** | The name of the document that contains the chunk being used as evidence. |  |
+| **metadata** | **Hash<String, Object>** | The metadata of the chunk being used as evidence. | [optional] |
+| **document_metadata** | **Hash<String, Object>** | The metadata of the document that contains the evidence. | [optional] |
+| **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | The links to the evidence. | [optional] |
 
 ## Example
 

data/docs/SearchStep.md

@@ -7,7 +7,7 @@
 | **type** | **String** |  | [optional][default to 'search'] |
 | **think** | **String** |  |  |
 | **current_question** | **String** |  |  |
-| **search** | [**Search**](Search.md) |  |  |
+| **search** | [**Search**](Search.md) | The search request to be made. |  |
 
 ## Example
 

data/docs/SurrenderStep.md

@@ -7,7 +7,7 @@
 | **type** | **String** |  | [optional][default to 'surrender'] |
 | **think** | **String** |  |  |
 | **current_question** | **String** |  |  |
-| **partial_answer** | [**Answer**](Answer.md) |  |  |
+| **partial_answer** | [**Answer**](Answer.md) | The a potential partial answer when a full answer was not possible. |  |
 
 ## Example
 

data/lib/ragie_ruby_sdk/models/answer.rb

@@ -15,8 +15,10 @@ require 'time'
 
 module RagieRubySdk
   class Answer
+    # An answer to a question.
     attr_accessor :text
 
+    # The evidence used to derive the answer.
     attr_accessor :evidence
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -77,8 +79,6 @@ module RagieRubySdk
         if (value = attributes[:'evidence']).is_a?(Array)
           self.evidence = value
         end
-      else
-        self.evidence = nil
       end
     end
 
@@ -91,10 +91,6 @@ module RagieRubySdk
         invalid_properties.push('invalid value for "text", text cannot be nil.')
       end
 
-      if @evidence.nil?
-        invalid_properties.push('invalid value for "evidence", evidence cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -103,7 +99,6 @@ module RagieRubySdk
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @text.nil?
-      return false if @evidence.nil?
       true
     end
 
@@ -117,16 +112,6 @@ module RagieRubySdk
       @text = text
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] evidence Value to be assigned
-    def evidence=(evidence)
-      if evidence.nil?
-        fail ArgumentError, 'evidence cannot be nil'
-      end
-
-      @evidence = evidence
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ragie_ruby_sdk/models/code_interpreter_evidence.rb

@@ -19,10 +19,13 @@ module RagieRubySdk
 
     attr_accessor :text
 
+    # The code that was executed.
     attr_accessor :code
 
+    # The issue that the code was written to solve.
     attr_accessor :code_issue
 
+    # The result of the code that was executed.
     attr_accessor :code_result
 
     class EnumAttributeValidator

data/lib/ragie_ruby_sdk/models/final_answer.rb

@@ -15,12 +15,16 @@ require 'time'
 
 module RagieRubySdk
   class FinalAnswer
+    # The final answer to the question.
     attr_accessor :text
 
+    # The evidence used to derive the answer.
     attr_accessor :evidence
 
+    # The steps that led to the answer.
     attr_accessor :steps
 
+    # The usage of the models.
     attr_accessor :usage
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -85,22 +89,16 @@ module RagieRubySdk
         if (value = attributes[:'evidence']).is_a?(Array)
           self.evidence = value
         end
-      else
-        self.evidence = nil
       end
 
       if attributes.key?(:'steps')
         if (value = attributes[:'steps']).is_a?(Array)
           self.steps = value
         end
-      else
-        self.steps = nil
       end
 
       if attributes.key?(:'usage')
         self.usage = attributes[:'usage']
-      else
-        self.usage = nil
       end
     end
 
@@ -113,18 +111,6 @@ module RagieRubySdk
         invalid_properties.push('invalid value for "text", text cannot be nil.')
       end
 
-      if @evidence.nil?
-        invalid_properties.push('invalid value for "evidence", evidence cannot be nil.')
-      end
-
-      if @steps.nil?
-        invalid_properties.push('invalid value for "steps", steps cannot be nil.')
-      end
-
-      if @usage.nil?
-        invalid_properties.push('invalid value for "usage", usage cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -133,9 +119,6 @@ module RagieRubySdk
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @text.nil?
-      return false if @evidence.nil?
-      return false if @steps.nil?
-      return false if @usage.nil?
       true
     end
 
@@ -149,36 +132,6 @@ module RagieRubySdk
       @text = text
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] evidence Value to be assigned
-    def evidence=(evidence)
-      if evidence.nil?
-        fail ArgumentError, 'evidence cannot be nil'
-      end
-
-      @evidence = evidence
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] steps Value to be assigned
-    def steps=(steps)
-      if steps.nil?
-        fail ArgumentError, 'steps cannot be nil'
-      end
-
-      @steps = steps
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] usage Value to be assigned
-    def usage=(usage)
-      if usage.nil?
-        fail ArgumentError, 'usage cannot be nil'
-      end
-
-      @usage = usage
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ragie_ruby_sdk/models/plan_step.rb

@@ -21,6 +21,7 @@ module RagieRubySdk
 
     attr_accessor :current_question
 
+    # The questions that need to be answered to answer the original question.
     attr_accessor :questions_to_answer
 
     class EnumAttributeValidator
@@ -119,8 +120,6 @@ module RagieRubySdk
         if (value = attributes[:'questions_to_answer']).is_a?(Array)
           self.questions_to_answer = value
         end
-      else
-        self.questions_to_answer = nil
       end
     end
 
@@ -137,10 +136,6 @@ module RagieRubySdk
         invalid_properties.push('invalid value for "current_question", current_question cannot be nil.')
       end
 
-      if @questions_to_answer.nil?
-        invalid_properties.push('invalid value for "questions_to_answer", questions_to_answer cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -152,7 +147,6 @@ module RagieRubySdk
       return false unless type_validator.valid?(@type)
       return false if @think.nil?
       return false if @current_question.nil?
-      return false if @questions_to_answer.nil?
       true
     end
 
@@ -186,16 +180,6 @@ module RagieRubySdk
       @current_question = current_question
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] questions_to_answer Value to be assigned
-    def questions_to_answer=(questions_to_answer)
-      if questions_to_answer.nil?
-        fail ArgumentError, 'questions_to_answer cannot be nil'
-      end
-
-      @questions_to_answer = questions_to_answer
-    end
-
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)

data/lib/ragie_ruby_sdk/models/ragie_evidence.rb

@@ -19,18 +19,25 @@ module RagieRubySdk
 
     attr_accessor :text
 
+    # The chunk id of the evidence.
     attr_accessor :id
 
+    # The index of the chunk in the document.
     attr_accessor :index
 
+    # The document id of the document containing the chunk being used as evidence.
     attr_accessor :document_id
 
+    # The name of the document that contains the chunk being used as evidence.
     attr_accessor :document_name
 
+    # The metadata of the chunk being used as evidence.
     attr_accessor :metadata
 
+    # The metadata of the document that contains the evidence.
     attr_accessor :document_metadata
 
+    # The links to the evidence.
     attr_accessor :links
 
     class EnumAttributeValidator

data/lib/ragie_ruby_sdk/models/search_step.rb

@@ -21,6 +21,7 @@ module RagieRubySdk
 
     attr_accessor :current_question
 
+    # The search request to be made.
     attr_accessor :search
 
     class EnumAttributeValidator

data/lib/ragie_ruby_sdk/models/surrender_step.rb

@@ -21,6 +21,7 @@ module RagieRubySdk
 
     attr_accessor :current_question
 
+    # The a potential partial answer when a full answer was not possible.
     attr_accessor :partial_answer
 
     class EnumAttributeValidator

data/lib/ragie_ruby_sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.16.0-SNAPSHOT
 =end
 
 module RagieRubySdk
-  VERSION = '1.0.13'
+  VERSION = '1.0.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ragie_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.0.14
 platform: ruby
 authors:
 - OpenAPI-Generator