ragie_ruby_sdk 1.0.11 → 1.0.13

data/docs/Response.md

@@ -0,0 +1,62 @@
+# RagieRubySdk::Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **object** | **String** |  | [optional][default to 'response'] |
+| **created_at** | **Integer** |  |  |
+| **status** | **String** |  |  |
+| **error** | **String** |  | [optional] |
+| **incomplete_details** | **Object** |  | [optional] |
+| **instructions** | **String** |  | [optional] |
+| **max_output_tokens** | **Object** |  | [optional] |
+| **model** | **String** |  | [optional][default to 'deep-search'] |
+| **output** | [**Array<ResponseOutput>**](ResponseOutput.md) |  |  |
+| **output_parsed** | [**FinalAnswer**](FinalAnswer.md) |  | [optional] |
+| **tools** | [**Array<Tool>**](Tool.md) |  |  |
+| **reasoning** | [**Reasoning**](Reasoning.md) |  |  |
+| **parallel_tool_calls** | **Boolean** |  | [optional][default to false] |
+| **store** | **Boolean** |  | [optional][default to false] |
+| **temperature** | **Float** |  | [optional][default to 1.0] |
+| **previous_response_id** | **String** |  | [optional] |
+| **tool_choice** | **String** |  | [optional][default to 'auto'] |
+| **top_p** | **Float** |  | [optional][default to 1.0] |
+| **truncation** | **String** |  | [optional][default to 'disabled'] |
+| **usage** | [**RagieApiSchemaResponseUsage**](RagieApiSchemaResponseUsage.md) |  |  |
+| **user** | **Object** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Response.new(
+  id: null,
+  object: null,
+  created_at: null,
+  status: null,
+  error: null,
+  incomplete_details: null,
+  instructions: null,
+  max_output_tokens: null,
+  model: null,
+  output: null,
+  output_parsed: null,
+  tools: null,
+  reasoning: null,
+  parallel_tool_calls: null,
+  store: null,
+  temperature: null,
+  previous_response_id: null,
+  tool_choice: null,
+  top_p: null,
+  truncation: null,
+  usage: null,
+  user: null,
+  metadata: null
+)
+```
+

data/docs/ResponseContent.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::ResponseContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'text'] |
+| **text** | **String** |  |  |
+| **annotations** | **Array<Hash<String, Object>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ResponseContent.new(
+  type: null,
+  text: null,
+  annotations: null
+)
+```
+

data/docs/ResponseOutput.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::ResponseOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'message'] |
+| **id** | **String** |  |  |
+| **role** | **String** |  | [optional][default to 'assistant'] |
+| **content** | [**Array<ResponseContent>**](ResponseContent.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ResponseOutput.new(
+  type: null,
+  id: null,
+  role: null,
+  content: null
+)
+```
+

data/docs/ResponsesApi.md

@@ -0,0 +1,147 @@
+# RagieRubySdk::ResponsesApi
+
+All URIs are relative to *https://api.ragie.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_response_responses_post**](ResponsesApi.md#create_response_responses_post) | **POST** /responses | Create Response |
+| [**get_response_responses_response_id_get**](ResponsesApi.md#get_response_responses_response_id_get) | **GET** /responses/{response_id} | Get Response |
+
+
+## create_response_responses_post
+
+> <Response> create_response_responses_post(request)
+
+Create Response
+
+Create a response. This will generate an LLM or agentic response. At this time the only supported model is `deep-search`. Responses may be streamed or returned synchronously. The `retrieve` tool is currently the only supported tool, more tools will be added in the future. A single partition may be provided in the retrieve tool. If omitted the `default` partition is used.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ragie_ruby_sdk'
+# setup authorization
+RagieRubySdk.configure do |config|
+  # Configure Bearer authorization: auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RagieRubySdk::ResponsesApi.new
+request = RagieRubySdk::Request.new({input: 'input_example'}) # Request | 
+
+begin
+  # Create Response
+  result = api_instance.create_response_responses_post(request)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling ResponsesApi->create_response_responses_post: #{e}"
+end
+```
+
+#### Using the create_response_responses_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Response>, Integer, Hash)> create_response_responses_post_with_http_info(request)
+
+```ruby
+begin
+  # Create Response
+  data, status_code, headers = api_instance.create_response_responses_post_with_http_info(request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Response>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling ResponsesApi->create_response_responses_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request** | [**Request**](Request.md) |  |  |
+
+### Return type
+
+[**Response**](Response.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_response_responses_response_id_get
+
+> <Response> get_response_responses_response_id_get(response_id)
+
+Get Response
+
+Get a response by its ID. This will return the response and its status. If the response is still in progress, the status will be `in_progress`. If the response is completed, the status will be `completed`. If the response is failed, the status will be `failed`.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ragie_ruby_sdk'
+# setup authorization
+RagieRubySdk.configure do |config|
+  # Configure Bearer authorization: auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RagieRubySdk::ResponsesApi.new
+response_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get Response
+  result = api_instance.get_response_responses_response_id_get(response_id)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling ResponsesApi->get_response_responses_response_id_get: #{e}"
+end
+```
+
+#### Using the get_response_responses_response_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Response>, Integer, Hash)> get_response_responses_response_id_get_with_http_info(response_id)
+
+```ruby
+begin
+  # Get Response
+  data, status_code, headers = api_instance.get_response_responses_response_id_get_with_http_info(response_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Response>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling ResponsesApi->get_response_responses_response_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_id** | **String** |  |  |
+
+### Return type
+
+[**Response**](Response.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Search.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::Search
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **search_requests** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Search.new(
+  search_requests: null
+)
+```
+

data/docs/SearchResultLink.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::SearchResultLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SearchResultLink.new(
+  href: null,
+  type: null
+)
+```
+

data/docs/SearchStep.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::SearchStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'search'] |
+| **think** | **String** |  |  |
+| **current_question** | **String** |  |  |
+| **search** | [**Search**](Search.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SearchStep.new(
+  type: null,
+  think: null,
+  current_question: null,
+  search: null
+)
+```
+

data/docs/SurrenderStep.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::SurrenderStep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'surrender'] |
+| **think** | **String** |  |  |
+| **current_question** | **String** |  |  |
+| **partial_answer** | [**Answer**](Answer.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SurrenderStep.new(
+  type: null,
+  think: null,
+  current_question: null,
+  partial_answer: null
+)
+```
+

data/docs/Tool.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::Tool
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **partitions** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Tool.new(
+  type: null,
+  partitions: null
+)
+```
+

data/lib/ragie_ruby_sdk/api/responses_api.rb

@@ -0,0 +1,153 @@
+=begin
+#Ragie API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module RagieRubySdk
+  class ResponsesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Response
+    # Create a response. This will generate an LLM or agentic response. At this time the only supported model is `deep-search`. Responses may be streamed or returned synchronously. The `retrieve` tool is currently the only supported tool, more tools will be added in the future. A single partition may be provided in the retrieve tool. If omitted the `default` partition is used.
+    # @param request [Request] 
+    # @param [Hash] opts the optional parameters
+    # @return [Response]
+    def create_response_responses_post(request, opts = {})
+      data, _status_code, _headers = create_response_responses_post_with_http_info(request, opts)
+      data
+    end
+
+    # Create Response
+    # Create a response. This will generate an LLM or agentic response. At this time the only supported model is `deep-search`. Responses may be streamed or returned synchronously. The `retrieve` tool is currently the only supported tool, more tools will be added in the future. A single partition may be provided in the retrieve tool. If omitted the `default` partition is used.
+    # @param request [Request] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Response, Integer, Hash)>] Response data, response status code and response headers
+    def create_response_responses_post_with_http_info(request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ResponsesApi.create_response_responses_post ...'
+      end
+      # verify the required parameter 'request' is set
+      if @api_client.config.client_side_validation && request.nil?
+        fail ArgumentError, "Missing the required parameter 'request' when calling ResponsesApi.create_response_responses_post"
+      end
+      # resource path
+      local_var_path = '/responses'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['auth']
+
+      new_options = opts.merge(
+        :operation => :"ResponsesApi.create_response_responses_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ResponsesApi#create_response_responses_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Response
+    # Get a response by its ID. This will return the response and its status. If the response is still in progress, the status will be `in_progress`. If the response is completed, the status will be `completed`. If the response is failed, the status will be `failed`.
+    # @param response_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Response]
+    def get_response_responses_response_id_get(response_id, opts = {})
+      data, _status_code, _headers = get_response_responses_response_id_get_with_http_info(response_id, opts)
+      data
+    end
+
+    # Get Response
+    # Get a response by its ID. This will return the response and its status. If the response is still in progress, the status will be &#x60;in_progress&#x60;. If the response is completed, the status will be &#x60;completed&#x60;. If the response is failed, the status will be &#x60;failed&#x60;.
+    # @param response_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Response, Integer, Hash)>] Response data, response status code and response headers
+    def get_response_responses_response_id_get_with_http_info(response_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ResponsesApi.get_response_responses_response_id_get ...'
+      end
+      # verify the required parameter 'response_id' is set
+      if @api_client.config.client_side_validation && response_id.nil?
+        fail ArgumentError, "Missing the required parameter 'response_id' when calling ResponsesApi.get_response_responses_response_id_get"
+      end
+      # resource path
+      local_var_path = '/responses/{response_id}'.sub('{' + 'response_id' + '}', CGI.escape(response_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['auth']
+
+      new_options = opts.merge(
+        :operation => :"ResponsesApi.get_response_responses_response_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ResponsesApi#get_response_responses_response_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end