Module: LiterLlm

Defined in:
lib/liter_llm.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/native.rb,
lib/liter_llm/version.rb,
sig/types.rbs

Overview

This file is auto-generated by alef — DO NOT EDIT. alef:hash:88ee8b27506a07e9a00d7910d2790f077dcabfd849cf5e086719864f9e1de4a0 To regenerate: alef generate To verify freshness: alef verify frozen_string_literal: true

Defined Under Namespace

Classes: AssistantContent, AssistantMessage, AssistantPart, AssistantPartOutputAudio, AssistantPartOutputImage, AssistantPartRefusal, AssistantPartText, AudioContent, AuthConfig, AuthHeaderFormat, AuthType, BatchListQuery, BatchListResponse, BatchObject, BatchRequestCounts, BatchStatus, BedrockConfig, BudgetConfig, CacheBackend, CacheBackendMemory, CacheBackendOpenDal, CacheConfig, CatalogRefreshConfig, ChatCompletionChunk, ChatCompletionRequest, ChatCompletionResponse, ChatCompletionTool, Choice, CircuitState, ContentPart, ContentPartDocument, ContentPartImageUrl, ContentPartInputAudio, ContentPartText, CreateBatchRequest, CreateFileRequest, CreateImageRequest, CreateResponseRequest, CreateSpeechRequest, CreateTranscriptionRequest, CustomProviderConfig, DecodedDataUrl, DefaultClient, DeleteResponse, DeveloperMessage, DocumentContent, EmbeddingContentPart, EmbeddingContentPartImageBase64, EmbeddingContentPartImageUrl, EmbeddingContentPartText, EmbeddingFormat, EmbeddingInput, EmbeddingObject, EmbeddingRequest, EmbeddingResponse, Enforcement, FileListQuery, FileListResponse, FileObject, FilePurpose, FinishReason, FunctionCall, FunctionDefinition, FunctionMessage, HealthStatus, Image, ImageDetail, ImageUrl, ImagesResponse, InFlightLimitConfig, IntentPrototype, JsonSchemaFormat, LiterLlmErrorInfo, LlmBudgetConfig, LlmCacheConfig, LlmConfig, LlmInFlightLimitConfig, LlmProviderConfig, LlmRateLimitConfig, Message, MessageAssistant, MessageDeveloper, MessageFunction, MessageSystem, MessageTool, MessageUser, Modality, ModelInfo, ModelObject, ModelTier, ModelsListResponse, ModerationCategories, ModerationCategoryScores, ModerationInput, ModerationRequest, ModerationResponse, ModerationResult, OcrDocument, OcrDocumentBase64, OcrDocumentUrl, OcrImage, OcrPage, OcrRequest, OcrResponse, PageDimensions, PromptTokensDetails, ProviderCapabilities, ProviderConfig, RateLimitConfig, ReasoningEffort, RefreshOutcome, RerankDocument, RerankRequest, RerankResponse, RerankResult, RerankResultDocument, ResponseFormat, ResponseFormatJsonObject, ResponseFormatJsonSchema, ResponseFormatText, ResponseObject, ResponseOutputItem, ResponseTool, ResponseUsage, SearchRequest, SearchResponse, SearchResult, SingleflightResult, SpecificFunction, SpecificToolChoice, StopSequence, StreamChoice, StreamDelta, StreamFormat, StreamFunctionCall, StreamOptions, StreamToolCall, SystemMessage, ToolCall, ToolChoice, ToolChoiceMode, ToolMessage, ToolType, TranscriptionResponse, TranscriptionSegment, Usage, UserContent, UserMessage, WaitForBatchConfig

Constant Summary collapse

VERSION =

The version string for this package.

Returns:

  • (String) 
"1.18.1"

Class Method Summary collapse

Class Method Details

.all_providers ⇒ Array[ProviderConfig]

Returns:



1040
 
# File 'sig/types.rbs', line 1040

def self.all_providers: () -> Array[ProviderConfig]

.capabilities ⇒ ProviderCapabilities

Parameters:

  • provider_name (String)

Returns:



1038
 
# File 'sig/types.rbs', line 1038

def self.capabilities: (String provider_name) -> ProviderCapabilities

.check_bound ⇒ void

This method returns an undefined value.

Parameters:

  • context (String)
  • current_len (Integer)
  • incoming (Integer)
  • limit (Integer) 


1058
 
# File 'sig/types.rbs', line 1058

def self.check_bound: (String context, Integer current_len, Integer incoming, Integer limit) -> void

.clear ⇒ void

This method returns an undefined value.



1050
 
# File 'sig/types.rbs', line 1050

def self.clear: () -> void

.clear_catalog_overlay ⇒ void

This method returns an undefined value.



1064
 
# File 'sig/types.rbs', line 1064

def self.clear_catalog_overlay: () -> void

.completion_cost ⇒ Float?

Parameters:

  • model (String)
  • prompt_tokens (Integer)
  • completion_tokens (Integer)

Returns:

  • (Float, nil) 


1044
 
# File 'sig/types.rbs', line 1044

def self.completion_cost: (String model, Integer prompt_tokens, Integer completion_tokens) -> Float?

.completion_cost_with_cache ⇒ Float?

Parameters:

  • model (String)
  • prompt_tokens (Integer)
  • cached_tokens (Integer)
  • completion_tokens (Integer)

Returns:

  • (Float, nil) 


1046
 
# File 'sig/types.rbs', line 1046

def self.completion_cost_with_cache: (String model, Integer prompt_tokens, Integer cached_tokens, Integer completion_tokens) -> Float?

.complex_provider_names ⇒ Array[String]

Returns:

  • (Array[String]) 


1042
 
# File 'sig/types.rbs', line 1042

def self.complex_provider_names: () -> Array[String]

.count_request_tokens ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1054
 
# File 'sig/types.rbs', line 1054

def self.count_request_tokens: (String model, ChatCompletionRequest req) -> Integer

.count_tokens ⇒ Integer

Parameters:

  • model (String)
  • text (String)

Returns:

  • (Integer) 


1052
 
# File 'sig/types.rbs', line 1052

def self.count_tokens: (String model, String text) -> Integer

.create_client ⇒ DefaultClient

Parameters:

  • api_key (String)
  • base_url (String)
  • timeout_secs (Integer)
  • max_retries (Integer)
  • model_hint (String)

Returns:



1026
 
# File 'sig/types.rbs', line 1026

def self.create_client: (String api_key, ?String base_url, ?Integer timeout_secs, ?Integer max_retries, ?String model_hint) -> DefaultClient

.create_client_from_json ⇒ DefaultClient

Parameters:

  • json (String)

Returns:



1028
 
# File 'sig/types.rbs', line 1028

def self.create_client_from_json: (String json) -> DefaultClient

.decode_data_url ⇒ DecodedDataUrl?

Parameters:

  • url (String)

Returns:



1032
 
# File 'sig/types.rbs', line 1032

def self.decode_data_url: (String url) -> DecodedDataUrl?

.encode_data_url ⇒ String

Parameters:

  • bytes (String)
  • mime (String)

Returns:

  • (String) 


1030
 
# File 'sig/types.rbs', line 1030

def self.encode_data_url: (String bytes, ?String mime) -> String

.ensure_crypto_provider ⇒ void

This method returns an undefined value.



1060
 
# File 'sig/types.rbs', line 1060

def self.ensure_crypto_provider: () -> void

.install_catalog_overlay_from_str ⇒ void

This method returns an undefined value.

Parameters:

  • catalog_json (String) 


1062
 
# File 'sig/types.rbs', line 1062

def self.install_catalog_overlay_from_str: (String catalog_json) -> void

.model_info ⇒ ModelInfo?

Parameters:

  • model (String)

Returns:



1048
 
# File 'sig/types.rbs', line 1048

def self.model_info: (String model) -> ModelInfo?

.record_cost_usd ⇒ void

This method returns an undefined value.

Parameters:

  • system (String)
  • model (String)
  • operation (String)
  • cost_usd (Float) 


1056
 
# File 'sig/types.rbs', line 1056

def self.record_cost_usd: (String system, String model, String operation, Float cost_usd) -> void

.refresh_catalog ⇒ RefreshOutcome

Parameters:

Returns:



1066
 
# File 'sig/types.rbs', line 1066

def self.refresh_catalog: (CatalogRefreshConfig config) -> RefreshOutcome

.register_custom_provider ⇒ void

This method returns an undefined value.

Parameters:



1034
 
# File 'sig/types.rbs', line 1034

def self.register_custom_provider: (CustomProviderConfig config) -> void

.unregister_custom_provider ⇒ Boolean

Parameters:

  • name (String)

Returns:

  • (Boolean) 


1036
 
# File 'sig/types.rbs', line 1036

def self.unregister_custom_provider: (String name) -> bool