ragie_ruby_sdk

RagieRubySdk - the Ruby gem for the Ragie API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.8
Generator version: 7.16.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build ragie_ruby_sdk.gemspec

Then either install the gem locally:

gem install ./ragie_ruby_sdk-1.0.8.gem

(for development, run gem install --dev ./ragie_ruby_sdk-1.0.8.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'ragie_ruby_sdk', '~> 1.0.8'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'ragie_ruby_sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'ragie_ruby_sdk'

# Setup authorization
RagieRubySdk.configure do |config|
  # Configure Bearer authorization: auth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = RagieRubySdk::AuthenticatorsApi.new
payload = RagieRubySdk::CreateGoogleAuthenticator.new({provider: 'google', name: 'name_example', client_id: 'client_id_example', client_secret: 'client_secret_example'}) # Payload | 

begin
  #Create Authenticator
  result = api_instance.create_authenticator(payload)
  p result
rescue RagieRubySdk::ApiError => e
  puts "Exception when calling AuthenticatorsApi->create_authenticator: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.ragie.ai

Class	Method	HTTP request	Description
RagieRubySdk::AuthenticatorsApi	create_authenticator	POST /authenticators	Create Authenticator
RagieRubySdk::AuthenticatorsApi	create_authenticator_connection	POST /authenticators/authenticator_id/connection	Create Authenticator Connection
RagieRubySdk::AuthenticatorsApi	delete_authenticator_connection	DELETE /authenticators/authenticator_id	Delete Authenticator
RagieRubySdk::AuthenticatorsApi	list_authenticators	GET /authenticators	List Authenticators
RagieRubySdk::BetaApi	create_authenticator	POST /authenticators	Create Authenticator
RagieRubySdk::BetaApi	create_authenticator_connection	POST /authenticators/authenticator_id/connection	Create Authenticator Connection
RagieRubySdk::BetaApi	create_connection	POST /connection	Create Connection
RagieRubySdk::BetaApi	delete_authenticator_connection	DELETE /authenticators/authenticator_id	Delete Authenticator
RagieRubySdk::BetaApi	list_authenticators	GET /authenticators	List Authenticators
RagieRubySdk::ConnectionsApi	create_connection	POST /connection	Create Connection
RagieRubySdk::ConnectionsApi	create_oauth_redirect_url_connections_oauth_post	POST /connections/oauth	Create Oauth Redirect Url
RagieRubySdk::ConnectionsApi	delete_connection_connections_connection_id_delete_post	POST /connections/connection_id/delete	Delete Connection
RagieRubySdk::ConnectionsApi	get_connection_connections_connection_id_get	GET /connections/connection_id	Get Connection
RagieRubySdk::ConnectionsApi	get_connection_stats_connections_connection_id_stats_get	GET /connections/connection_id/stats	Get Connection Stats
RagieRubySdk::ConnectionsApi	list_connection_source_types_connections_source_type_get	GET /connections/source-type	List Connection Source Types
RagieRubySdk::ConnectionsApi	list_connections_connections_get	GET /connections	List Connections
RagieRubySdk::ConnectionsApi	set_connection_enabled_connections_connection_id_enabled_put	PUT /connections/connection_id/enabled	Set Connection Enabled
RagieRubySdk::ConnectionsApi	set_connection_limits_connections_connection_id_limit_put	PUT /connections/connection_id/limit	Set Connection Limits
RagieRubySdk::ConnectionsApi	sync_connection	POST /connections/connection_id/sync	Sync Connection
RagieRubySdk::ConnectionsApi	update_connection_connections_connection_id_put	PUT /connections/connection_id	Update Connection
RagieRubySdk::DocumentsApi	create_document	POST /documents	Create Document
RagieRubySdk::DocumentsApi	create_document_from_url	POST /documents/url	Create Document From Url
RagieRubySdk::DocumentsApi	create_document_raw	POST /documents/raw	Create Document Raw
RagieRubySdk::DocumentsApi	delete_document	DELETE /documents/document_id	Delete Document
RagieRubySdk::DocumentsApi	get_document	GET /documents/document_id	Get Document
RagieRubySdk::DocumentsApi	get_document_chunk	GET /documents/document_id/chunks/chunk_id	Get Document Chunk
RagieRubySdk::DocumentsApi	get_document_chunk_content	GET /documents/document_id/chunks/chunk_id/content	Get Document Chunk Content
RagieRubySdk::DocumentsApi	get_document_chunks	GET /documents/document_id/chunks	Get Document Chunks
RagieRubySdk::DocumentsApi	get_document_content	GET /documents/document_id/content	Get Document Content
RagieRubySdk::DocumentsApi	get_document_source	GET /documents/document_id/source	Get Document Source
RagieRubySdk::DocumentsApi	get_document_summary	GET /documents/document_id/summary	Get Document Summary
RagieRubySdk::DocumentsApi	list_documents	GET /documents	List Documents
RagieRubySdk::DocumentsApi	patch_document_metadata	PATCH /documents/document_id/metadata	Patch Document Metadata
RagieRubySdk::DocumentsApi	update_document_file	PUT /documents/document_id/file	Update Document File
RagieRubySdk::DocumentsApi	update_document_from_url	PUT /documents/document_id/url	Update Document Url
RagieRubySdk::DocumentsApi	update_document_raw	PUT /documents/document_id/raw	Update Document Raw
RagieRubySdk::EnterpriseApi	create_authenticator	POST /authenticators	Create Authenticator
RagieRubySdk::EnterpriseApi	create_authenticator_connection	POST /authenticators/authenticator_id/connection	Create Authenticator Connection
RagieRubySdk::EnterpriseApi	create_connection	POST /connection	Create Connection
RagieRubySdk::EnterpriseApi	delete_authenticator_connection	DELETE /authenticators/authenticator_id	Delete Authenticator
RagieRubySdk::EnterpriseApi	list_authenticators	GET /authenticators	List Authenticators
RagieRubySdk::EntitiesApi	create_instruction	POST /instructions	Create Instruction
RagieRubySdk::EntitiesApi	delete_instruction	DELETE /instructions/instruction_id	Delete Instruction
RagieRubySdk::EntitiesApi	list_entities_by_document	GET /documents/document_id/entities	Get Document Extracted Entities
RagieRubySdk::EntitiesApi	list_entities_by_instruction	GET /instructions/instruction_id/entities	Get Instruction Extracted Entities
RagieRubySdk::EntitiesApi	list_instructions	GET /instructions	List Instructions
RagieRubySdk::EntitiesApi	update_instruction	PUT /instructions/instruction_id	Update Instruction
RagieRubySdk::PartitionsApi	create_partition_partitions_post	POST /partitions	Create Partition
RagieRubySdk::PartitionsApi	delete_partition_partitions_partition_id_delete	DELETE /partitions/partition_id	Delete Partition
RagieRubySdk::PartitionsApi	get_partition_partitions_partition_id_get	GET /partitions/partition_id	Get Partition
RagieRubySdk::PartitionsApi	list_partitions_partitions_get	GET /partitions	List Partitions
RagieRubySdk::PartitionsApi	set_partition_limits_partitions_partition_id_limits_put	PUT /partitions/partition_id/limits	Set Partition Limits
RagieRubySdk::RetrievalsApi	retrieve	POST /retrievals	Retrieve