ragie_ruby_sdk 1.0.1

data/docs/PublicFreshdeskConnection.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::PublicFreshdeskConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**FreshdeskData**](FreshdeskData.md) |  |  |
+| **user_email** | **String** | The email the API key is associated with |  |
+| **credentials** | [**FreshdeskCredentials**](FreshdeskCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicFreshdeskConnection.new(
+  provider: null,
+  data: null,
+  user_email: null,
+  credentials: null
+)
+```
+

data/docs/PublicGCSConnection.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PublicGCSConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**BucketData**](BucketData.md) |  |  |
+| **credentials** | **Hash<String, Object>** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicGCSConnection.new(
+  provider: null,
+  data: null,
+  credentials: null
+)
+```
+

data/docs/PublicIntercomConnection.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PublicIntercomConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**IntercomData**](IntercomData.md) |  |  |
+| **credentials** | [**IntercomCredentials**](IntercomCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicIntercomConnection.new(
+  provider: null,
+  data: null,
+  credentials: null
+)
+```
+

data/docs/PublicS3CompatibleConnection.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PublicS3CompatibleConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**BucketData**](BucketData.md) |  |  |
+| **credentials** | [**S3CompatibleCredentials**](S3CompatibleCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicS3CompatibleConnection.new(
+  provider: null,
+  data: null,
+  credentials: null
+)
+```
+

data/docs/PublicZendeskConnection.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PublicZendeskConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**ZendeskData**](ZendeskData.md) |  |  |
+| **credentials** | [**ZendeskCredentials**](ZendeskCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicZendeskConnection.new(
+  provider: null,
+  data: null,
+  credentials: null
+)
+```
+

data/docs/ResponseOK.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::ResponseOK
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional][default to 'ok'] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ResponseOK.new(
+  message: null
+)
+```
+

data/docs/ResponsePatchdocumentmetadata.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::ResponsePatchdocumentmetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | The full document metadata inclusive of the update. |  |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ResponsePatchdocumentmetadata.new(
+  metadata: null,
+  status: null
+)
+```
+

data/docs/Retrieval.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::Retrieval
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scored_chunks** | [**Array<ScoredChunk>**](ScoredChunk.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Retrieval.new(
+  scored_chunks: null
+)
+```
+

data/docs/RetrievalsApi.md

@@ -0,0 +1,75 @@
+# RagieRubySdk::RetrievalsApi
+
+All URIs are relative to *https://api.ragie.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**retrieve**](RetrievalsApi.md#retrieve) | **POST** /retrievals | Retrieve |
+
+
+## retrieve
+
+> <Retrieval> retrieve(retrieve_params)
+
+Retrieve
+
+### 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::RetrievalsApi.new
+retrieve_params = RagieRubySdk::RetrieveParams.new({query: 'query_example'}) # RetrieveParams | 
+
+begin
+  # Retrieve
+  result = api_instance.retrieve(retrieve_params)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling RetrievalsApi->retrieve: #{e}"
+end
+```
+
+#### Using the retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Retrieval>, Integer, Hash)> retrieve_with_http_info(retrieve_params)
+
+```ruby
+begin
+  # Retrieve
+  data, status_code, headers = api_instance.retrieve_with_http_info(retrieve_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Retrieval>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling RetrievalsApi->retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **retrieve_params** | [**RetrieveParams**](RetrieveParams.md) |  |  |
+
+### Return type
+
+[**Retrieval**](Retrieval.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RetrieveParams.md

@@ -0,0 +1,30 @@
+# RagieRubySdk::RetrieveParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | The query to search with when retrieving document chunks. |  |
+| **top_k** | **Integer** | The maximum number of chunks to return. Defaults to 8. | [optional][default to 8] |
+| **filter** | **Hash<String, Object>** |  | [optional] |
+| **rerank** | **Boolean** | Reranks the chunks for semantic relevancy post cosine similarity. Will be slower but returns a subset of highly relevant chunks. Best for reducing hallucinations and improving accuracy for LLM generation. | [optional][default to false] |
+| **max_chunks_per_document** | **Integer** | Maximum number of chunks to retrieve per document. Use this to increase the number of documents the final chunks are retrieved from. This feature is in beta and may change in the future. | [optional] |
+| **partition** | **String** | The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition, which includes any documents that have not been created in a partition. | [optional] |
+| **recency_bias** | **Boolean** | Enables recency bias which will favor more recent documents vs older documents. https://docs.ragie.ai/docs/retrievals-recency-bias | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::RetrieveParams.new(
+  query: null,
+  top_k: null,
+  filter: null,
+  rerank: null,
+  max_chunks_per_document: null,
+  partition: null,
+  recency_bias: null
+)
+```
+

data/docs/S3CompatibleCredentials.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::S3CompatibleCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **access_key_id** | **String** |  |  |
+| **secret_access_key** | **String** |  |  |
+| **region** | **String** |  |  |
+| **endpoint** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::S3CompatibleCredentials.new(
+  access_key_id: null,
+  secret_access_key: null,
+  region: null,
+  endpoint: null
+)
+```
+

data/docs/ScoredChunk.md

@@ -0,0 +1,34 @@
+# RagieRubySdk::ScoredChunk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** |  |  |
+| **score** | **Float** |  |  |
+| **id** | **String** |  |  |
+| **index** | **Integer** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **document_id** | **String** |  |  |
+| **document_name** | **String** |  |  |
+| **document_metadata** | **Hash<String, Object>** |  |  |
+| **links** | [**Hash<String, Link>**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ScoredChunk.new(
+  text: null,
+  score: null,
+  id: null,
+  index: null,
+  metadata: null,
+  document_id: null,
+  document_name: null,
+  document_metadata: null,
+  links: null
+)
+```
+

data/docs/SetConnectionEnabledPayload.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::SetConnectionEnabledPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  |  |
+| **reason** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SetConnectionEnabledPayload.new(
+  enabled: null,
+  reason: null
+)
+```
+

data/docs/SharepointData.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::SharepointData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **site** | [**SharepointSiteData**](SharepointSiteData.md) |  |  |
+| **files** | [**Array<SharepointFileData>**](SharepointFileData.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::SharepointData.new(
+  site: null,
+  files: null
+)
+```
+

data/docs/SharepointFileData.md

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

data/docs/SharepointSiteData.md

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

data/docs/SlackData.md

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

data/docs/Source.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::Source
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Source.new()
+```
+

data/docs/Status.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Status.new()
+```
+

data/docs/UpdateDocumentFromUrlParams.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::UpdateDocumentFromUrlParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | [**Mode**](Mode.md) |  | [optional] |
+| **url** | **String** | Url of the file to download. Must be publicly accessible and HTTP or HTTPS scheme. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::UpdateDocumentFromUrlParams.new(
+  mode: null,
+  url: null
+)
+```
+

data/docs/UpdateDocumentRawParams.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::UpdateDocumentRawParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Data**](Data.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::UpdateDocumentRawParams.new(
+  data: null
+)
+```
+

data/docs/UpdateInstructionParams.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::UpdateInstructionParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Whether the instruction is active. Active instructions are applied to documents when they're created or when their file is updated. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::UpdateInstructionParams.new(
+  active: null
+)
+```
+

data/docs/ValidationError.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::ValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **loc** | [**Array<ValidationErrorLocInner>**](ValidationErrorLocInner.md) |  |  |
+| **msg** | **String** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ValidationError.new(
+  loc: null,
+  msg: null,
+  type: null
+)
+```
+

data/docs/ValidationErrorLocInner.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::ValidationErrorLocInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ValidationErrorLocInner.new()
+```
+

data/docs/VideoModalityData.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::VideoModalityData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to 'video'] |
+| **word_timestamps** | [**Array<WordTimestamp>**](WordTimestamp.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::VideoModalityData.new(
+  type: null,
+  word_timestamps: null
+)
+```
+

data/docs/WordTimestamp.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::WordTimestamp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start_time** | **Float** |  |  |
+| **end_time** | **Float** |  |  |
+| **word** | **String** |  |  |
+| **probability** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::WordTimestamp.new(
+  start_time: null,
+  end_time: null,
+  word: null,
+  probability: null
+)
+```
+

data/docs/ZendeskCredentials.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::ZendeskCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** |  |  |
+| **email** | **String** |  |  |
+| **api_token** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ZendeskCredentials.new(
+  domain: null,
+  email: null,
+  api_token: null
+)
+```
+

data/docs/ZendeskData.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::ZendeskData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **articles** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ZendeskData.new(
+  articles: null
+)
+```
+