View Source LangChain.ChatModels.ChatOrq (LangChain v0.4.0)

Determine if an error should be retried. If true, a fallback LLM may be used. If false, the error is understood to be more fundamental with the request rather than a service issue and it should not be retried or fallback to another service.

serialize_config(model)

Generate a config map that can later restore the model's configuration.

Types

t()

@type t() :: %LangChain.ChatModels.ChatOrq{
  api_key: term(),
  callbacks: term(),
  context: term(),
  documents: term(),
  endpoint: term(),
  extra_params: term(),
  file_ids: term(),
  inputs: term(),
  invoke_options: term(),
  key: term(),
  knowledge_filter: term(),
  messages_passthrough: term(),
  metadata: term(),
  model: term(),
  prefix_messages: term(),
  receive_timeout: term(),
  stream: term(),
  stream_endpoint: term(),
  thread: term(),
  verbose_api: term()
}

Functions

call(orq, prompt, tools \\ [])

Calls the orq.ai API passing the ChatOrq struct with configuration, plus either a simple message or the list of messages to act as the prompt.

Optionally pass in a list of tools available to the LLM for requesting execution in response (tools schema is not sent to orq; tool messages are included in messages).

content_part_for_api(part)

Convert a ContentPart to the expected map of data for the API.

content_parts_for_api(content_parts)

Convert a list of ContentParts to the expected map of data for the API.

content_parts_to_string(content_parts)

Convert a list of ContentParts to a string for tool results. ORQ API expects tool result content to be a string, not an array.

content_to_parts(content)

Convert content to a list of ContentParts. Content may be a string or already a list of ContentParts.

content_to_single_part(content)

Convert content to a single ContentPart for MessageDelta. Content may be a string or already a ContentPart.

decode_stream(data, done \\ [])

@spec decode_stream(
  {String.t(), String.t()},
  list()
) :: {%{required(String.t()) => any()}}

Decode a streamed response (SSE). Delegates to ChatOpenAI-compatible decoder.

for_api(model, msg)

@spec for_api(
  struct(),
  LangChain.Message.t()
  | LangChain.Message.ToolCall.t()
  | LangChain.Message.ToolResult.t()
  | LangChain.Message.ContentPart.t()
  | LangChain.Function.t()
) :: %{required(String.t()) => any()} | [%{required(String.t()) => any()}]

for_api(orq, messages, tools)

@spec for_api(
  t()
  | LangChain.Message.t()
  | LangChain.Message.ToolCall.t()
  | LangChain.Message.ToolResult.t()
  | LangChain.Message.ContentPart.t(),
  message :: [map()],
  LangChain.ChatModels.ChatModel.tools()
) :: %{required(atom()) => any()}

Return the params formatted for an API request.

new(attrs \\ %{})

@spec new(attrs :: map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Setup a ChatOrq client configuration.

new!(attrs \\ %{})

@spec new!(attrs :: map()) :: t() | no_return()

Setup a ChatOrq client configuration and return it or raise an error if invalid.

restore_from_map(data)

Restores the model from the config.

retry_on_fallback?(arg1)

@spec retry_on_fallback?(LangChain.LangChainError.t()) :: boolean()

serialize_config(model)

@spec serialize_config(t()) :: %{required(String.t()) => any()}

Generate a config map that can later restore the model's configuration.