openlayer 0.0.2 → 0.1.1

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 (221) hide show
  1. checksums.yaml +4 -4
  2. data/.env +0 -0
  3. data/.rspec +3 -0
  4. data/.rubocop.yml +13 -0
  5. data/LICENSE +21 -0
  6. data/README.md +19 -294
  7. data/Rakefile +12 -0
  8. data/lib/openlayer/client.rb +21 -71
  9. data/lib/openlayer/error.rb +5 -0
  10. data/lib/openlayer/inference_pipeline.rb +36 -0
  11. data/lib/openlayer/version.rb +1 -1
  12. data/lib/openlayer.rb +7 -96
  13. data/openlayer.gemspec +42 -0
  14. data/sig/openlayer.rbs +4 -0
  15. metadata +44 -227
  16. data/.ignore +0 -2
  17. data/CHANGELOG.md +0 -15
  18. data/SECURITY.md +0 -27
  19. data/lib/openlayer/errors.rb +0 -228
  20. data/lib/openlayer/file_part.rb +0 -58
  21. data/lib/openlayer/internal/transport/base_client.rb +0 -567
  22. data/lib/openlayer/internal/transport/pooled_net_requester.rb +0 -198
  23. data/lib/openlayer/internal/type/array_of.rb +0 -168
  24. data/lib/openlayer/internal/type/base_model.rb +0 -531
  25. data/lib/openlayer/internal/type/base_page.rb +0 -55
  26. data/lib/openlayer/internal/type/boolean.rb +0 -77
  27. data/lib/openlayer/internal/type/converter.rb +0 -327
  28. data/lib/openlayer/internal/type/enum.rb +0 -131
  29. data/lib/openlayer/internal/type/file_input.rb +0 -111
  30. data/lib/openlayer/internal/type/hash_of.rb +0 -188
  31. data/lib/openlayer/internal/type/request_parameters.rb +0 -42
  32. data/lib/openlayer/internal/type/union.rb +0 -237
  33. data/lib/openlayer/internal/type/unknown.rb +0 -81
  34. data/lib/openlayer/internal/util.rb +0 -915
  35. data/lib/openlayer/internal.rb +0 -20
  36. data/lib/openlayer/models/commit_retrieve_params.rb +0 -14
  37. data/lib/openlayer/models/commit_retrieve_response.rb +0 -275
  38. data/lib/openlayer/models/commits/test_result_list_params.rb +0 -91
  39. data/lib/openlayer/models/commits/test_result_list_response.rb +0 -566
  40. data/lib/openlayer/models/inference_pipeline_delete_params.rb +0 -14
  41. data/lib/openlayer/models/inference_pipeline_retrieve_params.rb +0 -33
  42. data/lib/openlayer/models/inference_pipeline_retrieve_response.rb +0 -605
  43. data/lib/openlayer/models/inference_pipeline_update_params.rb +0 -42
  44. data/lib/openlayer/models/inference_pipeline_update_response.rb +0 -605
  45. data/lib/openlayer/models/inference_pipelines/data_stream_params.rb +0 -463
  46. data/lib/openlayer/models/inference_pipelines/data_stream_response.rb +0 -28
  47. data/lib/openlayer/models/inference_pipelines/row_update_params.rb +0 -90
  48. data/lib/openlayer/models/inference_pipelines/row_update_response.rb +0 -28
  49. data/lib/openlayer/models/inference_pipelines/test_result_list_params.rb +0 -83
  50. data/lib/openlayer/models/inference_pipelines/test_result_list_response.rb +0 -568
  51. data/lib/openlayer/models/project_create_params.rb +0 -51
  52. data/lib/openlayer/models/project_create_response.rb +0 -262
  53. data/lib/openlayer/models/project_list_params.rb +0 -59
  54. data/lib/openlayer/models/project_list_response.rb +0 -274
  55. data/lib/openlayer/models/projects/commit_create_params.rb +0 -61
  56. data/lib/openlayer/models/projects/commit_create_response.rb +0 -277
  57. data/lib/openlayer/models/projects/commit_list_params.rb +0 -32
  58. data/lib/openlayer/models/projects/commit_list_response.rb +0 -288
  59. data/lib/openlayer/models/projects/inference_pipeline_create_params.rb +0 -229
  60. data/lib/openlayer/models/projects/inference_pipeline_create_response.rb +0 -612
  61. data/lib/openlayer/models/projects/inference_pipeline_list_params.rb +0 -40
  62. data/lib/openlayer/models/projects/inference_pipeline_list_response.rb +0 -623
  63. data/lib/openlayer/models/projects/test_create_params.rb +0 -367
  64. data/lib/openlayer/models/projects/test_create_response.rb +0 -438
  65. data/lib/openlayer/models/projects/test_list_params.rb +0 -91
  66. data/lib/openlayer/models/projects/test_list_response.rb +0 -452
  67. data/lib/openlayer/models/projects/test_update_params.rb +0 -262
  68. data/lib/openlayer/models/projects/test_update_response.rb +0 -24
  69. data/lib/openlayer/models/storage/presigned_url_create_params.rb +0 -24
  70. data/lib/openlayer/models/storage/presigned_url_create_response.rb +0 -35
  71. data/lib/openlayer/models.rb +0 -61
  72. data/lib/openlayer/request_options.rb +0 -77
  73. data/lib/openlayer/resources/commits/test_results.rb +0 -51
  74. data/lib/openlayer/resources/commits.rb +0 -38
  75. data/lib/openlayer/resources/inference_pipelines/data.rb +0 -46
  76. data/lib/openlayer/resources/inference_pipelines/rows.rb +0 -46
  77. data/lib/openlayer/resources/inference_pipelines/test_results.rb +0 -49
  78. data/lib/openlayer/resources/inference_pipelines.rb +0 -101
  79. data/lib/openlayer/resources/projects/commits.rb +0 -72
  80. data/lib/openlayer/resources/projects/inference_pipelines.rb +0 -74
  81. data/lib/openlayer/resources/projects/tests.rb +0 -135
  82. data/lib/openlayer/resources/projects.rb +0 -80
  83. data/lib/openlayer/resources/storage/presigned_url.rb +0 -38
  84. data/lib/openlayer/resources/storage.rb +0 -18
  85. data/manifest.yaml +0 -15
  86. data/rbi/openlayer/client.rbi +0 -58
  87. data/rbi/openlayer/errors.rbi +0 -205
  88. data/rbi/openlayer/file_part.rbi +0 -37
  89. data/rbi/openlayer/internal/transport/base_client.rbi +0 -293
  90. data/rbi/openlayer/internal/transport/pooled_net_requester.rbi +0 -79
  91. data/rbi/openlayer/internal/type/array_of.rbi +0 -104
  92. data/rbi/openlayer/internal/type/base_model.rbi +0 -304
  93. data/rbi/openlayer/internal/type/base_page.rbi +0 -42
  94. data/rbi/openlayer/internal/type/boolean.rbi +0 -58
  95. data/rbi/openlayer/internal/type/converter.rbi +0 -216
  96. data/rbi/openlayer/internal/type/enum.rbi +0 -82
  97. data/rbi/openlayer/internal/type/file_input.rbi +0 -59
  98. data/rbi/openlayer/internal/type/hash_of.rbi +0 -104
  99. data/rbi/openlayer/internal/type/request_parameters.rbi +0 -29
  100. data/rbi/openlayer/internal/type/union.rbi +0 -128
  101. data/rbi/openlayer/internal/type/unknown.rbi +0 -58
  102. data/rbi/openlayer/internal/util.rbi +0 -487
  103. data/rbi/openlayer/internal.rbi +0 -18
  104. data/rbi/openlayer/models/commit_retrieve_params.rbi +0 -27
  105. data/rbi/openlayer/models/commit_retrieve_response.rbi +0 -393
  106. data/rbi/openlayer/models/commits/test_result_list_params.rbi +0 -214
  107. data/rbi/openlayer/models/commits/test_result_list_response.rbi +0 -1256
  108. data/rbi/openlayer/models/inference_pipeline_delete_params.rbi +0 -30
  109. data/rbi/openlayer/models/inference_pipeline_retrieve_params.rbi +0 -101
  110. data/rbi/openlayer/models/inference_pipeline_retrieve_response.rbi +0 -1022
  111. data/rbi/openlayer/models/inference_pipeline_update_params.rbi +0 -67
  112. data/rbi/openlayer/models/inference_pipeline_update_response.rbi +0 -1018
  113. data/rbi/openlayer/models/inference_pipelines/data_stream_params.rbi +0 -750
  114. data/rbi/openlayer/models/inference_pipelines/data_stream_response.rbi +0 -73
  115. data/rbi/openlayer/models/inference_pipelines/row_update_params.rbi +0 -153
  116. data/rbi/openlayer/models/inference_pipelines/row_update_response.rbi +0 -73
  117. data/rbi/openlayer/models/inference_pipelines/test_result_list_params.rbi +0 -216
  118. data/rbi/openlayer/models/inference_pipelines/test_result_list_response.rbi +0 -1258
  119. data/rbi/openlayer/models/project_create_params.rbi +0 -99
  120. data/rbi/openlayer/models/project_create_response.rbi +0 -401
  121. data/rbi/openlayer/models/project_list_params.rbi +0 -121
  122. data/rbi/openlayer/models/project_list_response.rbi +0 -442
  123. data/rbi/openlayer/models/projects/commit_create_params.rbi +0 -125
  124. data/rbi/openlayer/models/projects/commit_create_response.rbi +0 -409
  125. data/rbi/openlayer/models/projects/commit_list_params.rbi +0 -62
  126. data/rbi/openlayer/models/projects/commit_list_response.rbi +0 -454
  127. data/rbi/openlayer/models/projects/inference_pipeline_create_params.rbi +0 -560
  128. data/rbi/openlayer/models/projects/inference_pipeline_create_response.rbi +0 -1027
  129. data/rbi/openlayer/models/projects/inference_pipeline_list_params.rbi +0 -73
  130. data/rbi/openlayer/models/projects/inference_pipeline_list_response.rbi +0 -1070
  131. data/rbi/openlayer/models/projects/test_create_params.rbi +0 -940
  132. data/rbi/openlayer/models/projects/test_create_response.rbi +0 -1026
  133. data/rbi/openlayer/models/projects/test_list_params.rbi +0 -165
  134. data/rbi/openlayer/models/projects/test_list_response.rbi +0 -1067
  135. data/rbi/openlayer/models/projects/test_update_params.rbi +0 -699
  136. data/rbi/openlayer/models/projects/test_update_response.rbi +0 -43
  137. data/rbi/openlayer/models/storage/presigned_url_create_params.rbi +0 -45
  138. data/rbi/openlayer/models/storage/presigned_url_create_response.rbi +0 -55
  139. data/rbi/openlayer/models.rbi +0 -26
  140. data/rbi/openlayer/request_options.rbi +0 -59
  141. data/rbi/openlayer/resources/commits/test_results.rbi +0 -45
  142. data/rbi/openlayer/resources/commits.rbi +0 -29
  143. data/rbi/openlayer/resources/inference_pipelines/data.rbi +0 -41
  144. data/rbi/openlayer/resources/inference_pipelines/rows.rbi +0 -40
  145. data/rbi/openlayer/resources/inference_pipelines/test_results.rbi +0 -46
  146. data/rbi/openlayer/resources/inference_pipelines.rbi +0 -79
  147. data/rbi/openlayer/resources/projects/commits.rbi +0 -60
  148. data/rbi/openlayer/resources/projects/inference_pipelines.rbi +0 -69
  149. data/rbi/openlayer/resources/projects/tests.rbi +0 -123
  150. data/rbi/openlayer/resources/projects.rbi +0 -64
  151. data/rbi/openlayer/resources/storage/presigned_url.rbi +0 -28
  152. data/rbi/openlayer/resources/storage.rbi +0 -15
  153. data/rbi/openlayer/version.rbi +0 -5
  154. data/sig/openlayer/client.rbs +0 -32
  155. data/sig/openlayer/errors.rbs +0 -117
  156. data/sig/openlayer/file_part.rbs +0 -21
  157. data/sig/openlayer/internal/transport/base_client.rbs +0 -131
  158. data/sig/openlayer/internal/transport/pooled_net_requester.rbs +0 -45
  159. data/sig/openlayer/internal/type/array_of.rbs +0 -48
  160. data/sig/openlayer/internal/type/base_model.rbs +0 -102
  161. data/sig/openlayer/internal/type/base_page.rbs +0 -24
  162. data/sig/openlayer/internal/type/boolean.rbs +0 -26
  163. data/sig/openlayer/internal/type/converter.rbs +0 -79
  164. data/sig/openlayer/internal/type/enum.rbs +0 -32
  165. data/sig/openlayer/internal/type/file_input.rbs +0 -25
  166. data/sig/openlayer/internal/type/hash_of.rbs +0 -48
  167. data/sig/openlayer/internal/type/request_parameters.rbs +0 -19
  168. data/sig/openlayer/internal/type/union.rbs +0 -52
  169. data/sig/openlayer/internal/type/unknown.rbs +0 -26
  170. data/sig/openlayer/internal/util.rbs +0 -185
  171. data/sig/openlayer/internal.rbs +0 -9
  172. data/sig/openlayer/models/commit_retrieve_params.rbs +0 -15
  173. data/sig/openlayer/models/commit_retrieve_response.rbs +0 -209
  174. data/sig/openlayer/models/commits/test_result_list_params.rbs +0 -91
  175. data/sig/openlayer/models/commits/test_result_list_response.rbs +0 -529
  176. data/sig/openlayer/models/inference_pipeline_delete_params.rbs +0 -15
  177. data/sig/openlayer/models/inference_pipeline_retrieve_params.rbs +0 -41
  178. data/sig/openlayer/models/inference_pipeline_retrieve_response.rbs +0 -493
  179. data/sig/openlayer/models/inference_pipeline_update_params.rbs +0 -34
  180. data/sig/openlayer/models/inference_pipeline_update_response.rbs +0 -493
  181. data/sig/openlayer/models/inference_pipelines/data_stream_params.rbs +0 -386
  182. data/sig/openlayer/models/inference_pipelines/data_stream_response.rbs +0 -32
  183. data/sig/openlayer/models/inference_pipelines/row_update_params.rbs +0 -75
  184. data/sig/openlayer/models/inference_pipelines/row_update_response.rbs +0 -32
  185. data/sig/openlayer/models/inference_pipelines/test_result_list_params.rbs +0 -84
  186. data/sig/openlayer/models/inference_pipelines/test_result_list_response.rbs +0 -529
  187. data/sig/openlayer/models/project_create_params.rbs +0 -53
  188. data/sig/openlayer/models/project_create_response.rbs +0 -210
  189. data/sig/openlayer/models/project_list_params.rbs +0 -68
  190. data/sig/openlayer/models/project_list_response.rbs +0 -225
  191. data/sig/openlayer/models/projects/commit_create_params.rbs +0 -82
  192. data/sig/openlayer/models/projects/commit_create_response.rbs +0 -211
  193. data/sig/openlayer/models/projects/commit_list_params.rbs +0 -34
  194. data/sig/openlayer/models/projects/commit_list_response.rbs +0 -228
  195. data/sig/openlayer/models/projects/inference_pipeline_create_params.rbs +0 -308
  196. data/sig/openlayer/models/projects/inference_pipeline_create_response.rbs +0 -495
  197. data/sig/openlayer/models/projects/inference_pipeline_list_params.rbs +0 -40
  198. data/sig/openlayer/models/projects/inference_pipeline_list_response.rbs +0 -512
  199. data/sig/openlayer/models/projects/test_create_params.rbs +0 -388
  200. data/sig/openlayer/models/projects/test_create_response.rbs +0 -427
  201. data/sig/openlayer/models/projects/test_list_params.rbs +0 -85
  202. data/sig/openlayer/models/projects/test_list_response.rbs +0 -442
  203. data/sig/openlayer/models/projects/test_update_params.rbs +0 -275
  204. data/sig/openlayer/models/projects/test_update_response.rbs +0 -25
  205. data/sig/openlayer/models/storage/presigned_url_create_params.rbs +0 -25
  206. data/sig/openlayer/models/storage/presigned_url_create_response.rbs +0 -22
  207. data/sig/openlayer/models.rbs +0 -21
  208. data/sig/openlayer/request_options.rbs +0 -34
  209. data/sig/openlayer/resources/commits/test_results.rbs +0 -19
  210. data/sig/openlayer/resources/commits.rbs +0 -14
  211. data/sig/openlayer/resources/inference_pipelines/data.rbs +0 -16
  212. data/sig/openlayer/resources/inference_pipelines/rows.rbs +0 -17
  213. data/sig/openlayer/resources/inference_pipelines/test_results.rbs +0 -18
  214. data/sig/openlayer/resources/inference_pipelines.rbs +0 -32
  215. data/sig/openlayer/resources/projects/commits.rbs +0 -25
  216. data/sig/openlayer/resources/projects/inference_pipelines.rbs +0 -26
  217. data/sig/openlayer/resources/projects/tests.rbs +0 -45
  218. data/sig/openlayer/resources/projects.rbs +0 -28
  219. data/sig/openlayer/resources/storage/presigned_url.rbs +0 -14
  220. data/sig/openlayer/resources/storage.rbs +0 -9
  221. data/sig/openlayer/version.rbs +0 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 03e34d6b0d068d650d9e5e39b1315f1c914cb89ddfb286e7a1abca0f6030b2f8
4
- data.tar.gz: 2ad19647f1f7e8054a7cd188d2b85f2bf34c67e8662445417c4cdf4e7d46725a
3
+ metadata.gz: 255305d0ee35d06cd50f6243adece29a13abcd94e39cd72eeaafa0ad9ef64818
4
+ data.tar.gz: afc2292d13f5bfd99e136c805c300c43d46cbecad09dacfac5c60c5a8f7eadf7
5
5
  SHA512:
6
- metadata.gz: 4e2bf45256ea58afa6213ac4f4f7de4f046704ed334efc5b78e556d2b52900b26885e74c82526cdd0a8d2896d973ee858611169d81989f6799ebd96ebad77ed2
7
- data.tar.gz: 872bd6ca7e84e04aba005064cd38d504acd7e8e259d6027c0f7cd28522d4a7e80fb37123fffbcd07c0e1fabb4b7120d84748620d86f1519efb5841c3c2d2bfc6
6
+ metadata.gz: e819098a710660d080afd35ac2de37efcc5259cadb2b9ff446325b7ee5f924f44f68b514816252ca28825c7301caf99a897a4c37b0e2cd505fbd66a8c2f6a82b
7
+ data.tar.gz: 1f242e2ba0bb14f5a1123aed04b0a8f7f2723641ca9c41a67072b2603f71dd772c866563d3f507a2d1ddb7e2d8642f78f3412722ed8be711d4ce6953ef16eb09
data/.env ADDED
File without changes
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,13 @@
1
+ AllCops:
2
+ TargetRubyVersion: 2.6
3
+
4
+ Style/StringLiterals:
5
+ Enabled: true
6
+ EnforcedStyle: double_quotes
7
+
8
+ Style/StringLiteralsInInterpolation:
9
+ Enabled: true
10
+ EnforcedStyle: double_quotes
11
+
12
+ Layout/LineLength:
13
+ Max: 120
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 Telos Labs
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -1,314 +1,39 @@
1
- # Openlayer Ruby API library
1
+ # Openlayer
2
+ Openlayer is a Ruby gem that provides a wrapper for the Openlayer HTTP API. It allows you to connect to Openlayer and interact with its features. Please note that this gem is currently in the early stages of development.
2
3
 
3
- The Openlayer Ruby library provides convenient access to the Openlayer REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/openlayer-ai/openlayer-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
4
-
5
- It is generated with [Stainless](https://www.stainless.com/).
6
-
7
- ## Documentation
8
-
9
- Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/openlayer).
10
-
11
- The REST API documentation can be found on [openlayer.com](https://openlayer.com/docs/api-reference/rest/overview).
12
4
 
13
5
  ## Installation
6
+ Install the gem and add to the application's Gemfile by executing:
14
7
 
15
- To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
16
-
17
- <!-- x-release-please-start-version -->
8
+ $ bundle add openlayer
18
9
 
19
- ```ruby
20
- gem "openlayer", "~> 0.0.2"
21
- ```
10
+ If bundler is not being used to manage dependencies, install the gem by executing:
22
11
 
23
- <!-- x-release-please-end -->
12
+ $ gem install openlayer
24
13
 
25
14
  ## Usage
26
15
 
27
16
  ```ruby
28
- require "bundler/setup"
29
- require "openlayer"
30
-
31
- openlayer = Openlayer::Client.new(
32
- api_key: ENV["OPENLAYER_API_KEY"] # This is the default and can be omitted
33
- )
34
-
35
- response = openlayer.inference_pipelines.data.stream(
36
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
37
- config: {
38
- inputVariableNames: ["user_query"],
39
- outputColumnName: "output",
40
- numOfTokenColumnName: "tokens",
41
- costColumnName: "cost",
42
- timestampColumnName: "timestamp"
43
- },
44
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}]
45
- )
46
-
47
- puts(response.success)
48
- ```
49
-
50
- ### Handling errors
51
-
52
- When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Openlayer::Errors::APIError` will be thrown:
53
-
54
- ```ruby
55
- begin
56
- data = openlayer.inference_pipelines.data.stream(
57
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
58
- config: {
59
- inputVariableNames: ["user_query"],
60
- outputColumnName: "output",
61
- numOfTokenColumnName: "tokens",
62
- costColumnName: "cost",
63
- timestampColumnName: "timestamp"
64
- },
65
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}]
66
- )
67
- rescue Openlayer::Errors::APIConnectionError => e
68
- puts("The server could not be reached")
69
- puts(e.cause) # an underlying Exception, likely raised within `net/http`
70
- rescue Openlayer::Errors::RateLimitError => e
71
- puts("A 429 status code was received; we should back off a bit.")
72
- rescue Openlayer::Errors::APIStatusError => e
73
- puts("Another non-200-range status code was received")
74
- puts(e.status)
75
- end
76
- ```
77
-
78
- Error codes are as follows:
79
-
80
- | Cause | Error Type |
81
- | ---------------- | -------------------------- |
82
- | HTTP 400 | `BadRequestError` |
83
- | HTTP 401 | `AuthenticationError` |
84
- | HTTP 403 | `PermissionDeniedError` |
85
- | HTTP 404 | `NotFoundError` |
86
- | HTTP 409 | `ConflictError` |
87
- | HTTP 422 | `UnprocessableEntityError` |
88
- | HTTP 429 | `RateLimitError` |
89
- | HTTP >= 500 | `InternalServerError` |
90
- | Other HTTP error | `APIStatusError` |
91
- | Timeout | `APITimeoutError` |
92
- | Network error | `APIConnectionError` |
93
-
94
- ### Retries
95
-
96
- Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
97
-
98
- Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
99
-
100
- You can use the `max_retries` option to configure or disable this:
101
-
102
- ```ruby
103
- # Configure the default for all requests:
104
- openlayer = Openlayer::Client.new(
105
- max_retries: 0 # default is 2
106
- )
107
-
108
- # Or, configure per-request:
109
- openlayer.inference_pipelines.data.stream(
110
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
111
- config: {
112
- inputVariableNames: ["user_query"],
113
- outputColumnName: "output",
114
- numOfTokenColumnName: "tokens",
115
- costColumnName: "cost",
116
- timestampColumnName: "timestamp"
117
- },
118
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}],
119
- request_options: {max_retries: 5}
120
- )
121
- ```
122
-
123
- ### Timeouts
124
-
125
- By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
126
-
127
- ```ruby
128
- # Configure the default for all requests:
129
- openlayer = Openlayer::Client.new(
130
- timeout: nil # default is 60
131
- )
132
-
133
- # Or, configure per-request:
134
- openlayer.inference_pipelines.data.stream(
135
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
136
- config: {
137
- inputVariableNames: ["user_query"],
138
- outputColumnName: "output",
139
- numOfTokenColumnName: "tokens",
140
- costColumnName: "cost",
141
- timestampColumnName: "timestamp"
142
- },
143
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}],
144
- request_options: {timeout: 5}
145
- )
146
- ```
147
-
148
- On timeout, `Openlayer::Errors::APITimeoutError` is raised.
149
-
150
- Note that requests that time out are retried by default.
151
-
152
- ## Advanced concepts
153
-
154
- ### BaseModel
155
-
156
- All parameter and response objects inherit from `Openlayer::Internal::Type::BaseModel`, which provides several conveniences, including:
157
-
158
- 1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
159
-
160
- 2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
161
-
162
- 3. Both instances and the classes themselves can be pretty-printed.
163
-
164
- 4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
165
-
166
- ### Making custom or undocumented requests
167
-
168
- #### Undocumented properties
169
-
170
- You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
171
-
172
- Note: the `extra_` parameters of the same name overrides the documented parameters.
173
-
174
- ```ruby
175
- response =
176
- openlayer.inference_pipelines.data.stream(
177
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
178
- config: {
179
- inputVariableNames: ["user_query"],
180
- outputColumnName: "output",
181
- numOfTokenColumnName: "tokens",
182
- costColumnName: "cost",
183
- timestampColumnName: "timestamp"
184
- },
185
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}],
186
- request_options: {
187
- extra_query: {my_query_parameter: value},
188
- extra_body: {my_body_parameter: value},
189
- extra_headers: {"my-header": value}
17
+ client = OpenLayer::Client.new(api_key: "YOUR_OPENLAYER_API_KEY")
18
+ inference_pipeline = client.inference_pipeline("YOUR_INFERENCE_PIPELINE_ID")
19
+ inferencce_pipeline.stream_data(
20
+ {
21
+ rows: [...],
22
+ config: {...}
190
23
  }
191
- )
192
-
193
- puts(response[:my_undocumented_property])
194
- ```
195
-
196
- #### Undocumented request params
197
-
198
- If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
199
-
200
- #### Undocumented endpoints
201
-
202
- To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
203
-
204
- ```ruby
205
- response = client.request(
206
- method: :post,
207
- path: '/undocumented/endpoint',
208
- query: {"dog": "woof"},
209
- headers: {"useful-header": "interesting-value"},
210
- body: {"hello": "world"}
211
24
  )
212
25
  ```
213
26
 
214
- ### Concurrency & connection pooling
215
-
216
- The `Openlayer::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
217
-
218
- Each instance of `Openlayer::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
219
-
220
- When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
221
-
222
- Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
223
-
224
- ## Sorbet
27
+ ## Development
225
28
 
226
- This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
29
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
227
30
 
228
- You can provide typesafe request parameters like so:
31
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
229
32
 
230
- ```ruby
231
- openlayer.inference_pipelines.data.stream(
232
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
233
- config: Openlayer::InferencePipelines::DataStreamParams::Config::LlmData.new(
234
- input_variable_names: ["user_query"],
235
- output_column_name: "output",
236
- num_of_token_column_name: "tokens",
237
- cost_column_name: "cost",
238
- timestamp_column_name: "timestamp"
239
- ),
240
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}]
241
- )
242
- ```
243
-
244
- Or, equivalently:
245
-
246
- ```ruby
247
- # Hashes work, but are not typesafe:
248
- openlayer.inference_pipelines.data.stream(
249
- "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
250
- config: {
251
- inputVariableNames: ["user_query"],
252
- outputColumnName: "output",
253
- numOfTokenColumnName: "tokens",
254
- costColumnName: "cost",
255
- timestampColumnName: "timestamp"
256
- },
257
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}]
258
- )
259
-
260
- # You can also splat a full Params class:
261
- params = Openlayer::InferencePipelines::DataStreamParams.new(
262
- config: Openlayer::InferencePipelines::DataStreamParams::Config::LlmData.new(
263
- input_variable_names: ["user_query"],
264
- output_column_name: "output",
265
- num_of_token_column_name: "tokens",
266
- cost_column_name: "cost",
267
- timestamp_column_name: "timestamp"
268
- ),
269
- rows: [{user_query: "what is the meaning of life?", output: "42", tokens: 7, cost: 0.02, timestamp: 1610000000}]
270
- )
271
- openlayer.inference_pipelines.data.stream("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", **params)
272
- ```
273
-
274
- ### Enums
275
-
276
- Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
277
-
278
- ```ruby
279
- # :"llm-base"
280
- puts(Openlayer::ProjectCreateParams::TaskType::LLM_BASE)
281
-
282
- # Revealed type: `T.all(Openlayer::ProjectCreateParams::TaskType, Symbol)`
283
- T.reveal_type(Openlayer::ProjectCreateParams::TaskType::LLM_BASE)
284
- ```
285
-
286
- Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
287
-
288
- ```ruby
289
- # Using the enum constants preserves the tagged type information:
290
- openlayer.projects.create(
291
- task_type: Openlayer::ProjectCreateParams::TaskType::LLM_BASE,
292
- # …
293
- )
294
-
295
- # Literal values are also permissible:
296
- openlayer.projects.create(
297
- task_type: :"llm-base",
298
- # …
299
- )
300
- ```
301
-
302
- ## Versioning
303
-
304
- This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
305
-
306
- This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
307
-
308
- ## Requirements
33
+ ## Contributing
309
34
 
310
- Ruby 3.2.0 or higher.
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/TelosLabs/openlayer.
311
36
 
312
- ## Contributing
37
+ ## License
313
38
 
314
- See [the contributing documentation](https://github.com/openlayer-ai/openlayer-ruby/tree/main/CONTRIBUTING.md).
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -1,82 +1,32 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- module Openlayer
4
- class Client < Openlayer::Internal::Transport::BaseClient
5
- # Default max number of retries to attempt after a failed retryable request.
6
- DEFAULT_MAX_RETRIES = 2
7
-
8
- # Default per-request timeout.
9
- DEFAULT_TIMEOUT_IN_SECONDS = 60.0
10
-
11
- # Default initial retry delay in seconds.
12
- # Overall delay is calculated using exponential backoff + jitter.
13
- DEFAULT_INITIAL_RETRY_DELAY = 0.5
14
-
15
- # Default max retry delay in seconds.
16
- DEFAULT_MAX_RETRY_DELAY = 8.0
17
-
18
- # @return [String, nil]
19
- attr_reader :api_key
20
-
21
- # @return [Openlayer::Resources::Projects]
22
- attr_reader :projects
3
+ require "faraday"
4
+ require "faraday_middleware"
23
5
 
24
- # @return [Openlayer::Resources::Commits]
25
- attr_reader :commits
26
-
27
- # @return [Openlayer::Resources::InferencePipelines]
28
- attr_reader :inference_pipelines
29
-
30
- # @return [Openlayer::Resources::Storage]
31
- attr_reader :storage
6
+ module Openlayer
7
+ class Client
8
+ BASE_URL = "https://api.openlayer.com/v1/"
32
9
 
33
- # @api private
34
- #
35
- # @return [Hash{String=>String}]
36
- private def auth_headers
37
- return {} if @api_key.nil?
10
+ attr_reader :api_key, :adapter
38
11
 
39
- {"authorization" => "Bearer #{@api_key}"}
12
+ def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
13
+ @api_key = api_key
14
+ @adapter = adapter
15
+ @stubs = stubs
40
16
  end
41
17
 
42
- # Creates and returns a new client for interacting with the API.
43
- #
44
- # @param api_key [String, nil] Defaults to `ENV["OPENLAYER_API_KEY"]`
45
- #
46
- # @param base_url [String, nil] Override the default base URL for the API, e.g.,
47
- # `"https://api.example.com/v2/"`. Defaults to `ENV["OPENLAYER_BASE_URL"]`
48
- #
49
- # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
50
- #
51
- # @param timeout [Float]
52
- #
53
- # @param initial_retry_delay [Float]
54
- #
55
- # @param max_retry_delay [Float]
56
- def initialize(
57
- api_key: ENV["OPENLAYER_API_KEY"],
58
- base_url: ENV["OPENLAYER_BASE_URL"],
59
- max_retries: self.class::DEFAULT_MAX_RETRIES,
60
- timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
61
- initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
62
- max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
63
- )
64
- base_url ||= "https://api.openlayer.com/v1"
65
-
66
- @api_key = api_key&.to_s
67
-
68
- super(
69
- base_url: base_url,
70
- timeout: timeout,
71
- max_retries: max_retries,
72
- initial_retry_delay: initial_retry_delay,
73
- max_retry_delay: max_retry_delay
74
- )
18
+ def connection
19
+ @connection ||= Faraday.new do |conn|
20
+ conn.url_prefix = BASE_URL
21
+ conn.request :authorization, "Bearer", api_key
22
+ conn.request :json
23
+ conn.response :json, content_type: "application/json"
24
+ conn.adapter adapter, @stubs
25
+ end
26
+ end
75
27
 
76
- @projects = Openlayer::Resources::Projects.new(client: self)
77
- @commits = Openlayer::Resources::Commits.new(client: self)
78
- @inference_pipelines = Openlayer::Resources::InferencePipelines.new(client: self)
79
- @storage = Openlayer::Resources::Storage.new(client: self)
28
+ def inference_pipeline(inference_pipeline_id)
29
+ InferencePipeline.new(self, inference_pipeline_id)
80
30
  end
81
31
  end
82
32
  end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ class Error < StandardError; end
5
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Openlayer
4
+ class InferencePipeline
5
+ attr_reader :client, :inference_pipeline_id
6
+
7
+ def initialize(client, inference_pipeline_id)
8
+ @client = client
9
+ @inference_pipeline_id = inference_pipeline_id
10
+ end
11
+
12
+ def stream_data(**attributes)
13
+ handle_response client.connection.post("inference-pipelines/#{inference_pipeline_id}/data-stream", attributes)
14
+ true
15
+ end
16
+
17
+ def handle_response(response)
18
+ message = response.body["error"]
19
+ case response.status
20
+ when 200
21
+ response.body
22
+ when 401
23
+ raise Error, message
24
+ when 404
25
+ raise Error, message
26
+ when 422
27
+ raise Error, message
28
+ when 500
29
+ raise Error, message
30
+ else
31
+ raise Error, message
32
+ end
33
+ response
34
+ end
35
+ end
36
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Openlayer
4
- VERSION = "0.0.2"
4
+ VERSION = "0.1.1"
5
5
  end
data/lib/openlayer.rb CHANGED
@@ -1,100 +1,11 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- # Standard libraries.
4
- # rubocop:disable Lint/RedundantRequireStatement
5
- require "English"
6
- require "cgi"
7
- require "date"
8
- require "erb"
9
- require "etc"
10
- require "json"
11
- require "net/http"
12
- require "pathname"
13
- require "rbconfig"
14
- require "securerandom"
15
- require "set"
16
- require "stringio"
17
- require "time"
18
- require "uri"
19
- # rubocop:enable Lint/RedundantRequireStatement
20
-
21
- # We already ship the preferred sorbet manifests in the package itself.
22
- # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
23
- if Object.const_defined?(:Tapioca) &&
24
- caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
25
- ARGV.none?(/dsl/)
26
- return
27
- end
3
+ require_relative "openlayer/version"
28
4
 
29
- # Gems.
30
- require "connection_pool"
5
+ module Openlayer
6
+ autoload :Client, "openlayer/client"
7
+ autoload :Error, "openlayer/error"
8
+ autoload :InferencePipeline, "openlayer/inference_pipeline"
31
9
 
32
- # Package files.
33
- require_relative "openlayer/version"
34
- require_relative "openlayer/internal/util"
35
- require_relative "openlayer/internal/type/converter"
36
- require_relative "openlayer/internal/type/unknown"
37
- require_relative "openlayer/internal/type/boolean"
38
- require_relative "openlayer/internal/type/file_input"
39
- require_relative "openlayer/internal/type/enum"
40
- require_relative "openlayer/internal/type/union"
41
- require_relative "openlayer/internal/type/array_of"
42
- require_relative "openlayer/internal/type/hash_of"
43
- require_relative "openlayer/internal/type/base_model"
44
- require_relative "openlayer/internal/type/base_page"
45
- require_relative "openlayer/internal/type/request_parameters"
46
- require_relative "openlayer/internal"
47
- require_relative "openlayer/request_options"
48
- require_relative "openlayer/file_part"
49
- require_relative "openlayer/errors"
50
- require_relative "openlayer/internal/transport/base_client"
51
- require_relative "openlayer/internal/transport/pooled_net_requester"
52
- require_relative "openlayer/client"
53
- require_relative "openlayer/models/commit_retrieve_params"
54
- require_relative "openlayer/models/commit_retrieve_response"
55
- require_relative "openlayer/models/commits/test_result_list_params"
56
- require_relative "openlayer/models/commits/test_result_list_response"
57
- require_relative "openlayer/models/inference_pipeline_delete_params"
58
- require_relative "openlayer/models/inference_pipeline_retrieve_params"
59
- require_relative "openlayer/models/inference_pipeline_retrieve_response"
60
- require_relative "openlayer/models/inference_pipelines/data_stream_params"
61
- require_relative "openlayer/models/inference_pipelines/data_stream_response"
62
- require_relative "openlayer/models/inference_pipelines/row_update_params"
63
- require_relative "openlayer/models/inference_pipelines/row_update_response"
64
- require_relative "openlayer/models/inference_pipelines/test_result_list_params"
65
- require_relative "openlayer/models/inference_pipelines/test_result_list_response"
66
- require_relative "openlayer/models/inference_pipeline_update_params"
67
- require_relative "openlayer/models/inference_pipeline_update_response"
68
- require_relative "openlayer/models/project_create_params"
69
- require_relative "openlayer/models/project_create_response"
70
- require_relative "openlayer/models/project_list_params"
71
- require_relative "openlayer/models/project_list_response"
72
- require_relative "openlayer/models/projects/commit_create_params"
73
- require_relative "openlayer/models/projects/commit_create_response"
74
- require_relative "openlayer/models/projects/commit_list_params"
75
- require_relative "openlayer/models/projects/commit_list_response"
76
- require_relative "openlayer/models/projects/inference_pipeline_create_params"
77
- require_relative "openlayer/models/projects/inference_pipeline_create_response"
78
- require_relative "openlayer/models/projects/inference_pipeline_list_params"
79
- require_relative "openlayer/models/projects/inference_pipeline_list_response"
80
- require_relative "openlayer/models/projects/test_create_params"
81
- require_relative "openlayer/models/projects/test_create_response"
82
- require_relative "openlayer/models/projects/test_list_params"
83
- require_relative "openlayer/models/projects/test_list_response"
84
- require_relative "openlayer/models/projects/test_update_params"
85
- require_relative "openlayer/models/projects/test_update_response"
86
- require_relative "openlayer/models/storage/presigned_url_create_params"
87
- require_relative "openlayer/models/storage/presigned_url_create_response"
88
- require_relative "openlayer/models"
89
- require_relative "openlayer/resources/commits"
90
- require_relative "openlayer/resources/commits/test_results"
91
- require_relative "openlayer/resources/inference_pipelines"
92
- require_relative "openlayer/resources/inference_pipelines/data"
93
- require_relative "openlayer/resources/inference_pipelines/rows"
94
- require_relative "openlayer/resources/inference_pipelines/test_results"
95
- require_relative "openlayer/resources/projects"
96
- require_relative "openlayer/resources/projects/commits"
97
- require_relative "openlayer/resources/projects/inference_pipelines"
98
- require_relative "openlayer/resources/projects/tests"
99
- require_relative "openlayer/resources/storage"
100
- require_relative "openlayer/resources/storage/presigned_url"
10
+ # Your code goes here...
11
+ end