ragie_ruby_sdk 1.0.12 → 1.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -4
  3. data/docs/AgentHoppsModelsModelsUsage.md +18 -0
  4. data/docs/Answer.md +20 -0
  5. data/docs/AnswerStep.md +26 -0
  6. data/docs/CodeInterpreterEvidence.md +26 -0
  7. data/docs/CodeStep.md +28 -0
  8. data/docs/EvaluatedAnswerStep.md +30 -0
  9. data/docs/FinalAnswer.md +24 -0
  10. data/docs/FinalAnswerEvidenceInner.md +40 -0
  11. data/docs/FinalAnswerStepsInner.md +42 -0
  12. data/docs/InputTokenDetails.md +18 -0
  13. data/docs/IntercomData.md +3 -1
  14. data/docs/ModelUsage.md +22 -0
  15. data/docs/OutputTokenDetails.md +18 -0
  16. data/docs/PlanStep.md +24 -0
  17. data/docs/RagieApiSchemaResponseUsage.md +26 -0
  18. data/docs/RagieEvidence.md +34 -0
  19. data/docs/Reasoning.md +20 -0
  20. data/docs/Request.md +28 -0
  21. data/docs/Response.md +62 -0
  22. data/docs/ResponseContent.md +22 -0
  23. data/docs/ResponseOutput.md +24 -0
  24. data/docs/ResponsesApi.md +147 -0
  25. data/docs/Search.md +18 -0
  26. data/docs/SearchResultLink.md +20 -0
  27. data/docs/SearchStep.md +24 -0
  28. data/docs/SurrenderStep.md +24 -0
  29. data/docs/Tool.md +20 -0
  30. data/lib/ragie_ruby_sdk/api/responses_api.rb +153 -0
  31. data/lib/ragie_ruby_sdk/models/agent_hopps_models_models_usage.rb +222 -0
  32. data/lib/ragie_ruby_sdk/models/answer.rb +250 -0
  33. data/lib/ragie_ruby_sdk/models/answer_step.rb +346 -0
  34. data/lib/ragie_ruby_sdk/models/code_interpreter_evidence.rb +363 -0
  35. data/lib/ragie_ruby_sdk/models/code_step.rb +359 -0
  36. data/lib/ragie_ruby_sdk/models/evaluated_answer_step.rb +398 -0
  37. data/lib/ragie_ruby_sdk/models/final_answer.rb +272 -0
  38. data/lib/ragie_ruby_sdk/models/final_answer_evidence_inner.rb +103 -0
  39. data/lib/ragie_ruby_sdk/models/final_answer_steps_inner.rb +107 -0
  40. data/lib/ragie_ruby_sdk/models/input_token_details.rb +222 -0
  41. data/lib/ragie_ruby_sdk/models/intercom_data.rb +14 -4
  42. data/lib/ragie_ruby_sdk/models/model_usage.rb +289 -0
  43. data/lib/ragie_ruby_sdk/models/output_token_details.rb +222 -0
  44. data/lib/ragie_ruby_sdk/models/plan_step.rb +320 -0
  45. data/lib/ragie_ruby_sdk/models/ragie_api_schema_response_usage.rb +307 -0
  46. data/lib/ragie_ruby_sdk/models/ragie_evidence.rb +426 -0
  47. data/lib/ragie_ruby_sdk/models/reasoning.rb +271 -0
  48. data/lib/ragie_ruby_sdk/models/request.rb +328 -0
  49. data/lib/ragie_ruby_sdk/models/response.rb +638 -0
  50. data/lib/ragie_ruby_sdk/models/response_content.rb +293 -0
  51. data/lib/ragie_ruby_sdk/models/response_output.rb +333 -0
  52. data/lib/ragie_ruby_sdk/models/search.rb +239 -0
  53. data/lib/ragie_ruby_sdk/models/search_result_link.rb +263 -0
  54. data/lib/ragie_ruby_sdk/models/search_step.rb +335 -0
  55. data/lib/ragie_ruby_sdk/models/surrender_step.rb +335 -0
  56. data/lib/ragie_ruby_sdk/models/tool.rb +289 -0
  57. data/lib/ragie_ruby_sdk/version.rb +1 -1
  58. data/lib/ragie_ruby_sdk.rb +26 -0
  59. data/spec/api/responses_api_spec.rb +59 -0
  60. data/spec/models/agent_hopps_models_models_usage_spec.rb +36 -0
  61. data/spec/models/answer_spec.rb +42 -0
  62. data/spec/models/answer_step_spec.rb +64 -0
  63. data/spec/models/code_interpreter_evidence_spec.rb +64 -0
  64. data/spec/models/code_step_spec.rb +70 -0
  65. data/spec/models/evaluated_answer_step_spec.rb +76 -0
  66. data/spec/models/final_answer_evidence_inner_spec.rb +21 -0
  67. data/spec/models/final_answer_spec.rb +54 -0
  68. data/spec/models/final_answer_steps_inner_spec.rb +21 -0
  69. data/spec/models/input_token_details_spec.rb +36 -0
  70. data/spec/models/intercom_data_spec.rb +6 -0
  71. data/spec/models/model_usage_spec.rb +48 -0
  72. data/spec/models/output_token_details_spec.rb +36 -0
  73. data/spec/models/plan_step_spec.rb +58 -0
  74. data/spec/models/ragie_api_schema_response_usage_spec.rb +60 -0
  75. data/spec/models/ragie_evidence_spec.rb +88 -0
  76. data/spec/models/reasoning_spec.rb +46 -0
  77. data/spec/models/request_spec.rb +70 -0
  78. data/spec/models/response_content_spec.rb +52 -0
  79. data/spec/models/response_output_spec.rb +62 -0
  80. data/spec/models/response_spec.rb +188 -0
  81. data/spec/models/search_result_link_spec.rb +42 -0
  82. data/spec/models/search_spec.rb +36 -0
  83. data/spec/models/search_step_spec.rb +58 -0
  84. data/spec/models/surrender_step_spec.rb +58 -0
  85. data/spec/models/tool_spec.rb +46 -0
  86. metadata +105 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c145be88b761526deca183a8f9fb906f22bc34698a46a1c32cb7357a62c5e85e
4
- data.tar.gz: 2fa85a27f7b5f09b67d6f2deeb12c1d44e443ea57653807784d0753688cd648f
3
+ metadata.gz: 17873019808725418e224defcf9e3818132ee8addcefb0141f70f65eb3367077
4
+ data.tar.gz: 73d8514f89ce01aa8912fe9a9c10b12116073fc3e4cfb619a53f4f63882b2702
5
5
  SHA512:
6
- metadata.gz: f57967d5deb76ff2c38b87656cf146c7b6895788d12dfab19351a4ba8087f78b7aecf0e95e0960f6e248164ebdc84198f8785d0b57ef8a9d493eb310f583df25
7
- data.tar.gz: c1e8068cfe5b4e55b1f36771679bc412eda6fc97c2522f52deed844d36bccb7e03a3586bd68610f04b51cca7274a59c6dd1c4db07914596667f0f3db8707b756
6
+ metadata.gz: 4c9bf30d59bfe88509f9696075480fc3f8efebc5d24953e21a74779cf64adcfd14c18ab834ad6ab4d07279b98c5fcc2392d46a37f76190139d0be728ddd2dab9
7
+ data.tar.gz: af09b17a96e59577570352f306bd754a3eb5325a7c106e6ce5c654b744074c22646fc91a4bc9b8e8e6cd5747d661969b744cb1dcfff889f9ad193824e56ae7b9
data/README.md CHANGED
@@ -7,7 +7,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 1.0.0
10
- - Package version: 1.0.11
10
+ - Package version: 1.0.13
11
11
  - Generator version: 7.16.0-SNAPSHOT
12
12
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
13
13
 
@@ -24,16 +24,16 @@ gem build ragie_ruby_sdk.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ragie_ruby_sdk-1.0.11.gem
27
+ gem install ./ragie_ruby_sdk-1.0.13.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ragie_ruby_sdk-1.0.11.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ragie_ruby_sdk-1.0.13.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ragie_ruby_sdk', '~> 1.0.11'
36
+ gem 'ragie_ruby_sdk', '~> 1.0.13'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -138,12 +138,17 @@ Class | Method | HTTP request | Description
138
138
  *RagieRubySdk::PartitionsApi* | [**get_partition_partitions_partition_id_get**](docs/PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition
139
139
  *RagieRubySdk::PartitionsApi* | [**list_partitions_partitions_get**](docs/PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions
140
140
  *RagieRubySdk::PartitionsApi* | [**set_partition_limits_partitions_partition_id_limits_put**](docs/PartitionsApi.md#set_partition_limits_partitions_partition_id_limits_put) | **PUT** /partitions/{partition_id}/limits | Set Partition Limits
141
+ *RagieRubySdk::ResponsesApi* | [**create_response_responses_post**](docs/ResponsesApi.md#create_response_responses_post) | **POST** /responses | Create Response
142
+ *RagieRubySdk::ResponsesApi* | [**get_response_responses_response_id_get**](docs/ResponsesApi.md#get_response_responses_response_id_get) | **GET** /responses/{response_id} | Get Response
141
143
  *RagieRubySdk::RetrievalsApi* | [**retrieve**](docs/RetrievalsApi.md#retrieve) | **POST** /retrievals | Retrieve
142
144
 
143
145
 
144
146
  ## Documentation for Models
145
147
 
146
148
  - [RagieRubySdk::AccessTokenCredentials](docs/AccessTokenCredentials.md)
149
+ - [RagieRubySdk::AgentHoppsModelsModelsUsage](docs/AgentHoppsModelsModelsUsage.md)
150
+ - [RagieRubySdk::Answer](docs/Answer.md)
151
+ - [RagieRubySdk::AnswerStep](docs/AnswerStep.md)
147
152
  - [RagieRubySdk::AsyncDocumentMetadataUpdate](docs/AsyncDocumentMetadataUpdate.md)
148
153
  - [RagieRubySdk::AudioModalityData](docs/AudioModalityData.md)
149
154
  - [RagieRubySdk::AuthenticatorConfluenceConnection](docs/AuthenticatorConfluenceConnection.md)
@@ -164,6 +169,8 @@ Class | Method | HTTP request | Description
164
169
  - [RagieRubySdk::BodyCreateDocument](docs/BodyCreateDocument.md)
165
170
  - [RagieRubySdk::BodyUpdateDocumentFile](docs/BodyUpdateDocumentFile.md)
166
171
  - [RagieRubySdk::BucketData](docs/BucketData.md)
172
+ - [RagieRubySdk::CodeInterpreterEvidence](docs/CodeInterpreterEvidence.md)
173
+ - [RagieRubySdk::CodeStep](docs/CodeStep.md)
167
174
  - [RagieRubySdk::ConfluenceData](docs/ConfluenceData.md)
168
175
  - [RagieRubySdk::Connection](docs/Connection.md)
169
176
  - [RagieRubySdk::Connection1](docs/Connection1.md)
@@ -214,6 +221,10 @@ Class | Method | HTTP request | Description
214
221
  - [RagieRubySdk::EntityExtractedWebhookPayload](docs/EntityExtractedWebhookPayload.md)
215
222
  - [RagieRubySdk::EntityList](docs/EntityList.md)
216
223
  - [RagieRubySdk::ErrorMessage](docs/ErrorMessage.md)
224
+ - [RagieRubySdk::EvaluatedAnswerStep](docs/EvaluatedAnswerStep.md)
225
+ - [RagieRubySdk::FinalAnswer](docs/FinalAnswer.md)
226
+ - [RagieRubySdk::FinalAnswerEvidenceInner](docs/FinalAnswerEvidenceInner.md)
227
+ - [RagieRubySdk::FinalAnswerStepsInner](docs/FinalAnswerStepsInner.md)
217
228
  - [RagieRubySdk::FolderData](docs/FolderData.md)
218
229
  - [RagieRubySdk::FreshdeskCredentials](docs/FreshdeskCredentials.md)
219
230
  - [RagieRubySdk::FreshdeskData](docs/FreshdeskData.md)
@@ -221,6 +232,7 @@ Class | Method | HTTP request | Description
221
232
  - [RagieRubySdk::GoogleFolderData](docs/GoogleFolderData.md)
222
233
  - [RagieRubySdk::HTTPValidationError](docs/HTTPValidationError.md)
223
234
  - [RagieRubySdk::HubspotData](docs/HubspotData.md)
235
+ - [RagieRubySdk::InputTokenDetails](docs/InputTokenDetails.md)
224
236
  - [RagieRubySdk::Instruction](docs/Instruction.md)
225
237
  - [RagieRubySdk::IntercomCredentials](docs/IntercomCredentials.md)
226
238
  - [RagieRubySdk::IntercomData](docs/IntercomData.md)
@@ -233,11 +245,13 @@ Class | Method | HTTP request | Description
233
245
  - [RagieRubySdk::Mode1](docs/Mode1.md)
234
246
  - [RagieRubySdk::Mode2](docs/Mode2.md)
235
247
  - [RagieRubySdk::Mode2OneOf](docs/Mode2OneOf.md)
248
+ - [RagieRubySdk::ModelUsage](docs/ModelUsage.md)
236
249
  - [RagieRubySdk::OAuthCredentials](docs/OAuthCredentials.md)
237
250
  - [RagieRubySdk::OAuthRefreshTokenCredentials](docs/OAuthRefreshTokenCredentials.md)
238
251
  - [RagieRubySdk::OAuthUrlCreate](docs/OAuthUrlCreate.md)
239
252
  - [RagieRubySdk::OAuthUrlResponse](docs/OAuthUrlResponse.md)
240
253
  - [RagieRubySdk::OnedriveData](docs/OnedriveData.md)
254
+ - [RagieRubySdk::OutputTokenDetails](docs/OutputTokenDetails.md)
241
255
  - [RagieRubySdk::Pagination](docs/Pagination.md)
242
256
  - [RagieRubySdk::Partition](docs/Partition.md)
243
257
  - [RagieRubySdk::PartitionDetail](docs/PartitionDetail.md)
@@ -252,6 +266,7 @@ Class | Method | HTTP request | Description
252
266
  - [RagieRubySdk::PartitionStrategy](docs/PartitionStrategy.md)
253
267
  - [RagieRubySdk::PatchDocumentMetadataParams](docs/PatchDocumentMetadataParams.md)
254
268
  - [RagieRubySdk::Payload](docs/Payload.md)
269
+ - [RagieRubySdk::PlanStep](docs/PlanStep.md)
255
270
  - [RagieRubySdk::PublicBackblazeConnection](docs/PublicBackblazeConnection.md)
256
271
  - [RagieRubySdk::PublicCreateConnection](docs/PublicCreateConnection.md)
257
272
  - [RagieRubySdk::PublicFreshdeskConnection](docs/PublicFreshdeskConnection.md)
@@ -259,18 +274,30 @@ Class | Method | HTTP request | Description
259
274
  - [RagieRubySdk::PublicIntercomConnection](docs/PublicIntercomConnection.md)
260
275
  - [RagieRubySdk::PublicS3CompatibleConnection](docs/PublicS3CompatibleConnection.md)
261
276
  - [RagieRubySdk::PublicZendeskConnection](docs/PublicZendeskConnection.md)
277
+ - [RagieRubySdk::RagieApiSchemaResponseUsage](docs/RagieApiSchemaResponseUsage.md)
278
+ - [RagieRubySdk::RagieEvidence](docs/RagieEvidence.md)
279
+ - [RagieRubySdk::Reasoning](docs/Reasoning.md)
280
+ - [RagieRubySdk::Request](docs/Request.md)
281
+ - [RagieRubySdk::Response](docs/Response.md)
282
+ - [RagieRubySdk::ResponseContent](docs/ResponseContent.md)
262
283
  - [RagieRubySdk::ResponseOK](docs/ResponseOK.md)
284
+ - [RagieRubySdk::ResponseOutput](docs/ResponseOutput.md)
263
285
  - [RagieRubySdk::ResponsePatchdocumentmetadata](docs/ResponsePatchdocumentmetadata.md)
264
286
  - [RagieRubySdk::Retrieval](docs/Retrieval.md)
265
287
  - [RagieRubySdk::RetrieveParams](docs/RetrieveParams.md)
266
288
  - [RagieRubySdk::S3CompatibleCredentials](docs/S3CompatibleCredentials.md)
267
289
  - [RagieRubySdk::ScoredChunk](docs/ScoredChunk.md)
290
+ - [RagieRubySdk::Search](docs/Search.md)
291
+ - [RagieRubySdk::SearchResultLink](docs/SearchResultLink.md)
292
+ - [RagieRubySdk::SearchStep](docs/SearchStep.md)
268
293
  - [RagieRubySdk::SetConnectionEnabledPayload](docs/SetConnectionEnabledPayload.md)
269
294
  - [RagieRubySdk::SharepointData](docs/SharepointData.md)
270
295
  - [RagieRubySdk::SharepointFileData](docs/SharepointFileData.md)
271
296
  - [RagieRubySdk::SharepointSiteData](docs/SharepointSiteData.md)
272
297
  - [RagieRubySdk::SlackData](docs/SlackData.md)
273
298
  - [RagieRubySdk::Source](docs/Source.md)
299
+ - [RagieRubySdk::SurrenderStep](docs/SurrenderStep.md)
300
+ - [RagieRubySdk::Tool](docs/Tool.md)
274
301
  - [RagieRubySdk::UpdateDocumentFromUrlParams](docs/UpdateDocumentFromUrlParams.md)
275
302
  - [RagieRubySdk::UpdateDocumentRawParams](docs/UpdateDocumentRawParams.md)
276
303
  - [RagieRubySdk::UpdateInstructionParams](docs/UpdateInstructionParams.md)
@@ -0,0 +1,18 @@
1
+ # RagieRubySdk::AgentHoppsModelsModelsUsage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **models** | [**Array<ModelUsage>**](ModelUsage.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ragie_ruby_sdk'
13
+
14
+ instance = RagieRubySdk::AgentHoppsModelsModelsUsage.new(
15
+ models: null
16
+ )
17
+ ```
18
+
data/docs/Answer.md ADDED
@@ -0,0 +1,20 @@
1
+ # RagieRubySdk::Answer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | An answer to a question. | |
8
+ | **evidence** | **Array<String>** | The evidence used to derive the answer. | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ragie_ruby_sdk'
14
+
15
+ instance = RagieRubySdk::Answer.new(
16
+ text: null,
17
+ evidence: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,26 @@
1
+ # RagieRubySdk::AnswerStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'answer'] |
8
+ | **think** | **String** | | |
9
+ | **current_question** | **String** | | |
10
+ | **other_resolved_question_ids** | **Array<String>** | A list of question ids that are no longer relevant to the current answer referenced by their IDs. | [optional] |
11
+ | **answer** | [**Answer**](Answer.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ragie_ruby_sdk'
17
+
18
+ instance = RagieRubySdk::AnswerStep.new(
19
+ type: null,
20
+ think: null,
21
+ current_question: null,
22
+ other_resolved_question_ids: null,
23
+ answer: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # RagieRubySdk::CodeInterpreterEvidence
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'code_interpreter'] |
8
+ | **text** | **String** | | |
9
+ | **code** | **String** | The code that was executed. | |
10
+ | **code_issue** | **String** | The issue that the code was written to solve. | |
11
+ | **code_result** | **String** | The result of the code that was executed. | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ragie_ruby_sdk'
17
+
18
+ instance = RagieRubySdk::CodeInterpreterEvidence.new(
19
+ type: null,
20
+ text: null,
21
+ code: null,
22
+ code_issue: null,
23
+ code_result: null
24
+ )
25
+ ```
26
+
data/docs/CodeStep.md ADDED
@@ -0,0 +1,28 @@
1
+ # RagieRubySdk::CodeStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'code'] |
8
+ | **think** | **String** | | |
9
+ | **current_question** | **String** | | |
10
+ | **code_issue** | **String** | The natural language description of the code issue you need to solve. | |
11
+ | **code** | **String** | The code you generated to solve the code issue. | [optional][default to ''] |
12
+ | **code_result** | **String** | The result of the code you generated after executing it. | [optional][default to ''] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ragie_ruby_sdk'
18
+
19
+ instance = RagieRubySdk::CodeStep.new(
20
+ type: null,
21
+ think: null,
22
+ current_question: null,
23
+ code_issue: null,
24
+ code: null,
25
+ code_result: null
26
+ )
27
+ ```
28
+
@@ -0,0 +1,30 @@
1
+ # RagieRubySdk::EvaluatedAnswerStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'evaluated_answer'] |
8
+ | **think** | **String** | | |
9
+ | **current_question** | **String** | | |
10
+ | **answer** | [**Answer**](Answer.md) | | |
11
+ | **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] |
12
+ | **eval_passed** | **Boolean** | | |
13
+ | **eval_reason** | **String** | | |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ragie_ruby_sdk'
19
+
20
+ instance = RagieRubySdk::EvaluatedAnswerStep.new(
21
+ type: null,
22
+ think: null,
23
+ current_question: null,
24
+ answer: null,
25
+ other_resolved_question_ids: null,
26
+ eval_passed: null,
27
+ eval_reason: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,24 @@
1
+ # RagieRubySdk::FinalAnswer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | The final answer to the question. | |
8
+ | **evidence** | [**Array<FinalAnswerEvidenceInner>**](FinalAnswerEvidenceInner.md) | The evidence used to derive the answer. | [optional] |
9
+ | **steps** | [**Array<FinalAnswerStepsInner>**](FinalAnswerStepsInner.md) | The steps that led to the answer. | [optional] |
10
+ | **usage** | [**AgentHoppsModelsModelsUsage**](AgentHoppsModelsModelsUsage.md) | The usage of the models. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ragie_ruby_sdk'
16
+
17
+ instance = RagieRubySdk::FinalAnswer.new(
18
+ text: null,
19
+ evidence: null,
20
+ steps: null,
21
+ usage: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,40 @@
1
+ # RagieRubySdk::FinalAnswerEvidenceInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'code_interpreter'] |
8
+ | **text** | **String** | | |
9
+ | **code** | **String** | The code that was executed. | |
10
+ | **code_issue** | **String** | The issue that the code was written to solve. | |
11
+ | **code_result** | **String** | The result of the code that was executed. | |
12
+ | **id** | **String** | The chunk id of the evidence. | |
13
+ | **index** | **Integer** | The index of the chunk in the document. | |
14
+ | **document_id** | **String** | The document id of the document containing the chunk being used as evidence. | |
15
+ | **document_name** | **String** | The name of the document that contains the chunk being used as evidence. | |
16
+ | **metadata** | **Hash<String, Object>** | The metadata of the chunk being used as evidence. | [optional] |
17
+ | **document_metadata** | **Hash<String, Object>** | The metadata of the document that contains the evidence. | [optional] |
18
+ | **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | The links to the evidence. | [optional] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'ragie_ruby_sdk'
24
+
25
+ instance = RagieRubySdk::FinalAnswerEvidenceInner.new(
26
+ type: null,
27
+ text: null,
28
+ code: null,
29
+ code_issue: null,
30
+ code_result: null,
31
+ id: null,
32
+ index: null,
33
+ document_id: null,
34
+ document_name: null,
35
+ metadata: null,
36
+ document_metadata: null,
37
+ links: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,42 @@
1
+ # RagieRubySdk::FinalAnswerStepsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'answer'] |
8
+ | **think** | **String** | | |
9
+ | **current_question** | **String** | | |
10
+ | **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] |
11
+ | **answer** | [**Answer**](Answer.md) | | |
12
+ | **search** | [**Search**](Search.md) | The search request to be made. | |
13
+ | **questions_to_answer** | **Array<String>** | The questions that need to be answered to answer the original question. | [optional] |
14
+ | **code_issue** | **String** | The natural language description of the code issue you need to solve. | |
15
+ | **code** | **String** | The code you generated to solve the code issue. | [optional][default to ''] |
16
+ | **code_result** | **String** | The result of the code you generated after executing it. | [optional][default to ''] |
17
+ | **partial_answer** | [**Answer**](Answer.md) | The a potential partial answer when a full answer was not possible. | |
18
+ | **eval_passed** | **Boolean** | | |
19
+ | **eval_reason** | **String** | | |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ragie_ruby_sdk'
25
+
26
+ instance = RagieRubySdk::FinalAnswerStepsInner.new(
27
+ type: null,
28
+ think: null,
29
+ current_question: null,
30
+ other_resolved_question_ids: null,
31
+ answer: null,
32
+ search: null,
33
+ questions_to_answer: null,
34
+ code_issue: null,
35
+ code: null,
36
+ code_result: null,
37
+ partial_answer: null,
38
+ eval_passed: null,
39
+ eval_reason: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,18 @@
1
+ # RagieRubySdk::InputTokenDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **cached_tokens** | **Integer** | | [optional][default to 0] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ragie_ruby_sdk'
13
+
14
+ instance = RagieRubySdk::InputTokenDetails.new(
15
+ cached_tokens: null
16
+ )
17
+ ```
18
+
data/docs/IntercomData.md CHANGED
@@ -14,6 +14,7 @@
14
14
  | **ticket_attachments** | **Boolean** | | [optional][default to false] |
15
15
  | **ticket_comments** | **Boolean** | | [optional][default to false] |
16
16
  | **ticket_notes** | **Boolean** | | [optional][default to false] |
17
+ | **filter_user_id** | **String** | | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -30,7 +31,8 @@ instance = RagieRubySdk::IntercomData.new(
30
31
  tickets: null,
31
32
  ticket_attachments: null,
32
33
  ticket_comments: null,
33
- ticket_notes: null
34
+ ticket_notes: null,
35
+ filter_user_id: null
34
36
  )
35
37
  ```
36
38
 
@@ -0,0 +1,22 @@
1
+ # RagieRubySdk::ModelUsage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **model_name** | **String** | | |
8
+ | **input_tokens** | **Integer** | | |
9
+ | **output_tokens** | **Integer** | | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ragie_ruby_sdk'
15
+
16
+ instance = RagieRubySdk::ModelUsage.new(
17
+ model_name: null,
18
+ input_tokens: null,
19
+ output_tokens: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # RagieRubySdk::OutputTokenDetails
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reasoning_tokens** | **Integer** | | [optional][default to 0] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ragie_ruby_sdk'
13
+
14
+ instance = RagieRubySdk::OutputTokenDetails.new(
15
+ reasoning_tokens: null
16
+ )
17
+ ```
18
+
data/docs/PlanStep.md ADDED
@@ -0,0 +1,24 @@
1
+ # RagieRubySdk::PlanStep
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'plan'] |
8
+ | **think** | **String** | | |
9
+ | **current_question** | **String** | | |
10
+ | **questions_to_answer** | **Array<String>** | The questions that need to be answered to answer the original question. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ragie_ruby_sdk'
16
+
17
+ instance = RagieRubySdk::PlanStep.new(
18
+ type: null,
19
+ think: null,
20
+ current_question: null,
21
+ questions_to_answer: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,26 @@
1
+ # RagieRubySdk::RagieApiSchemaResponseUsage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input_tokens** | **Integer** | | |
8
+ | **input_token_details** | [**InputTokenDetails**](InputTokenDetails.md) | | [optional] |
9
+ | **output_tokens** | **Integer** | | |
10
+ | **output_token_details** | [**OutputTokenDetails**](OutputTokenDetails.md) | | [optional] |
11
+ | **total_tokens** | **Integer** | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ragie_ruby_sdk'
17
+
18
+ instance = RagieRubySdk::RagieApiSchemaResponseUsage.new(
19
+ input_tokens: null,
20
+ input_token_details: null,
21
+ output_tokens: null,
22
+ output_token_details: null,
23
+ total_tokens: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,34 @@
1
+ # RagieRubySdk::RagieEvidence
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **type** | **String** | | [optional][default to 'ragie'] |
8
+ | **text** | **String** | | |
9
+ | **id** | **String** | The chunk id of the evidence. | |
10
+ | **index** | **Integer** | The index of the chunk in the document. | |
11
+ | **document_id** | **String** | The document id of the document containing the chunk being used as evidence. | |
12
+ | **document_name** | **String** | The name of the document that contains the chunk being used as evidence. | |
13
+ | **metadata** | **Hash<String, Object>** | The metadata of the chunk being used as evidence. | [optional] |
14
+ | **document_metadata** | **Hash<String, Object>** | The metadata of the document that contains the evidence. | [optional] |
15
+ | **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | The links to the evidence. | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'ragie_ruby_sdk'
21
+
22
+ instance = RagieRubySdk::RagieEvidence.new(
23
+ type: null,
24
+ text: null,
25
+ id: null,
26
+ index: null,
27
+ document_id: null,
28
+ document_name: null,
29
+ metadata: null,
30
+ document_metadata: null,
31
+ links: null
32
+ )
33
+ ```
34
+
data/docs/Reasoning.md ADDED
@@ -0,0 +1,20 @@
1
+ # RagieRubySdk::Reasoning
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **effort** | **String** | | |
8
+ | **summary** | **Object** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ragie_ruby_sdk'
14
+
15
+ instance = RagieRubySdk::Reasoning.new(
16
+ effort: null,
17
+ summary: null
18
+ )
19
+ ```
20
+
data/docs/Request.md ADDED
@@ -0,0 +1,28 @@
1
+ # RagieRubySdk::Request
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input** | **String** | The text used to generate the response. Generally a question or a query. | |
8
+ | **instructions** | **String** | | [optional] |
9
+ | **tools** | [**Array<Tool>**](Tool.md) | The tools available to the agent. Currently the only tool is retrieve. The `default` partition is used by default unless an other partition is specified. | [optional] |
10
+ | **model** | **String** | The model to use for the agent. Currently the only model is deep-search. | [optional][default to 'deep-search'] |
11
+ | **reasoning** | [**Reasoning**](Reasoning.md) | The reasoning to use for the agent. The default effort level is medium. | [optional] |
12
+ | **stream** | **Boolean** | Whether to stream the response | [optional][default to false] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'ragie_ruby_sdk'
18
+
19
+ instance = RagieRubySdk::Request.new(
20
+ input: null,
21
+ instructions: null,
22
+ tools: null,
23
+ model: null,
24
+ reasoning: null,
25
+ stream: null
26
+ )
27
+ ```
28
+