fetch_hive 0.2.5 → 0.2.8

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 (106) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +12 -5
  3. data/lib/fetch_hive/client.rb +139 -13
  4. data/lib/fetch_hive/generated/api/agent_chat_messages_api.rb +97 -0
  5. data/lib/fetch_hive/generated/api/agent_chats_api.rb +413 -0
  6. data/lib/fetch_hive/generated/api/agents_api.rb +359 -4
  7. data/lib/fetch_hive/generated/api/assets_api.rb +153 -0
  8. data/lib/fetch_hive/generated/api/hive_agents_api.rb +90 -0
  9. data/lib/fetch_hive/generated/api/knowledge_base_items_api.rb +482 -0
  10. data/lib/fetch_hive/generated/api/knowledge_bases_api.rb +457 -0
  11. data/lib/fetch_hive/generated/api/models_api.rb +79 -0
  12. data/lib/fetch_hive/generated/api/prompts_api.rb +3 -3
  13. data/lib/fetch_hive/generated/api/requests_api.rb +85 -0
  14. data/lib/fetch_hive/generated/api/search_services_api.rb +147 -0
  15. data/lib/fetch_hive/generated/api/workflows_api.rb +2 -2
  16. data/lib/fetch_hive/generated/api_client.rb +2 -2
  17. data/lib/fetch_hive/generated/api_error.rb +2 -2
  18. data/lib/fetch_hive/generated/api_model_base.rb +2 -2
  19. data/lib/fetch_hive/generated/configuration.rb +2 -2
  20. data/lib/fetch_hive/generated/models/agent_attachment.rb +104 -0
  21. data/lib/fetch_hive/generated/models/agent_attachment_one_of.rb +191 -0
  22. data/lib/fetch_hive/generated/models/agent_message.rb +11 -11
  23. data/lib/fetch_hive/generated/models/asset_object.rb +350 -0
  24. data/lib/fetch_hive/generated/models/asset_object_transcription.rb +212 -0
  25. data/lib/fetch_hive/generated/models/async_config.rb +2 -2
  26. data/lib/fetch_hive/generated/models/delete_public_workspaces_agents200_response.rb +164 -0
  27. data/lib/fetch_hive/generated/models/delete_public_workspaces_agents_chats200_response.rb +164 -0
  28. data/lib/fetch_hive/generated/models/delete_public_workspaces_agents_chats404_response.rb +164 -0
  29. data/lib/fetch_hive/generated/models/delete_public_workspaces_knowledge_bases200_response.rb +164 -0
  30. data/lib/fetch_hive/generated/models/delete_public_workspaces_knowledge_bases_items200_response.rb +164 -0
  31. data/lib/fetch_hive/generated/models/error_response.rb +23 -17
  32. data/lib/fetch_hive/generated/models/generated_artifact.rb +236 -0
  33. data/lib/fetch_hive/generated/models/get_public_models200_response_inner.rb +474 -0
  34. data/lib/fetch_hive/generated/models/get_public_requests200_response.rb +319 -0
  35. data/lib/fetch_hive/generated/models/get_public_requests404_response.rb +164 -0
  36. data/lib/fetch_hive/generated/models/get_public_search_services_countries200_response.rb +166 -0
  37. data/lib/fetch_hive/generated/models/get_public_search_services_countries200_response_services_inner.rb +294 -0
  38. data/lib/fetch_hive/generated/models/get_public_search_services_countries200_response_services_inner_countries_inner.rb +216 -0
  39. data/lib/fetch_hive/generated/models/get_public_search_services_countries2404_response.rb +175 -0
  40. data/lib/fetch_hive/generated/models/get_public_workspaces_agents200_response.rb +164 -0
  41. data/lib/fetch_hive/generated/models/get_public_workspaces_agents2200_response.rb +166 -0
  42. data/lib/fetch_hive/generated/models/get_public_workspaces_agents_chats200_response.rb +164 -0
  43. data/lib/fetch_hive/generated/models/get_public_workspaces_agents_chats_messages200_response.rb +166 -0
  44. data/lib/fetch_hive/generated/models/get_public_workspaces_agents_chats_messages200_response_messages_inner.rb +276 -0
  45. data/lib/fetch_hive/generated/models/get_public_workspaces_agents_chats_messages422_response.rb +164 -0
  46. data/lib/fetch_hive/generated/models/get_public_workspaces_assets200_response.rb +166 -0
  47. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases200_response.rb +166 -0
  48. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases2200_response.rb +164 -0
  49. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases2422_response.rb +164 -0
  50. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases_items200_response.rb +166 -0
  51. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases_items200_response_knowledge_base_items_inner.rb +294 -0
  52. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases_items2200_response.rb +164 -0
  53. data/lib/fetch_hive/generated/models/get_public_workspaces_knowledge_bases_items2422_response.rb +164 -0
  54. data/lib/fetch_hive/generated/models/hive_agent_async_config.rb +192 -0
  55. data/lib/fetch_hive/generated/models/hive_agent_sources.rb +187 -0
  56. data/lib/fetch_hive/generated/models/invoke_agent_request.rb +92 -11
  57. data/lib/fetch_hive/generated/models/invoke_agent_response.rb +18 -6
  58. data/lib/fetch_hive/generated/models/invoke_hive_agent_request.rb +239 -0
  59. data/lib/fetch_hive/generated/models/invoke_hive_agent_response.rb +213 -0
  60. data/lib/fetch_hive/generated/models/invoke_prompt_request.rb +2 -2
  61. data/lib/fetch_hive/generated/models/invoke_prompt_response.rb +2 -2
  62. data/lib/fetch_hive/generated/models/invoke_workflow_async_response.rb +2 -2
  63. data/lib/fetch_hive/generated/models/invoke_workflow_request.rb +2 -2
  64. data/lib/fetch_hive/generated/models/invoke_workflow_response.rb +2 -2
  65. data/lib/fetch_hive/generated/models/knowledge_base_object.rb +470 -0
  66. data/lib/fetch_hive/generated/models/metadata_value.rb +2 -2
  67. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents200_response.rb +190 -0
  68. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_chats200_response.rb +190 -0
  69. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_chats_clear_messages200_response.rb +190 -0
  70. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_chats_request.rb +164 -0
  71. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_chats_request_chat.rb +147 -0
  72. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_request.rb +164 -0
  73. data/lib/fetch_hive/generated/models/patch_public_workspaces_agents_request_agent.rb +304 -0
  74. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases200_response.rb +190 -0
  75. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases_items200_response.rb +190 -0
  76. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases_items_request.rb +164 -0
  77. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases_items_request_knowledge_base_item.rb +265 -0
  78. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases_request.rb +147 -0
  79. data/lib/fetch_hive/generated/models/patch_public_workspaces_knowledge_bases_request_knowledge_base.rb +217 -0
  80. data/lib/fetch_hive/generated/models/post_public_workspaces_agents200_response.rb +190 -0
  81. data/lib/fetch_hive/generated/models/post_public_workspaces_agents422_response.rb +164 -0
  82. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_chats200_response.rb +190 -0
  83. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_chats200_response_chat.rb +305 -0
  84. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_chats422_response.rb +175 -0
  85. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_chats_request.rb +164 -0
  86. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_chats_request_chat.rb +164 -0
  87. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_request.rb +164 -0
  88. data/lib/fetch_hive/generated/models/post_public_workspaces_agents_request_agent.rb +252 -0
  89. data/lib/fetch_hive/generated/models/post_public_workspaces_assets200_response.rb +190 -0
  90. data/lib/fetch_hive/generated/models/post_public_workspaces_assets422_response.rb +216 -0
  91. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases200_response.rb +190 -0
  92. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_items200_response.rb +190 -0
  93. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_items422_response.rb +158 -0
  94. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_items_regenerate200_response.rb +190 -0
  95. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_items_request.rb +164 -0
  96. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_items_request_knowledge_base_item.rb +322 -0
  97. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_request.rb +164 -0
  98. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_request_knowledge_base.rb +234 -0
  99. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_search200_response.rb +190 -0
  100. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_search422_response.rb +164 -0
  101. data/lib/fetch_hive/generated/models/post_public_workspaces_knowledge_bases_search_request.rb +302 -0
  102. data/lib/fetch_hive/generated/models/sse_chunk.rb +13 -4
  103. data/lib/fetch_hive/generated/models/token_usage.rb +2 -2
  104. data/lib/fetch_hive/generated/models/tool_invocation.rb +2 -2
  105. data/lib/fetch_hive/generated/version.rb +2 -2
  106. metadata +83 -3
@@ -0,0 +1,482 @@
1
+ =begin
2
+ #Fetch Hive Public API
3
+
4
+ #The Fetch Hive public API lets you invoke prompts, workflows, agents, and Hive Agents programmatically using an API token. ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ``` ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`.
5
+
6
+ The version of the OpenAPI document: 0.2.8
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module FetchHive::Generated
16
+ class KnowledgeBaseItemsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Delete a knowledge base item
23
+ # Destroys a knowledge base item in the requested public API workspace.
24
+ # @param workspace_id [String] Workspace UUID
25
+ # @param knowledge_base_id [String] Knowledge base UUID
26
+ # @param id [String] Knowledge base item UUID
27
+ # @param [Hash] opts the optional parameters
28
+ # @return [DeletePublicWorkspacesKnowledgeBasesItems200Response]
29
+ def delete_public_workspaces_knowledge_bases_items(workspace_id, knowledge_base_id, id, opts = {})
30
+ data, _status_code, _headers = delete_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, id, opts)
31
+ data
32
+ end
33
+
34
+ # Delete a knowledge base item
35
+ # Destroys a knowledge base item in the requested public API workspace.
36
+ # @param workspace_id [String] Workspace UUID
37
+ # @param knowledge_base_id [String] Knowledge base UUID
38
+ # @param id [String] Knowledge base item UUID
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [Array<(DeletePublicWorkspacesKnowledgeBasesItems200Response, Integer, Hash)>] DeletePublicWorkspacesKnowledgeBasesItems200Response data, response status code and response headers
41
+ def delete_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, id, opts = {})
42
+ if @api_client.config.debugging
43
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.delete_public_workspaces_knowledge_bases_items ...'
44
+ end
45
+ # verify the required parameter 'workspace_id' is set
46
+ if @api_client.config.client_side_validation && workspace_id.nil?
47
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.delete_public_workspaces_knowledge_bases_items"
48
+ end
49
+ # verify the required parameter 'knowledge_base_id' is set
50
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
51
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.delete_public_workspaces_knowledge_bases_items"
52
+ end
53
+ # verify the required parameter 'id' is set
54
+ if @api_client.config.client_side_validation && id.nil?
55
+ fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseItemsApi.delete_public_workspaces_knowledge_bases_items"
56
+ end
57
+ # resource path
58
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items/{id}'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s)).sub('{id}', CGI.escape(id.to_s))
59
+
60
+ # query parameters
61
+ query_params = opts[:query_params] || {}
62
+
63
+ # header parameters
64
+ header_params = opts[:header_params] || {}
65
+ # HTTP header 'Accept' (if needed)
66
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'DeletePublicWorkspacesKnowledgeBasesItems200Response'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"KnowledgeBaseItemsApi.delete_public_workspaces_knowledge_bases_items",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#delete_public_workspaces_knowledge_bases_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # List public workspace knowledge base items
98
+ # Returns items for a knowledge base in the requested public API workspace.
99
+ # @param workspace_id [String] Workspace UUID
100
+ # @param knowledge_base_id [String] Knowledge base UUID
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [GetPublicWorkspacesKnowledgeBasesItems200Response]
103
+ def get_public_workspaces_knowledge_bases_items(workspace_id, knowledge_base_id, opts = {})
104
+ data, _status_code, _headers = get_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, opts)
105
+ data
106
+ end
107
+
108
+ # List public workspace knowledge base items
109
+ # Returns items for a knowledge base in the requested public API workspace.
110
+ # @param workspace_id [String] Workspace UUID
111
+ # @param knowledge_base_id [String] Knowledge base UUID
112
+ # @param [Hash] opts the optional parameters
113
+ # @return [Array<(GetPublicWorkspacesKnowledgeBasesItems200Response, Integer, Hash)>] GetPublicWorkspacesKnowledgeBasesItems200Response data, response status code and response headers
114
+ def get_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, opts = {})
115
+ if @api_client.config.debugging
116
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items ...'
117
+ end
118
+ # verify the required parameter 'workspace_id' is set
119
+ if @api_client.config.client_side_validation && workspace_id.nil?
120
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items"
121
+ end
122
+ # verify the required parameter 'knowledge_base_id' is set
123
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
124
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items"
125
+ end
126
+ # resource path
127
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s))
128
+
129
+ # query parameters
130
+ query_params = opts[:query_params] || {}
131
+
132
+ # header parameters
133
+ header_params = opts[:header_params] || {}
134
+ # HTTP header 'Accept' (if needed)
135
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
136
+
137
+ # form parameters
138
+ form_params = opts[:form_params] || {}
139
+
140
+ # http body (model)
141
+ post_body = opts[:debug_body]
142
+
143
+ # return_type
144
+ return_type = opts[:debug_return_type] || 'GetPublicWorkspacesKnowledgeBasesItems200Response'
145
+
146
+ # auth_names
147
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
148
+
149
+ new_options = opts.merge(
150
+ :operation => :"KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items",
151
+ :header_params => header_params,
152
+ :query_params => query_params,
153
+ :form_params => form_params,
154
+ :body => post_body,
155
+ :auth_names => auth_names,
156
+ :return_type => return_type
157
+ )
158
+
159
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#get_public_workspaces_knowledge_bases_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
162
+ end
163
+ return data, status_code, headers
164
+ end
165
+
166
+ # Get a knowledge base item
167
+ # Returns a single knowledge base item in the requested public API workspace.
168
+ # @param workspace_id [String] Workspace UUID
169
+ # @param knowledge_base_id [String] Knowledge base UUID
170
+ # @param id [String] Knowledge base item UUID
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [GetPublicWorkspacesKnowledgeBasesItems2200Response]
173
+ def get_public_workspaces_knowledge_bases_items2(workspace_id, knowledge_base_id, id, opts = {})
174
+ data, _status_code, _headers = get_public_workspaces_knowledge_bases_items2_with_http_info(workspace_id, knowledge_base_id, id, opts)
175
+ data
176
+ end
177
+
178
+ # Get a knowledge base item
179
+ # Returns a single knowledge base item in the requested public API workspace.
180
+ # @param workspace_id [String] Workspace UUID
181
+ # @param knowledge_base_id [String] Knowledge base UUID
182
+ # @param id [String] Knowledge base item UUID
183
+ # @param [Hash] opts the optional parameters
184
+ # @return [Array<(GetPublicWorkspacesKnowledgeBasesItems2200Response, Integer, Hash)>] GetPublicWorkspacesKnowledgeBasesItems2200Response data, response status code and response headers
185
+ def get_public_workspaces_knowledge_bases_items2_with_http_info(workspace_id, knowledge_base_id, id, opts = {})
186
+ if @api_client.config.debugging
187
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items2 ...'
188
+ end
189
+ # verify the required parameter 'workspace_id' is set
190
+ if @api_client.config.client_side_validation && workspace_id.nil?
191
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items2"
192
+ end
193
+ # verify the required parameter 'knowledge_base_id' is set
194
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
195
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items2"
196
+ end
197
+ # verify the required parameter 'id' is set
198
+ if @api_client.config.client_side_validation && id.nil?
199
+ fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items2"
200
+ end
201
+ # resource path
202
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items/{id}'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s)).sub('{id}', CGI.escape(id.to_s))
203
+
204
+ # query parameters
205
+ query_params = opts[:query_params] || {}
206
+
207
+ # header parameters
208
+ header_params = opts[:header_params] || {}
209
+ # HTTP header 'Accept' (if needed)
210
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
211
+
212
+ # form parameters
213
+ form_params = opts[:form_params] || {}
214
+
215
+ # http body (model)
216
+ post_body = opts[:debug_body]
217
+
218
+ # return_type
219
+ return_type = opts[:debug_return_type] || 'GetPublicWorkspacesKnowledgeBasesItems2200Response'
220
+
221
+ # auth_names
222
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
223
+
224
+ new_options = opts.merge(
225
+ :operation => :"KnowledgeBaseItemsApi.get_public_workspaces_knowledge_bases_items2",
226
+ :header_params => header_params,
227
+ :query_params => query_params,
228
+ :form_params => form_params,
229
+ :body => post_body,
230
+ :auth_names => auth_names,
231
+ :return_type => return_type
232
+ )
233
+
234
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
235
+ if @api_client.config.debugging
236
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#get_public_workspaces_knowledge_bases_items2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
237
+ end
238
+ return data, status_code, headers
239
+ end
240
+
241
+ # Update a knowledge base item
242
+ # Updates an existing knowledge base item in the requested public API workspace.
243
+ # @param workspace_id [String] Workspace UUID
244
+ # @param knowledge_base_id [String] Knowledge base UUID
245
+ # @param id [String] Knowledge base item UUID
246
+ # @param patch_public_workspaces_knowledge_bases_items_request [PatchPublicWorkspacesKnowledgeBasesItemsRequest]
247
+ # @param [Hash] opts the optional parameters
248
+ # @return [PatchPublicWorkspacesKnowledgeBasesItems200Response]
249
+ def patch_public_workspaces_knowledge_bases_items(workspace_id, knowledge_base_id, id, patch_public_workspaces_knowledge_bases_items_request, opts = {})
250
+ data, _status_code, _headers = patch_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, id, patch_public_workspaces_knowledge_bases_items_request, opts)
251
+ data
252
+ end
253
+
254
+ # Update a knowledge base item
255
+ # Updates an existing knowledge base item in the requested public API workspace.
256
+ # @param workspace_id [String] Workspace UUID
257
+ # @param knowledge_base_id [String] Knowledge base UUID
258
+ # @param id [String] Knowledge base item UUID
259
+ # @param patch_public_workspaces_knowledge_bases_items_request [PatchPublicWorkspacesKnowledgeBasesItemsRequest]
260
+ # @param [Hash] opts the optional parameters
261
+ # @return [Array<(PatchPublicWorkspacesKnowledgeBasesItems200Response, Integer, Hash)>] PatchPublicWorkspacesKnowledgeBasesItems200Response data, response status code and response headers
262
+ def patch_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, id, patch_public_workspaces_knowledge_bases_items_request, opts = {})
263
+ if @api_client.config.debugging
264
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items ...'
265
+ end
266
+ # verify the required parameter 'workspace_id' is set
267
+ if @api_client.config.client_side_validation && workspace_id.nil?
268
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items"
269
+ end
270
+ # verify the required parameter 'knowledge_base_id' is set
271
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
272
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items"
273
+ end
274
+ # verify the required parameter 'id' is set
275
+ if @api_client.config.client_side_validation && id.nil?
276
+ fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items"
277
+ end
278
+ # verify the required parameter 'patch_public_workspaces_knowledge_bases_items_request' is set
279
+ if @api_client.config.client_side_validation && patch_public_workspaces_knowledge_bases_items_request.nil?
280
+ fail ArgumentError, "Missing the required parameter 'patch_public_workspaces_knowledge_bases_items_request' when calling KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items"
281
+ end
282
+ # resource path
283
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items/{id}'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s)).sub('{id}', CGI.escape(id.to_s))
284
+
285
+ # query parameters
286
+ query_params = opts[:query_params] || {}
287
+
288
+ # header parameters
289
+ header_params = opts[:header_params] || {}
290
+ # HTTP header 'Accept' (if needed)
291
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
292
+ # HTTP header 'Content-Type'
293
+ content_type = @api_client.select_header_content_type(['application/json'])
294
+ if !content_type.nil?
295
+ header_params['Content-Type'] = content_type
296
+ end
297
+
298
+ # form parameters
299
+ form_params = opts[:form_params] || {}
300
+
301
+ # http body (model)
302
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_public_workspaces_knowledge_bases_items_request)
303
+
304
+ # return_type
305
+ return_type = opts[:debug_return_type] || 'PatchPublicWorkspacesKnowledgeBasesItems200Response'
306
+
307
+ # auth_names
308
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
309
+
310
+ new_options = opts.merge(
311
+ :operation => :"KnowledgeBaseItemsApi.patch_public_workspaces_knowledge_bases_items",
312
+ :header_params => header_params,
313
+ :query_params => query_params,
314
+ :form_params => form_params,
315
+ :body => post_body,
316
+ :auth_names => auth_names,
317
+ :return_type => return_type
318
+ )
319
+
320
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
321
+ if @api_client.config.debugging
322
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#patch_public_workspaces_knowledge_bases_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
323
+ end
324
+ return data, status_code, headers
325
+ end
326
+
327
+ # Create a knowledge base item
328
+ # Creates a new item in a knowledge base in the requested public API workspace.
329
+ # @param workspace_id [String] Workspace UUID
330
+ # @param knowledge_base_id [String] Knowledge base UUID
331
+ # @param post_public_workspaces_knowledge_bases_items_request [PostPublicWorkspacesKnowledgeBasesItemsRequest]
332
+ # @param [Hash] opts the optional parameters
333
+ # @return [PostPublicWorkspacesKnowledgeBasesItems200Response]
334
+ def post_public_workspaces_knowledge_bases_items(workspace_id, knowledge_base_id, post_public_workspaces_knowledge_bases_items_request, opts = {})
335
+ data, _status_code, _headers = post_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, post_public_workspaces_knowledge_bases_items_request, opts)
336
+ data
337
+ end
338
+
339
+ # Create a knowledge base item
340
+ # Creates a new item in a knowledge base in the requested public API workspace.
341
+ # @param workspace_id [String] Workspace UUID
342
+ # @param knowledge_base_id [String] Knowledge base UUID
343
+ # @param post_public_workspaces_knowledge_bases_items_request [PostPublicWorkspacesKnowledgeBasesItemsRequest]
344
+ # @param [Hash] opts the optional parameters
345
+ # @return [Array<(PostPublicWorkspacesKnowledgeBasesItems200Response, Integer, Hash)>] PostPublicWorkspacesKnowledgeBasesItems200Response data, response status code and response headers
346
+ def post_public_workspaces_knowledge_bases_items_with_http_info(workspace_id, knowledge_base_id, post_public_workspaces_knowledge_bases_items_request, opts = {})
347
+ if @api_client.config.debugging
348
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items ...'
349
+ end
350
+ # verify the required parameter 'workspace_id' is set
351
+ if @api_client.config.client_side_validation && workspace_id.nil?
352
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items"
353
+ end
354
+ # verify the required parameter 'knowledge_base_id' is set
355
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
356
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items"
357
+ end
358
+ # verify the required parameter 'post_public_workspaces_knowledge_bases_items_request' is set
359
+ if @api_client.config.client_side_validation && post_public_workspaces_knowledge_bases_items_request.nil?
360
+ fail ArgumentError, "Missing the required parameter 'post_public_workspaces_knowledge_bases_items_request' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items"
361
+ end
362
+ # resource path
363
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s))
364
+
365
+ # query parameters
366
+ query_params = opts[:query_params] || {}
367
+
368
+ # header parameters
369
+ header_params = opts[:header_params] || {}
370
+ # HTTP header 'Accept' (if needed)
371
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
372
+ # HTTP header 'Content-Type'
373
+ content_type = @api_client.select_header_content_type(['application/json'])
374
+ if !content_type.nil?
375
+ header_params['Content-Type'] = content_type
376
+ end
377
+
378
+ # form parameters
379
+ form_params = opts[:form_params] || {}
380
+
381
+ # http body (model)
382
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(post_public_workspaces_knowledge_bases_items_request)
383
+
384
+ # return_type
385
+ return_type = opts[:debug_return_type] || 'PostPublicWorkspacesKnowledgeBasesItems200Response'
386
+
387
+ # auth_names
388
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
389
+
390
+ new_options = opts.merge(
391
+ :operation => :"KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items",
392
+ :header_params => header_params,
393
+ :query_params => query_params,
394
+ :form_params => form_params,
395
+ :body => post_body,
396
+ :auth_names => auth_names,
397
+ :return_type => return_type
398
+ )
399
+
400
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
401
+ if @api_client.config.debugging
402
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#post_public_workspaces_knowledge_bases_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
403
+ end
404
+ return data, status_code, headers
405
+ end
406
+
407
+ # Regenerate a knowledge base item
408
+ # Enqueues a background job to re-fetch and re-embed the knowledge base item. Returns a request_id for async tracking.
409
+ # @param workspace_id [String] Workspace UUID
410
+ # @param knowledge_base_id [String] Knowledge base UUID
411
+ # @param id [String] Knowledge base item UUID
412
+ # @param [Hash] opts the optional parameters
413
+ # @return [PostPublicWorkspacesKnowledgeBasesItemsRegenerate200Response]
414
+ def post_public_workspaces_knowledge_bases_items_regenerate(workspace_id, knowledge_base_id, id, opts = {})
415
+ data, _status_code, _headers = post_public_workspaces_knowledge_bases_items_regenerate_with_http_info(workspace_id, knowledge_base_id, id, opts)
416
+ data
417
+ end
418
+
419
+ # Regenerate a knowledge base item
420
+ # Enqueues a background job to re-fetch and re-embed the knowledge base item. Returns a request_id for async tracking.
421
+ # @param workspace_id [String] Workspace UUID
422
+ # @param knowledge_base_id [String] Knowledge base UUID
423
+ # @param id [String] Knowledge base item UUID
424
+ # @param [Hash] opts the optional parameters
425
+ # @return [Array<(PostPublicWorkspacesKnowledgeBasesItemsRegenerate200Response, Integer, Hash)>] PostPublicWorkspacesKnowledgeBasesItemsRegenerate200Response data, response status code and response headers
426
+ def post_public_workspaces_knowledge_bases_items_regenerate_with_http_info(workspace_id, knowledge_base_id, id, opts = {})
427
+ if @api_client.config.debugging
428
+ @api_client.config.logger.debug 'Calling API: KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items_regenerate ...'
429
+ end
430
+ # verify the required parameter 'workspace_id' is set
431
+ if @api_client.config.client_side_validation && workspace_id.nil?
432
+ fail ArgumentError, "Missing the required parameter 'workspace_id' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items_regenerate"
433
+ end
434
+ # verify the required parameter 'knowledge_base_id' is set
435
+ if @api_client.config.client_side_validation && knowledge_base_id.nil?
436
+ fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items_regenerate"
437
+ end
438
+ # verify the required parameter 'id' is set
439
+ if @api_client.config.client_side_validation && id.nil?
440
+ fail ArgumentError, "Missing the required parameter 'id' when calling KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items_regenerate"
441
+ end
442
+ # resource path
443
+ local_var_path = '/public/workspaces/{workspace_id}/knowledge_bases/{knowledge_base_id}/items/{id}/regenerate'.sub('{workspace_id}', CGI.escape(workspace_id.to_s)).sub('{knowledge_base_id}', CGI.escape(knowledge_base_id.to_s)).sub('{id}', CGI.escape(id.to_s))
444
+
445
+ # query parameters
446
+ query_params = opts[:query_params] || {}
447
+
448
+ # header parameters
449
+ header_params = opts[:header_params] || {}
450
+ # HTTP header 'Accept' (if needed)
451
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
452
+
453
+ # form parameters
454
+ form_params = opts[:form_params] || {}
455
+
456
+ # http body (model)
457
+ post_body = opts[:debug_body]
458
+
459
+ # return_type
460
+ return_type = opts[:debug_return_type] || 'PostPublicWorkspacesKnowledgeBasesItemsRegenerate200Response'
461
+
462
+ # auth_names
463
+ auth_names = opts[:debug_auth_names] || ['bearer_auth']
464
+
465
+ new_options = opts.merge(
466
+ :operation => :"KnowledgeBaseItemsApi.post_public_workspaces_knowledge_bases_items_regenerate",
467
+ :header_params => header_params,
468
+ :query_params => query_params,
469
+ :form_params => form_params,
470
+ :body => post_body,
471
+ :auth_names => auth_names,
472
+ :return_type => return_type
473
+ )
474
+
475
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
476
+ if @api_client.config.debugging
477
+ @api_client.config.logger.debug "API called: KnowledgeBaseItemsApi#post_public_workspaces_knowledge_bases_items_regenerate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
478
+ end
479
+ return data, status_code, headers
480
+ end
481
+ end
482
+ end