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/version.rb,
sig/types.rbs

Overview

This file is auto-generated by alef — DO NOT EDIT. alef:hash:9c479751c0805b45ce76a17491cc7b1b4c87a95d35e5ac93b5d5d0ac4b974284 To regenerate: alef generate To verify freshness: alef verify --exit-code frozen_string_literal: true

Defined Under Namespace

Classes: AssistantContent, AssistantMessage, AssistantPart, AssistantPartOutputAudio, AssistantPartOutputImage, AssistantPartRefusal, AssistantPartText, AudioContent, AuthConfig, AuthHeaderFormat, AuthType, BatchListQuery, BatchListResponse, BatchObject, BatchRequestCounts, BatchStatus, 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, EmbeddingFormat, EmbeddingInput, EmbeddingObject, EmbeddingRequest, EmbeddingResponse, Enforcement, FileListQuery, FileListResponse, FileObject, FilePurpose, FinishReason, FunctionCall, FunctionDefinition, FunctionMessage, HealthStatus, Image, ImageDetail, ImageUrl, ImagesResponse, IntentPrototype, JsonSchemaFormat, LiterLlmErrorInfo, 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.11.1"

Class Method Summary collapse

Class Method Details

.all_providersArray[ProviderConfig]

Returns:



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

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

.capabilitiesProviderCapabilities

Parameters:

  • provider_name (String)

Returns:



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

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

.check_boundvoid

This method returns an undefined value.

Parameters:

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


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

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

.clearvoid

This method returns an undefined value.



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

def self.clear: () -> void

.clear_catalog_overlayvoid

This method returns an undefined value.



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

def self.clear_catalog_overlay: () -> void

.completion_costFloat?

Parameters:

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

Returns:

  • (Float, nil)


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

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

.completion_cost_with_cacheFloat?

Parameters:

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

Returns:

  • (Float, nil)


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

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

.complex_provider_namesArray[String]

Returns:

  • (Array[String])


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

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

.count_request_tokensInteger

Parameters:

Returns:

  • (Integer)


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

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

.count_tokensInteger

Parameters:

  • model (String)
  • text (String)

Returns:

  • (Integer)


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

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

.create_clientDefaultClient

Parameters:

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

Returns:



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

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

.create_client_from_jsonDefaultClient

Parameters:

  • json (String)

Returns:



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

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

.decode_data_urlDecodedDataUrl?

Parameters:

  • url (String)

Returns:



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

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

.encode_data_urlString

Parameters:

  • bytes (String)
  • mime (String)

Returns:

  • (String)


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

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

.ensure_crypto_providervoid

This method returns an undefined value.



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

def self.ensure_crypto_provider: () -> void

.install_catalog_overlay_from_strvoid

This method returns an undefined value.

Parameters:

  • catalog_json (String)


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

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

.model_infoModelInfo?

Parameters:

  • model (String)

Returns:



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

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

.refresh_catalogRefreshOutcome

Parameters:

Returns:



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

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

.register_custom_providervoid

This method returns an undefined value.

Parameters:



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

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

.unregister_custom_providerBoolean

Parameters:

  • name (String)

Returns:

  • (Boolean)


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

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