ragie_ruby_sdk 1.0.11 → 1.0.13

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 (206) 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 +265 -0
  33. data/lib/ragie_ruby_sdk/models/answer_step.rb +346 -0
  34. data/lib/ragie_ruby_sdk/models/code_interpreter_evidence.rb +360 -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 +319 -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 +336 -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 +419 -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 +334 -0
  55. data/lib/ragie_ruby_sdk/models/surrender_step.rb +334 -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/access_token_credentials_spec.rb +1 -1
  61. data/spec/models/agent_hopps_models_models_usage_spec.rb +36 -0
  62. data/spec/models/answer_spec.rb +42 -0
  63. data/spec/models/answer_step_spec.rb +64 -0
  64. data/spec/models/async_document_metadata_update_spec.rb +1 -1
  65. data/spec/models/audio_modality_data_spec.rb +1 -1
  66. data/spec/models/authenticator_confluence_connection_spec.rb +1 -1
  67. data/spec/models/authenticator_dropbox_connection_spec.rb +1 -1
  68. data/spec/models/authenticator_gmail_connection_spec.rb +1 -1
  69. data/spec/models/authenticator_google_drive_connection_spec.rb +1 -1
  70. data/spec/models/authenticator_hubspot_connection_spec.rb +1 -1
  71. data/spec/models/authenticator_jira_connection_spec.rb +1 -1
  72. data/spec/models/authenticator_list_spec.rb +1 -1
  73. data/spec/models/authenticator_notion_connection_spec.rb +1 -1
  74. data/spec/models/authenticator_onedrive_connection_spec.rb +1 -1
  75. data/spec/models/authenticator_salesforce_connection_spec.rb +1 -1
  76. data/spec/models/authenticator_sharepoint_connection_spec.rb +1 -1
  77. data/spec/models/authenticator_slack_connection_spec.rb +1 -1
  78. data/spec/models/backblaze_credentials_spec.rb +1 -1
  79. data/spec/models/base_get_authenticator_spec.rb +1 -1
  80. data/spec/models/body_create_document_spec.rb +1 -1
  81. data/spec/models/body_update_document_file_spec.rb +1 -1
  82. data/spec/models/bucket_data_spec.rb +1 -1
  83. data/spec/models/code_interpreter_evidence_spec.rb +64 -0
  84. data/spec/models/code_step_spec.rb +70 -0
  85. data/spec/models/confluence_data_spec.rb +1 -1
  86. data/spec/models/connection_base_spec.rb +1 -1
  87. data/spec/models/connection_limit_exceeded_webhook_payload_spec.rb +1 -1
  88. data/spec/models/connection_limit_exceeded_webhook_spec.rb +1 -1
  89. data/spec/models/connection_limit_params_spec.rb +1 -1
  90. data/spec/models/connection_list_spec.rb +1 -1
  91. data/spec/models/connection_spec.rb +1 -1
  92. data/spec/models/connection_stats_spec.rb +1 -1
  93. data/spec/models/connection_sync_finished_webhook_payload_spec.rb +1 -1
  94. data/spec/models/connection_sync_finished_webhook_spec.rb +1 -1
  95. data/spec/models/connection_sync_progress_webhook_payload_spec.rb +1 -1
  96. data/spec/models/connection_sync_progress_webhook_spec.rb +1 -1
  97. data/spec/models/connection_sync_started_webhook_payload_spec.rb +1 -1
  98. data/spec/models/connection_sync_started_webhook_spec.rb +1 -1
  99. data/spec/models/connector_source_spec.rb +1 -1
  100. data/spec/models/connector_source_type_info_spec.rb +1 -1
  101. data/spec/models/create_authenticator_connection_spec.rb +1 -1
  102. data/spec/models/create_document_from_url_params_spec.rb +1 -1
  103. data/spec/models/create_document_raw_params_spec.rb +1 -1
  104. data/spec/models/create_google_authenticator_spec.rb +1 -1
  105. data/spec/models/create_instruction_params_spec.rb +1 -1
  106. data/spec/models/create_partition_params_spec.rb +1 -1
  107. data/spec/models/delete_connection_payload_spec.rb +1 -1
  108. data/spec/models/document_chunk_detail_spec.rb +1 -1
  109. data/spec/models/document_chunk_list_spec.rb +1 -1
  110. data/spec/models/document_chunk_spec.rb +1 -1
  111. data/spec/models/document_delete_spec.rb +1 -1
  112. data/spec/models/document_delete_webhook_payload_spec.rb +1 -1
  113. data/spec/models/document_delete_webhook_spec.rb +1 -1
  114. data/spec/models/document_file_update_spec.rb +1 -1
  115. data/spec/models/document_get_spec.rb +1 -1
  116. data/spec/models/document_list_spec.rb +1 -1
  117. data/spec/models/document_metadata_update_spec.rb +1 -1
  118. data/spec/models/document_raw_update_spec.rb +1 -1
  119. data/spec/models/document_spec.rb +1 -1
  120. data/spec/models/document_summary_spec.rb +1 -1
  121. data/spec/models/document_update_webhook_payload_spec.rb +1 -1
  122. data/spec/models/document_update_webhook_spec.rb +1 -1
  123. data/spec/models/document_url_update_spec.rb +1 -1
  124. data/spec/models/document_with_content_spec.rb +1 -1
  125. data/spec/models/entity_extracted_webhook_payload_spec.rb +1 -1
  126. data/spec/models/entity_extracted_webhook_spec.rb +1 -1
  127. data/spec/models/entity_list_spec.rb +1 -1
  128. data/spec/models/entity_spec.rb +1 -1
  129. data/spec/models/error_message_spec.rb +1 -1
  130. data/spec/models/evaluated_answer_step_spec.rb +76 -0
  131. data/spec/models/final_answer_evidence_inner_spec.rb +21 -0
  132. data/spec/models/final_answer_spec.rb +54 -0
  133. data/spec/models/final_answer_steps_inner_spec.rb +21 -0
  134. data/spec/models/folder_data_spec.rb +1 -1
  135. data/spec/models/freshdesk_credentials_spec.rb +1 -1
  136. data/spec/models/freshdesk_data_spec.rb +1 -1
  137. data/spec/models/gmail_data_spec.rb +1 -1
  138. data/spec/models/google_folder_data_spec.rb +1 -1
  139. data/spec/models/http_validation_error_spec.rb +1 -1
  140. data/spec/models/hubspot_data_spec.rb +1 -1
  141. data/spec/models/input_token_details_spec.rb +36 -0
  142. data/spec/models/instruction_spec.rb +1 -1
  143. data/spec/models/intercom_credentials_spec.rb +1 -1
  144. data/spec/models/intercom_data_spec.rb +7 -1
  145. data/spec/models/link_spec.rb +1 -1
  146. data/spec/models/list_connector_source_type_info_spec.rb +1 -1
  147. data/spec/models/media_mode_param_spec.rb +1 -1
  148. data/spec/models/mode2_one_of_spec.rb +1 -1
  149. data/spec/models/model_usage_spec.rb +48 -0
  150. data/spec/models/o_auth_credentials_spec.rb +1 -1
  151. data/spec/models/o_auth_refresh_token_credentials_spec.rb +1 -1
  152. data/spec/models/o_auth_url_create_spec.rb +1 -1
  153. data/spec/models/o_auth_url_response_spec.rb +1 -1
  154. data/spec/models/onedrive_data_spec.rb +1 -1
  155. data/spec/models/output_token_details_spec.rb +36 -0
  156. data/spec/models/pagination_spec.rb +1 -1
  157. data/spec/models/partition_detail_spec.rb +1 -1
  158. data/spec/models/partition_limit_exceeded_webhook_payload_spec.rb +1 -1
  159. data/spec/models/partition_limit_exceeded_webhook_spec.rb +1 -1
  160. data/spec/models/partition_limit_params_spec.rb +1 -1
  161. data/spec/models/partition_limit_reset_webhook_payload_spec.rb +1 -1
  162. data/spec/models/partition_limit_reset_webhook_spec.rb +1 -1
  163. data/spec/models/partition_limits_spec.rb +1 -1
  164. data/spec/models/partition_list_spec.rb +1 -1
  165. data/spec/models/partition_spec.rb +1 -1
  166. data/spec/models/partition_stats_spec.rb +1 -1
  167. data/spec/models/patch_document_metadata_params_spec.rb +1 -1
  168. data/spec/models/plan_step_spec.rb +58 -0
  169. data/spec/models/public_backblaze_connection_spec.rb +1 -1
  170. data/spec/models/public_create_connection_spec.rb +1 -1
  171. data/spec/models/public_freshdesk_connection_spec.rb +1 -1
  172. data/spec/models/public_gcs_connection_spec.rb +1 -1
  173. data/spec/models/public_intercom_connection_spec.rb +1 -1
  174. data/spec/models/public_s3_compatible_connection_spec.rb +1 -1
  175. data/spec/models/public_zendesk_connection_spec.rb +1 -1
  176. data/spec/models/ragie_api_schema_response_usage_spec.rb +60 -0
  177. data/spec/models/ragie_evidence_spec.rb +88 -0
  178. data/spec/models/reasoning_spec.rb +46 -0
  179. data/spec/models/request_spec.rb +70 -0
  180. data/spec/models/response_content_spec.rb +52 -0
  181. data/spec/models/response_ok_spec.rb +1 -1
  182. data/spec/models/response_output_spec.rb +62 -0
  183. data/spec/models/response_spec.rb +188 -0
  184. data/spec/models/retrieval_spec.rb +1 -1
  185. data/spec/models/retrieve_params_spec.rb +1 -1
  186. data/spec/models/s3_compatible_credentials_spec.rb +1 -1
  187. data/spec/models/scored_chunk_spec.rb +1 -1
  188. data/spec/models/search_result_link_spec.rb +42 -0
  189. data/spec/models/search_spec.rb +36 -0
  190. data/spec/models/search_step_spec.rb +58 -0
  191. data/spec/models/set_connection_enabled_payload_spec.rb +1 -1
  192. data/spec/models/sharepoint_data_spec.rb +1 -1
  193. data/spec/models/sharepoint_file_data_spec.rb +1 -1
  194. data/spec/models/sharepoint_site_data_spec.rb +1 -1
  195. data/spec/models/slack_data_spec.rb +1 -1
  196. data/spec/models/surrender_step_spec.rb +58 -0
  197. data/spec/models/tool_spec.rb +46 -0
  198. data/spec/models/update_document_from_url_params_spec.rb +1 -1
  199. data/spec/models/update_document_raw_params_spec.rb +1 -1
  200. data/spec/models/update_instruction_params_spec.rb +1 -1
  201. data/spec/models/validation_error_spec.rb +1 -1
  202. data/spec/models/video_modality_data_spec.rb +1 -1
  203. data/spec/models/word_timestamp_spec.rb +1 -1
  204. data/spec/models/zendesk_credentials_spec.rb +1 -1
  205. data/spec/models/zendesk_data_spec.rb +1 -1
  206. metadata +105 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 870e904f43a6746ec80aecdf350316763ffe38f0180d98167099e46809b118d2
4
- data.tar.gz: 03c2f40f6fee3add0a7a9f9a562318c257cccd5166dcdb6a13c1af5320858348
3
+ metadata.gz: 19f78a0aaabe1d16350f7dfa53223077f6b8a79b743c5c7264c27421d844cb3f
4
+ data.tar.gz: faa262957488dc7be955e383c77b2775cb9b6fccf7fb0ac03fbb4c233eb48346
5
5
  SHA512:
6
- metadata.gz: 4c98dd6eb041ae77d6074a08274c7c06537fb9b09f4b3b2076d7ca4cc0e1c51d41112f34e4964ec189baee424259ded47115dc500608c052690e3d85054fdc68
7
- data.tar.gz: 12c6da57b2ffd2c8542341e18fb7e3159f7d4477c8dd588d43225cd2f328dc3c95e2acb3c5f514f85e02d8fdc85718b91dc7db507eb2f1f7db51d0db8e9bcaed
6
+ metadata.gz: 82dc5689d3a0529b9371c5d4b72131fef0729fa3a149a98175313a1f08a04175f8d96426639cf6e5a47d6f00becb467c48e0e6b63803fc524e03a39f1306ae9e
7
+ data.tar.gz: 927fe56dd0e94ee403b4322ae9d40cb65dbc35e0cc532bb4bcf905d53088878d5a791929b2b474b8045ba7aed1de9cd1636679f820a05dccc903e6e62a6312d4
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.10
10
+ - Package version: 1.0.12
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.10.gem
27
+ gem install ./ragie_ruby_sdk-1.0.12.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ragie_ruby_sdk-1.0.10.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ragie_ruby_sdk-1.0.12.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.10'
36
+ gem 'ragie_ruby_sdk', '~> 1.0.12'
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** | | |
8
+ | **evidence** | **Array<String>** | | |
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** | | |
10
+ | **code_issue** | **String** | | |
11
+ | **code_result** | **String** | | |
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** | | |
8
+ | **evidence** | [**Array<FinalAnswerEvidenceInner>**](FinalAnswerEvidenceInner.md) | | |
9
+ | **steps** | [**Array<FinalAnswerStepsInner>**](FinalAnswerStepsInner.md) | | |
10
+ | **usage** | [**AgentHoppsModelsModelsUsage**](AgentHoppsModelsModelsUsage.md) | | |
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** | | |
10
+ | **code_issue** | **String** | | |
11
+ | **code_result** | **String** | | |
12
+ | **id** | **String** | | |
13
+ | **index** | **Integer** | | |
14
+ | **document_id** | **String** | | |
15
+ | **document_name** | **String** | | |
16
+ | **metadata** | **Hash<String, Object>** | | [optional] |
17
+ | **document_metadata** | **Hash<String, Object>** | | [optional] |
18
+ | **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | | [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) | | |
13
+ | **questions_to_answer** | **Array<String>** | | |
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) | | |
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>** | | |
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** | | |
10
+ | **index** | **Integer** | | |
11
+ | **document_id** | **String** | | |
12
+ | **document_name** | **String** | | |
13
+ | **metadata** | **Hash<String, Object>** | | [optional] |
14
+ | **document_metadata** | **Hash<String, Object>** | | [optional] |
15
+ | **links** | [**Hash<String, SearchResultLink>**](SearchResultLink.md) | | [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
+