ragie_ruby_sdk 1.0.16 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4670e0e080e4f52c9da25a8b4944e47b4374df52c13b3ae0ec2a30a177d082ec
-  data.tar.gz: 05bf09d2c59c93e357ec1a294055b6ce28a5f6ace9b91060304f4ba0412e181f
+  metadata.gz: cfe3b2c480ab35d9b6d15864337fc784d9b643beb15b5c7c68ebea233b3a8751
+  data.tar.gz: 2e4ced50df79622c78e0cfe6d6d02261ccc8053ca27098b5f713d0d3eba538df
 SHA512:
-  metadata.gz: b9e5c8c5da161485ab75e995a0594616896141d662ff75cfd526b00dc6760c0c76358329492417b318d558f3bc64891a4a8b0ed040461bb90910d6ea22672599
-  data.tar.gz: 8b277c80c3e8c51c7d5c6401c51ee1bd0461bc39c7e31a54bbb534fc73c70c1619dab4af46ac5932abc9118893c018867e3829282b8e8c02ab39026ef2dea1c3
+  metadata.gz: 5257c810502691db0ff9859d2e00373ea666bfdd4c45efd36050395d696511b631cf789a06decc9808862ccad597c1043d48fe632326ade4be1ba144ae73db0c
+  data.tar.gz: 0fb5cb55e4f833c2afa6ede62547fd2bd2d196424ccdcf390c80a246d6556b1eccf845d817baf7ae777b5b4ea3cff0fb01c04c7dee8e44de01a804b9d2140dd6

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.15
+- Package version: 1.0.16
 - Generator version: 7.17.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.15.gem
+gem install ./ragie_ruby_sdk-1.0.16.gem
 ```
 
-(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.15.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ragie_ruby_sdk-1.0.16.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.15'
+    gem 'ragie_ruby_sdk', '~> 1.0.16'
 
 ### Install from Git
 
@@ -174,6 +174,8 @@ Class | Method | HTTP request | Description
  - [RagieRubySdk::BodyUpdateDocumentFile](docs/BodyUpdateDocumentFile.md)
  - [RagieRubySdk::BucketData](docs/BucketData.md)
  - [RagieRubySdk::CodeInterpreterEvidence](docs/CodeInterpreterEvidence.md)
+ - [RagieRubySdk::CodeInterpreterOutput](docs/CodeInterpreterOutput.md)
+ - [RagieRubySdk::CodeInterpreterOutputLogs](docs/CodeInterpreterOutputLogs.md)
  - [RagieRubySdk::CodeStep](docs/CodeStep.md)
  - [RagieRubySdk::ConfluenceData](docs/ConfluenceData.md)
  - [RagieRubySdk::Connection](docs/Connection.md)
@@ -226,6 +228,8 @@ Class | Method | HTTP request | Description
  - [RagieRubySdk::EntityList](docs/EntityList.md)
  - [RagieRubySdk::ErrorMessage](docs/ErrorMessage.md)
  - [RagieRubySdk::EvaluatedAnswerStep](docs/EvaluatedAnswerStep.md)
+ - [RagieRubySdk::FileSearchOutput](docs/FileSearchOutput.md)
+ - [RagieRubySdk::FileSearchResult](docs/FileSearchResult.md)
  - [RagieRubySdk::FinalAnswer](docs/FinalAnswer.md)
  - [RagieRubySdk::FinalAnswerEvidenceInner](docs/FinalAnswerEvidenceInner.md)
  - [RagieRubySdk::FinalAnswerStepsInner](docs/FinalAnswerStepsInner.md)
@@ -278,22 +282,29 @@ Class | Method | HTTP request | Description
  - [RagieRubySdk::PublicIntercomConnection](docs/PublicIntercomConnection.md)
  - [RagieRubySdk::PublicS3CompatibleConnection](docs/PublicS3CompatibleConnection.md)
  - [RagieRubySdk::PublicZendeskConnection](docs/PublicZendeskConnection.md)
+ - [RagieRubySdk::QueryDetails](docs/QueryDetails.md)
  - [RagieRubySdk::RagieApiSchemaResponseUsage](docs/RagieApiSchemaResponseUsage.md)
  - [RagieRubySdk::RagieEvidence](docs/RagieEvidence.md)
  - [RagieRubySdk::Reasoning](docs/Reasoning.md)
+ - [RagieRubySdk::ReasoningOutput](docs/ReasoningOutput.md)
+ - [RagieRubySdk::ReasoningSummary](docs/ReasoningSummary.md)
+ - [RagieRubySdk::ReasoningText](docs/ReasoningText.md)
  - [RagieRubySdk::Request](docs/Request.md)
  - [RagieRubySdk::Response](docs/Response.md)
  - [RagieRubySdk::ResponseContent](docs/ResponseContent.md)
  - [RagieRubySdk::ResponseOK](docs/ResponseOK.md)
- - [RagieRubySdk::ResponseOutput](docs/ResponseOutput.md)
+ - [RagieRubySdk::ResponseOutputInner](docs/ResponseOutputInner.md)
+ - [RagieRubySdk::ResponseOutputMessage](docs/ResponseOutputMessage.md)
  - [RagieRubySdk::ResponsePatchdocumentmetadata](docs/ResponsePatchdocumentmetadata.md)
  - [RagieRubySdk::Retrieval](docs/Retrieval.md)
  - [RagieRubySdk::RetrieveParams](docs/RetrieveParams.md)
  - [RagieRubySdk::S3CompatibleCredentials](docs/S3CompatibleCredentials.md)
  - [RagieRubySdk::ScoredChunk](docs/ScoredChunk.md)
  - [RagieRubySdk::Search](docs/Search.md)
+ - [RagieRubySdk::SearchEffort](docs/SearchEffort.md)
  - [RagieRubySdk::SearchResultLink](docs/SearchResultLink.md)
  - [RagieRubySdk::SearchStep](docs/SearchStep.md)
+ - [RagieRubySdk::SearchStepWithQueryDetails](docs/SearchStepWithQueryDetails.md)
  - [RagieRubySdk::SetConnectionEnabledPayload](docs/SetConnectionEnabledPayload.md)
  - [RagieRubySdk::SharepointData](docs/SharepointData.md)
  - [RagieRubySdk::SharepointFileData](docs/SharepointFileData.md)

data/docs/CodeInterpreterOutput.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::CodeInterpreterOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the code interpreter tool call. |  |
+| **code** | **String** | The code executed by the code interpreter. |  |
+| **container_id** | **String** | The ID of the container used to run the code. |  |
+| **outputs** | [**Array<CodeInterpreterOutputLogs>**](CodeInterpreterOutputLogs.md) | The outputs generated by the code interpreter, such as logs or images. |  |
+| **type** | **String** |  | [optional][default to 'code_interpreter_output'] |
+| **status** | **String** |  | [optional][default to 'completed'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CodeInterpreterOutput.new(
+  id: null,
+  code: null,
+  container_id: null,
+  outputs: null,
+  type: null,
+  status: null
+)
+```
+

data/docs/CodeInterpreterOutputLogs.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::CodeInterpreterOutputLogs
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logs** | **String** | The logs output from the code interpreter. |  |
+| **type** | **String** |  | [optional][default to 'logs'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CodeInterpreterOutputLogs.new(
+  logs: null,
+  type: null
+)
+```
+

data/docs/FileSearchOutput.md

@@ -0,0 +1,26 @@
+# RagieRubySdk::FileSearchOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **queries** | **Array<String>** | The queries used to search for files. |  |
+| **status** | **String** |  | [optional][default to 'searching'] |
+| **type** | **String** |  |  |
+| **results** | [**Array<FileSearchResult>**](FileSearchResult.md) | The results of the file search tool call. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::FileSearchOutput.new(
+  id: null,
+  queries: null,
+  status: null,
+  type: null,
+  results: null
+)
+```
+

data/docs/FileSearchResult.md

@@ -0,0 +1,26 @@
+# RagieRubySdk::FileSearchResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_id** | **String** | The unique ID of the document. |  |
+| **filename** | **String** | The name of the document. |  |
+| **score** | **Float** | The relevance score of the chunk - a value between 0 and 1. |  |
+| **text** | **String** | The text content of the chunk. |  |
+| **attributes** | **Hash<String, Object>** | The attributes of the chunk. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::FileSearchResult.new(
+  file_id: null,
+  filename: null,
+  score: null,
+  text: null,
+  attributes: null
+)
+```
+

data/docs/FinalAnswerStepsInner.md

@@ -10,6 +10,8 @@
 | **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) | The search request to be made. |  |
+| **query_details** | [**Array<QueryDetails>**](QueryDetails.md) |  | [optional] |
+| **search_log** | **String** | A log of the search results you found. | [optional][default to ''] |
 | **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 ''] |
@@ -30,6 +32,8 @@ instance = RagieRubySdk::FinalAnswerStepsInner.new(
   other_resolved_question_ids: null,
   answer: null,
   search: null,
+  query_details: null,
+  search_log: null,
   questions_to_answer: null,
   code_issue: null,
   code: null,

data/docs/QueryDetails.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::QueryDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** |  |  |
+| **search_effort** | [**SearchEffort**](SearchEffort.md) |  |  |
+| **metadata_filter** | **Hash<String, Object>** |  |  |
+| **search_results** | [**Array<RagieEvidence>**](RagieEvidence.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::QueryDetails.new(
+  query: null,
+  search_effort: null,
+  metadata_filter: null,
+  search_results: null
+)
+```
+

data/docs/ReasoningOutput.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::ReasoningOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the reasoning output. |  |
+| **summary** | [**Array<ReasoningSummary>**](ReasoningSummary.md) | The summary of the reasoning. |  |
+| **type** | **String** |  | [optional][default to 'reasoning'] |
+| **content** | [**Array<ReasoningText>**](ReasoningText.md) | The content of the reasoning. |  |
+| **encrypted_content** | **String** | The encrypted content of the reasoning output. |  |
+| **status** | **String** |  | [optional][default to 'completed'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ReasoningOutput.new(
+  id: null,
+  summary: null,
+  type: null,
+  content: null,
+  encrypted_content: null,
+  status: null
+)
+```
+

data/docs/ReasoningSummary.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::ReasoningSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **summary** | **String** | The summary of the reasoning. |  |
+| **type** | **String** |  | [optional][default to 'summary'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ReasoningSummary.new(
+  summary: null,
+  type: null
+)
+```
+

data/docs/ReasoningText.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::ReasoningText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The text of the reasoning. |  |
+| **type** | **String** |  | [optional][default to 'reasoning_text'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ReasoningText.new(
+  text: null,
+  type: null
+)
+```
+

data/docs/Response.md

@@ -13,7 +13,7 @@
 | **instructions** | **String** |  | [optional] |
 | **max_output_tokens** | **Object** |  | [optional] |
 | **model** | **String** |  | [optional][default to 'deep-search'] |
-| **output** | [**Array<ResponseOutput>**](ResponseOutput.md) |  |  |
+| **output** | [**Array<ResponseOutputInner>**](ResponseOutputInner.md) |  |  |
 | **output_parsed** | [**FinalAnswer**](FinalAnswer.md) |  | [optional] |
 | **tools** | [**Array<Tool>**](Tool.md) |  |  |
 | **reasoning** | [**Reasoning**](Reasoning.md) |  |  |

data/docs/ResponseOutputInner.md

@@ -0,0 +1,40 @@
+# RagieRubySdk::ResponseOutputInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [default to 'message'] |
+| **id** | **String** |  |  |
+| **role** | **String** |  | [optional][default to 'assistant'] |
+| **content** | [**Array<ReasoningText>**](ReasoningText.md) | The content of the reasoning. |  |
+| **summary** | [**Array<ReasoningSummary>**](ReasoningSummary.md) | The summary of the reasoning. |  |
+| **encrypted_content** | **String** | The encrypted content of the reasoning output. |  |
+| **status** | **String** |  | [optional][default to 'searching'] |
+| **code** | **String** | The code executed by the code interpreter. |  |
+| **container_id** | **String** | The ID of the container used to run the code. |  |
+| **outputs** | [**Array<CodeInterpreterOutputLogs>**](CodeInterpreterOutputLogs.md) | The outputs generated by the code interpreter, such as logs or images. |  |
+| **queries** | **Array<String>** | The queries used to search for files. |  |
+| **results** | [**Array<FileSearchResult>**](FileSearchResult.md) | The results of the file search tool call. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ResponseOutputInner.new(
+  type: null,
+  id: null,
+  role: null,
+  content: null,
+  summary: null,
+  encrypted_content: null,
+  status: null,
+  code: null,
+  container_id: null,
+  outputs: null,
+  queries: null,
+  results: null
+)
+```
+

data/docs/{ResponseOutput.md → ResponseOutputMessage.md}

@@ -1,4 +1,4 @@
-# RagieRubySdk::ResponseOutput
+# RagieRubySdk::ResponseOutputMessage
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'ragie_ruby_sdk'
 
-instance = RagieRubySdk::ResponseOutput.new(
+instance = RagieRubySdk::ResponseOutputMessage.new(
   type: null,
   id: null,
   role: null,

data/docs/SearchEffort.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::SearchEffort
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SearchEffort.new()
+```
+

data/docs/SearchStep.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** |  | [optional][default to 'search'] |
+| **type** | **String** |  | [optional][default to 'base_search'] |
 | **think** | **String** |  |  |
 | **current_question** | **String** |  |  |
 | **search** | [**Search**](Search.md) | The search request to be made. |  |

data/docs/SearchStepWithQueryDetails.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::SearchStepWithQueryDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'search'] |
+| **search** | [**Search**](Search.md) | The search request to be made. |  |
+| **query_details** | [**Array<QueryDetails>**](QueryDetails.md) |  | [optional] |
+| **search_log** | **String** | A log of the search results you found. | [optional][default to ''] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SearchStepWithQueryDetails.new(
+  type: null,
+  search: null,
+  query_details: null,
+  search_log: null
+)
+```
+