Utilities

Arthur helps enterprise teams optimize model operations and performance at scale. The Arthur API tracks model performance, explainability, and fairness

Class

UserContextManager

Context manager for LLMonitor user context.

Class

LLMonitorCallbackHandler

Callback Handler for LLMonitor`.

Parameters:

- `app_id`: The app id of the app you want to report to. Defaults to
`None`, which means that `LLMONITOR_APP_ID` will be used.
- `api_url

Class

InfinoCallbackHandler

Callback Handler that logs to Infino.

Class

ArgillaCallbackHandler

Callback Handler that logs into Argilla.

Class

DeepEvalCallbackHandler

Callback Handler that logs into deepeval.

Class

TrubricsCallbackHandler

Callback handler for Trubrics.

Class

WandbCallbackHandler

Callback Handler that logs to Weights and Biases.

Class

WhyLabsCallbackHandler

Callback Handler for logging to WhyLabs. This callback handler utilizes langkit to extract features from the prompts & responses when interacting with an LLM. These features can be used to guardrail

Class

LLMThoughtState

Enumerator of the LLMThought state.

Class

ToolRecord

Tool record as a NamedTuple.

Class

LLMThoughtLabeler

Generates markdown labels for LLMThought containers. Pass a custom subclass of this to StreamlitCallbackHandler to override its default labeling logic.

Class

LLMThought

A thought in the LLM's thought stream.

Class

StreamlitCallbackHandler

Callback handler that writes to a Streamlit app.

Class

ChildType

Enumerator of the child type.

Class

ChildRecord

Child record as a NamedTuple.

Class

MutableExpander

Streamlit expander that can be renamed and dynamically expanded/collapsed.

Class

CometTracer

Comet Tracer.

Class

WandbRunArgs

Arguments for the WandbTracer.

Class

WandbTracer

Callback Handler that logs to Weights and Biases.

This handler will log the model architecture and run traces to Weights and Biases. This will ensure that all LangChain activity is logged to W&B.

Class

LLMRequestsChain

Chain that requests a URL and then uses an LLM to parse results.

Security Note: This chain can make GET requests to arbitrary URLs, including internal URLs.

Control access to who can run

Class

APIResponderOutputParser

Parse the response and error tags.

Class

APIResponderChain

Get the response parser.

Class

APIRequesterOutputParser

Parse the request and error tags.

Class

APIRequesterChain

Get the request parser.

Class

OpenAPIEndpointChain

Chain interacts with an OpenAPI endpoint using natural language.

Class

OntotextGraphDBQAChain

Question-answering against Ontotext GraphDB https://graphdb.ontotext.com/ by generating SPARQL queries.

Security note: Make sure that the database connection uses credentials that are narrow

Class

KuzuQAChain

Question-answering against a graph by generating Cypher statements for Kùzu.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include nece

Class

MemgraphQAChain

Chain for question-answering against a graph by generating Cypher statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include nec

Class

HugeGraphQAChain

Chain for question-answering against a graph by generating gremlin statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include ne

Class

GremlinQAChain

Chain for question-answering against a graph by generating gremlin statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include ne

Class

NebulaGraphQAChain

Chain for question-answering against a graph by generating nGQL statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include neces

Class

GraphSparqlQAChain

Question-answering against an RDF or OWL graph by generating SPARQL statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include n

Class

FalkorDBQAChain

Chain for question-answering against a graph by generating Cypher statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include nec

Class

ArangoGraphQAChain

Chain for question-answering against a graph by generating AQL statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include necess

Class

GraphQAChain

Chain for question-answering against a graph.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include necessary permissions. Failure

Class

Routes

Routes available for the Pebblo API as enumerator.

Class

PebbloRetrievalAPIWrapper

Wrapper for Pebblo Retrieval API.

Class

AuthContext

Class for an authorization context.

Class

SemanticEntities

Class for a semantic entity filter.

Class

SemanticTopics

Class for a semantic topic filter.

Class

SemanticContext

Class for a semantic context.

Class

ChainInput

Input for PebbloRetrievalQA chain.

Class

Runtime

OS, language details

Class

Framework

Langchain framework details

Class

PebbloRetrievalQA

Retrieval Chain with Identity & Semantic Enforcement for question-answering against a vector database.

Class

SearxResults

Dict like wrapper around search api results.

Class

SearxSearchWrapper

Wrapper for Searx API.

To use you need to provide the searx host by passing the named parameter searx_host or exporting the environment variable SEARX_HOST.

In some situations you might want

Class

TensorflowDatasets

Access to the TensorFlow Datasets.

The Current implementation can work only with datasets that fit in a memory.

TensorFlow Datasets is a collection of datasets ready to use, with TensorFlow or oth

Class

AskNewsAPIWrapper

Wrapper for AskNews API.

Class

DallEAPIWrapper

Wrapper for OpenAI's DALL-E Image Generator.

https://platform.openai.com/docs/guides/images/generations?context=node

Usage instructions:

pip install openai
save your OPENAI_API_KEY in an en

Class

LambdaWrapper

Wrapper for AWS Lambda SDK. To use, you should have the boto3 package installed and a lambda functions built from the AWS Console or CLI. Set up your AWS credentials with aws configure

Class

GoogleSerperAPIWrapper

Wrapper around the Serper.dev Google Search API.

You can create a free API key at https://serper.dev.

To use, you should have the environment variable SERPER_API_KEY set with your API key, or pa

Class

YouHitMetadata

Metadata on a single hit from you.com

Class

YouHit

A single hit from you.com, which may contain multiple snippets

Class

YouAPIOutput

Output from you.com API.

Class

YouDocument

Output of parsing one snippet.

Class

YouSearchAPIWrapper

Wrapper for you.com Search and News API.

To connect to the You.com api requires an API key which you can get at https://api.you.com. You can check out the docs at https://documentation.you.com/api-re

Class

Routes

Routes available for the Pebblo API as enumerator.

Class

IndexedDocument

Pebblo Indexed Document.

Class

Runtime

Pebblo Runtime.

Class

Framework

Pebblo Framework instance.

Class

App

Pebblo AI application.

Class

Doc

Pebblo document.

Class

PebbloLoaderAPIWrapper

Wrapper for Pebblo Loader API.

Class

DuckDuckGoSearchAPIWrapper

Wrapper for DuckDuckGo Search API.

Free and does not require any setup.

Class

AlphaVantageAPIWrapper

Wrapper for AlphaVantage API for Currency Exchange Rate.

Docs for using:

Go to AlphaVantage and sign up for an API key
Save your API KEY into ALPHAVANTAGE_API_KEY env variable

Class

Component

Base class for all components.

Class

Task

Class for a task.

Class

CUList

Component class for a list.

Class

Member

Component class for a member.

Class

Team

Component class for a team.

Class

Space

Component class for a space.

Class

ClickupAPIWrapper

Wrapper for Clickup API.

Class

SetupMode

Class

GooglePlacesAPIWrapper

Wrapper around Google Places API.

Searches for places using Google Maps Platform. Returns detailed information including addresses, phone numbers, and websites.

Installation

Requires

Class

RedditSearchAPIWrapper

Wrapper for Reddit API

To use, set the environment variables REDDIT_CLIENT_ID, REDDIT_CLIENT_SECRET, REDDIT_USER_AGENT to set the client ID, client secret, and user agent, respectively, a

Class

GoogleTrendsAPIWrapper

Wrapper for SerpApi's Google Scholar API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the SerpApi.com python package: https://serpapi.com/inte

Class

NasaAPIWrapper

Wrapper for NASA API.

Class

SemanticScholarAPIWrapper

Wrapper around semanticscholar.org API. https://github.com/danielnsilva/semanticscholar

You should have this library installed.

pip install semanticscholar

Semantic Scholar API can conduct search

Class

DriaAPIWrapper

Wrapper around Dria API.

This wrapper facilitates interactions with Dria's vector search and retrieval services, including creating knowledge bases, inserting data, and fetching search results.

Class

JinaSearchAPIWrapper

Wrapper around the Jina search engine.

Class

Portkey

Portkey configuration.

Class

TavilySearchAPIWrapper

Wrapper for Tavily Search API.

Class

Requests

Wrapper around requests to handle auth and async.

The main purpose of this wrapper is to handle authentication (by saving headers) and enable easy async methods on the same base object.

Class

GenericRequestsWrapper

Lightweight wrapper around requests library.

Class

JsonRequestsWrapper

Lightweight wrapper around requests library, with async support.

The main purpose of this wrapper is to always return a json output.

Class

TextRequestsWrapper

Lightweight wrapper around requests library, with async support.

The main purpose of this wrapper is to always return a text output.

Class

GitLabAPIWrapper

Wrapper for GitLab API.

Class

RememberizerAPIWrapper

Wrapper for Rememberizer APIs.

Class

ZapierNLAWrapper

Wrapper for Zapier NLA.

Full docs here: https://nla.zapier.com/start/

This wrapper supports both API Key and OAuth Credential auth methods. API Key is the fastest way to get started using this wrapp

Class

GoogleBooksAPIWrapper

Wrapper around Google Books API.

To use, you should have a Google Books API key available. This wrapper will use the Google Books API to conduct searches and fetch books based on a query passed in by

Class

MerriamWebsterAPIWrapper

Wrapper for Merriam-Webster.

Docs for using:

Go to https://www.dictionaryapi.com/register/index and register an developer account with a key for the Collegiate Dictionary
Get your API Key f

Class

HiddenPrints

Context manager to hide prints.

Class

SerpAPIWrapper

Wrapper around SerpAPI.

To use, you should have the google-search-results python package installed, and the environment variable SERPAPI_API_KEY set with your API key, or pass `serpapi_api_ke

Class

ArxivAPIWrapper

Wrapper around ArxivAPI.

To use, you should have the arxiv python package installed. https://lukasschwab.me/arxiv.py/index.html This wrapper will use the Arxiv API to conduct searches and fetch d

Class

BibtexparserWrapper

Wrapper around bibtexparser.

To use, you should have the bibtexparser python package installed. https://bibtexparser.readthedocs.io/en/master/

This wrapper will use bibtexparser to load a collec

Class

TwilioAPIWrapper

Messaging Client using Twilio.

To use, you should have the twilio python package installed, and the environment variables TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN, and TWILIO_FROM_NUMBER

Class

JiraOauth2Token

Jira OAuth2 token.

Class

JiraOauth2

Jira OAuth2.

Class

JiraAPIWrapper

Wrapper for Jira API. You can connect to Jira with either an API token or OAuth2.

with API token, you need to provide the JIRA_USERNAME and JIRA_API_TOKEN environment variables or arguments. ex:

Class

PowerBIDataset

Create PowerBI engine from dataset ID and credential or token.

Use either the credential or a supplied token to authenticate. If both are supplied the credential is used to generate a token. The impe

Class

FinancialDatasetsAPIWrapper

Wrapper for financial datasets API.

Class

GoogleJobsAPIWrapper

Wrapper for SerpApi's Google Scholar API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up. The wrapper uses the SerpApi.com python package: https://serpapi.com/integ

Class

GraphQLAPIWrapper

Wrapper around GraphQL API.

To use, you should have the gql python package installed. This wrapper will use the GraphQL API to conduct queries.

Class

BingSearchAPIWrapper

Wrapper for Bing Web Search API.

Class

MaxComputeAPIWrapper

Interface for querying Alibaba Cloud MaxCompute tables.

Class

SteamWebAPIWrapper

Wrapper for Steam API.

Class

SQLDatabase

SQLAlchemy wrapper around a database.

Class

OpenWeatherMapAPIWrapper

Wrapper for OpenWeatherMap API using PyOWM.

Docs for using:

Go to OpenWeatherMap and sign up for an API key
Save your API KEY into OPENWEATHERMAP_API_KEY env variable
pip install pyowm

Class

SearchApiAPIWrapper

Wrapper around SearchApi API.

To use, you should have the environment variable SEARCHAPI_API_KEY set with your API key, or pass searchapi_api_key as a named parameter to the constructor.

Class

MojeekSearchAPIWrapper

Class

HTTPVerb

Enumerator of the HTTP verbs.

Class

OpenAPISpec

OpenAPI Model that removes mis-formatted parts of the spec.

Class

StackExchangeAPIWrapper

Wrapper for Stack Exchange API.

Class

PolygonAPIWrapper

Wrapper for Polygon API.

Class

CassandraDatabase

Apache Cassandra® database wrapper.

Class

DatabaseError

Exception raised for errors in the database schema.

Class

Table

Class

SparkSQL

SparkSQL is a utility class for interacting with Spark SQL.

Class

NoDiskStorage

Mixin to prevent storing on disk.

Class

ManagedPassioLifeAuth

Manage the token for the NutritionAI API.

Class

NutritionAIAPI

Wrapper for the Passio Nutrition AI API.

Class

SceneXplainAPIWrapper

Wrapper for SceneXplain API.

In order to set this up, you need API key for the SceneXplain API. You can obtain a key by following the steps below.

Class

SentinelT

An empty Sentinel type.

Class

RivaAudioEncoding

An enum of the possible choices for Riva audio encoding.

The list of types exposed by the Riva GRPC Protobuf files can be found with the following commands:

import riva.client
print(riva.cl

Class

RivaAuthMixin

Configuration for the authentication to a Riva service connection.

Class

RivaCommonConfigMixin

A collection of common Riva settings.

Class

AudioStream

A message containing streaming audio.

Class

RivaASR

A runnable that performs Automatic Speech Recognition (ASR) using NVIDIA Riva.

Class

RivaTTS

A runnable that performs Text-to-Speech (TTS) with NVIDIA Riva.

Class

WolframAlphaAPIWrapper

Wrapper for Wolfram Alpha.

Docs for using:

Go to wolfram alpha and sign up for a developer account
Create an app and get your APP ID
Save your APP ID into WOLFRAM_ALPHA_APPID env variable 4

Class

GoogleScholarAPIWrapper

Wrapper for Google Scholar API

You can create serpapi key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the serpapi python package: https://serpapi.com/integrations/python#se

Class

GoldenQueryAPIWrapper

Wrapper for Golden.

Docs for using:

Go to https://golden.com and sign up for an account
Get your API Key from https://golden.com/settings/api
Save your API Key into GOLDEN_API_KEY env varia

Class

InfobipAPIWrapper

Wrapper for Infobip API for messaging.

Class

GoogleLensAPIWrapper

Wrapper for SerpApi's Google Lens API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up.

The wrapper uses the SerpApi.com python package: https://serpapi.com/integra

Class

WikidataAPIWrapper

Wrapper around the Wikidata API.

To use, you should have the wikibase-rest-api-client and mediawikiapi python packages installed. This wrapper will use the Wikibase APIs to conduct searches

Class

MetaphorSearchAPIWrapper

Wrapper for Metaphor Search API.

Class

OutlineAPIWrapper

Wrapper around OutlineAPI.

This wrapper will use the Outline API to query the documents of your instance. By default it will return the document content of the top-k results. It limits the document c

Class

TokenEscaper

Escape punctuation within an input string.

Class

WikipediaAPIWrapper

Wrapper around WikipediaAPI.

To use, you should have the wikipedia python package installed. This wrapper will use the Wikipedia API to conduct searches and fetch page summaries. By default, it w

Class

GoogleFinanceAPIWrapper

Wrapper for SerpApi's Google Finance API

You can create SerpApi.com key by signing up at: https://serpapi.com/users/sign_up. The wrapper uses the SerpApi.com python package: https://serpapi.com/integ

Class

PubMedAPIWrapper

Wrapper around PubMed API.

This wrapper will use the PubMed API to conduct searches and fetch document summaries. By default, it will return the document summaries of the top-k results of an input se

Class

SetupMode

Setup mode for AstraDBEnvironment as enumerator.

Class

ArceeRoute

Routes available for the Arcee API as enumerator.

Class

DALMFilterType

Filter types available for a DALM retrieval as enumerator.

Class

DALMFilter

Filters available for a DALM retrieval and generation.

Class

ArceeDocumentSource

Source of an Arcee document.

Class

ArceeDocument

Arcee document.

Class

ArceeDocumentAdapter

Adapter for Arcee documents

Class

ArceeWrapper

Wrapper for Arcee API.

For more details, see: https://www.arcee.ai/

Class

BraveSearchWrapper

Wrapper around the Brave search engine.

Class

DataheraldAPIWrapper

Wrapper for Dataherald.

Docs for using:

Go to dataherald and sign up
Create an API key
Save your API key into DATAHERALD_API_KEY env variable
pip install dataherald

Class

DataForSeoAPIWrapper

Wrapper around the DataForSeo API.

Class

GitHubAPIWrapper

Wrapper for GitHub API.

Class

FunctionDescription

Representation of a callable function to the Ernie API.

Class

ToolDescription

Representation of a callable function to the Ernie API.

Class

GuardrailsOutputParser

Parse the output of an LLM call using Guardrails.

Class

OutputFunctionsParser

Parse an output that is one of sets of values.

Class

JsonOutputFunctionsParser

Parse an output as the Json object.

Class

JsonKeyOutputFunctionsParser

Parse an output as the element of the Json object.

Class

PydanticOutputFunctionsParser

Parse an output as a pydantic object.

Class

PydanticAttrOutputFunctionsParser

Parse an output as an attribute of a pydantic object.

Class

DatabricksVectorSearchTranslator

Translate Databricks vector search internal query language elements to valid filters.

Class

MongoDBAtlasTranslator

Translate Mongo internal query language elements to valid filters.

Class

ElasticsearchTranslator

Translate Elasticsearch internal query language elements to valid filters.

Class

DashvectorTranslator

Logic for converting internal query language elements to valid filters.

Class

ChromaTranslator

Translate Chroma internal query language elements to valid filters.

Class

QdrantTranslator

Translate Qdrant internal query language elements to valid filters.

Class

SupabaseVectorTranslator

Translate Langchain filters to Supabase PostgREST filters.

Class

PineconeTranslator

Translate Pinecone internal query language elements to valid filters.

Class

WeaviateTranslator

Translate Weaviate internal query language elements to valid filters.

Class

VectaraTranslator

Translate Vectara internal query language elements to valid filters.

Class

DingoDBTranslator

Translate DingoDB internal query language elements to valid filters.

Class

MyScaleTranslator

Translate MyScale internal query language elements to valid filters.

Class

PGVectorTranslator

Translate PGVector internal query language elements to valid filters.

Class

TimescaleVectorTranslator

Translate the internal query language elements to valid filters.

Class

OpenSearchTranslator

Translate OpenSearch internal query domain-specific language elements to valid filters.

Class

RedisTranslator

Visitor for translating structured queries to Redis filter expressions.

Class

MilvusTranslator

Translate Milvus internal query language elements to valid filters.

Class

TencentVectorDBTranslator

Translate StructuredQuery to Tencent VectorDB query.

Class

DeepLakeTranslator

Translate DeepLake internal query language elements to valid filters.

Class

AstraDBTranslator

Translate AstraDB internal query language elements to valid filters.

Class

FakeCrossEncoder

Fake cross encoder model.

Class

CrossEncoderContentHandler

Content handler for CrossEncoder class.

Class

SagemakerEndpointCrossEncoder

SageMaker Inference CrossEncoder endpoint.

To use, you must supply the endpoint name from your deployed Sagemaker model & the region where it is deployed.

To authenticate, the AWS client uses the fo

Class

HuggingFaceCrossEncoder

HuggingFace cross encoder models.

Class

IndexableBaseModel

Allows a BaseModel to return its fields by string variable indexing.

Class

Choice

Choice.

Class

ChatCompletions

Chat completions.

Class

ChoiceChunk

Choice chunk.

Class

ChatCompletionChunk

Chat completion chunk.

Class

ChatCompletion

Chat completion.

Class

Completions

Completions.

Class

Chat

Chat.

Class

UpsertionRecord

Table used to keep track of when a key was last updated.

Class

SQLRecordManager

A SQL Alchemy based implementation of the record manager.

Class

MongoDocumentManager

A MongoDB based implementation of the document manager.

Class

RecordManager

Abstract base class for a record manager.

Class

NGramOverlapExampleSelector

Select and order examples based on ngram overlap score (sentence_bleu score from NLTK package).

https://www.nltk.org/_modules/nltk/translate/bleu_score.html https://aclanthology.org/P02-1040.pdf

Class

InMemoryDocstore

Simple in memory docstore in the form of a dict.

Class

DocstoreFn

Docstore via arbitrary lookup function.

Class

Wikipedia

Wikipedia API.

Class

Docstore

Interface to access to place that stores documents.

Class

AddableMixin

Mixin class that supports adding texts.

Class

CassandraByteStore

A ByteStore implementation using Cassandra as the backend.

Class

MongoDBByteStore

BaseStore implementation using MongoDB as the underlying store.

Class

MongoDBStore

BaseStore implementation using MongoDB as the underlying store.

Class

UpstashRedisByteStore

BaseStore implementation using Upstash Redis as the underlying store to store raw bytes.

Class

LangchainKeyValueStores

Table used to save values.

Class

SQLStore

BaseStore interface that works on an SQL database.

Class

RedisStore

BaseStore implementation using Redis as the underlying store.

Class

AstraDBBaseStore

Base class for the DataStax AstraDB data store.

Class

GraphCypherQAChain

deprecated

Chain for question-answering against a graph by generating Cypher statements.

Security note: Make sure that the database connection uses credentials that are narrowly-scoped to only include nec

Class

CypherQueryCorrector

deprecated

Used to correct relationship direction in generated Cypher statements. This code is copied from the winner's submission to the Cypher competition: https://github.com/sakusaku-rich/cypher-direction-com

Class

GoogleSearchAPIWrapper

deprecated

Wrapper for Google Search API.

Adapted from: Instructions adapted from https://stackoverflow.com/questions/ 37083058/ programmatically-searching-google-in-python-using-custom-search

TODO: DOCS for u

Class

ApifyWrapper

deprecated

Wrapper around Apify. To use, you should have the apify-client python package installed, and the environment variable APIFY_API_TOKEN set with your API key, or pass apify_api_token as a name

Class

HanaTranslator

deprecated

DEPRECATED: This class is deprecated and will no longer be maintained. Please use query_constructors.HanaTranslator from the langchain_hana package instead. It offers an improved implementation an

Class

Neo4jTranslator

deprecated

Translate Neo4j internal query language elements to valid filters.

Class

UpstashRedisStore

deprecated

BaseStore implementation using Upstash Redis as the underlying store to store strings.

Deprecated in favor of the more generic UpstashRedisByteStore.

Class

AstraDBStore

deprecated

Class

AstraDBByteStore

deprecated

Functions

Function

import_fiddler

Import the fiddler python package and raise an error if it is not installed.

Function

get_default_label_configs

Get default Label Studio configs for the given mode.

Function

import_flytekit

Import flytekit and flytekitplugins-deck-standard.

Function

analyze_text

Analyze text using textstat and spacy.

Function

import_context

Import the getcontext package.

Function

import_spacy

Import the spacy python package and raise an error if it is not installed.

Function

import_pandas

Import the pandas python package and raise an error if it is not installed.

Function

import_textstat

Import the textstat python package and raise an error if it is not installed.

Function

flatten_dict

Flatten a nested dictionary into a flat dictionary.

Function

hash_string

Hash a string using sha1.

Function

load_json

Load json file to a string.

Function

import_mlflow

Import the mlflow python package and raise an error if it is not installed.

Function

mlflow_callback_metrics

Get the metrics to log to MLFlow.

Function

get_text_complexity_metrics

Get the text complexity metrics from textstat.

Function

analyze_text

Analyze text using textstat and spacy.

Function

construct_html_from_prompt_and_generation

Construct an html element from a prompt and a generation.

Function

standardize_model_name

Standardize the model name to a format that can be used in the OpenAI API.

Function

get_openai_token_cost_for_model

Get the cost in USD for a given model and number of tokens.

Function

import_clearml

Import the clearml python package and raise an error if it is not installed.

Function

save_json

Save dict to local file path.

Function

import_uptrain

Import the uptrain package.

Function

import_comet_ml

Import comet_ml and raise an error if it is not installed.

Function

import_aim

Import the aim python package and raise an error if it is not installed.

Function

identify

Builds an LLMonitor UserContextManager

Function

import_infino

Import the infino client.

Function

import_tiktoken

Import tiktoken for counting tokens for OpenAI models.

Function

get_num_tokens

Calculate num tokens for OpenAI with tiktoken package.

Function

get_openai_callback

Get the OpenAI callback handler in a context manager. which conveniently exposes token and cost information.

Function

get_bedrock_anthropic_callback

Get the Bedrock anthropic callback handler in a context manager. which conveniently exposes token and cost information.

Function

wandb_tracing_enabled

Get the WandbTracer in a context manager.

Function

import_wandb

Import the wandb python package and raise an error if it is not installed.

Function

load_json_to_dict

Load json file to a dictionary.

Function

analyze_text

Analyze text using textstat and spacy.

Function

construct_html_from_prompt_and_generation

Construct an html element from a prompt and a generation.

Function

import_langkit

Import the langkit python package and raise an error if it is not installed.

Function

StreamlitCallbackHandler

Callback Handler that writes to a Streamlit app.

This CallbackHandler is geared towards use with a LangChain Agent; it displays the Agent's LLM and tool-usage "thoughts" inside a series of Streamlit

Function

import_comet_llm_api

Import comet_llm api and raise an error if it is not installed.

Function

flatten_run

Utility to flatten a nest run object into a list of runs. :param run: The base run to flatten. :return: The flattened list of runs.

Function

truncate_run_iterative

Utility to truncate a list of runs dictionaries to only keep the specified keys in each run. :param runs: The list of runs to truncate. :param keep_keys: The keys to keep in each run. :return: The

Function

modify_serialized_iterative

Utility to modify the serialized field of a list of runs dictionaries. removes any keys that match the exact_keys and any keys that contain any of the partial_keys. recursively moves the dictionaries

Function

build_tree

Builds a nested dictionary from a list of runs. :param runs: The list of runs to build the tree from. :return: The nested dictionary representing the langchain Run in a tree structure compatible w

Function

remove_prefix

Remove a prefix from a text.

Function

extract_cypher

Extract Cypher code from a text.

Function

extract_cypher

Extract Cypher code from a text.

Function

get_function_response

Function

extract_gremlin

Extract Gremlin code from a text.

Function

extract_sparql

Extract SPARQL code from a text.

Function

extract_cypher

Extract Cypher code from a text. Args: text: Text to extract Cypher code from.

Function

trim_query

Trim the query to only include Cypher keywords.

Function

use_simple_prompt

Decides whether to use the simple prompt

Function

get_runtime

Fetch the current Framework and Runtime details.

Function

get_ip

Fetch local runtime ip address.

Function

clear_enforcement_filters

Clear the identity and semantic enforcement filters in the retriever search_kwargs.

Function

set_enforcement_filters

Set identity and semantic enforcement filters in the retriever.

Function

convert_python_function_to_ernie_function

Convert a Python function to an Ernie function-calling API compatible dict.

Assumes the Python function has type hints and a docstring with a description. If the docstring has Google Python style

Function

convert_to_ernie_function

Convert a raw function/class to an Ernie function.

Function

get_ernie_output_parser

Get the appropriate function output parser given the user functions.

Function

create_ernie_fn_runnable

Create a runnable sequence that uses Ernie functions.

Function

create_structured_output_runnable

Create a runnable that uses an Ernie function to get a structured output.

Function

create_ernie_fn_chain

[Legacy] Create an LLM chain that uses Ernie functions.

Menu

Utilities

Classes

FiddlerCallbackHandler

PromptLayerCallbackHandler

UpstashRatelimitError

UpstashRatelimitHandler

LabelStudioMode

LabelStudioCallbackHandler

FlyteCallbackHandler

ContextCallbackHandler

BedrockAnthropicTokenUsageCallbackHandler

BaseMetadataCallbackHandler

MlflowLogger

MlflowCallbackHandler

TokenType

OpenAICallbackHandler

ClearMLCallbackHandler

SageMakerCallbackHandler

UpTrainDataSchema

UpTrainCallbackHandler

ArizeCallbackHandler

HumanRejectedException

HumanApprovalCallbackHandler

AsyncHumanApprovalCallbackHandler

CometCallbackHandler

BaseMetadataCallbackHandler

AimCallbackHandler

ArthurCallbackHandler

UserContextManager

LLMonitorCallbackHandler

InfinoCallbackHandler

ArgillaCallbackHandler

DeepEvalCallbackHandler

TrubricsCallbackHandler

WandbCallbackHandler

WhyLabsCallbackHandler

LLMThoughtState

ToolRecord

LLMThoughtLabeler

LLMThought

StreamlitCallbackHandler

ChildType

ChildRecord

MutableExpander

CometTracer

WandbRunArgs

WandbTracer

LLMRequestsChain

APIResponderOutputParser

APIResponderChain

APIRequesterOutputParser

APIRequesterChain

OpenAPIEndpointChain

OntotextGraphDBQAChain

KuzuQAChain

MemgraphQAChain

HugeGraphQAChain

GremlinQAChain

NebulaGraphQAChain

GraphSparqlQAChain

FalkorDBQAChain

ArangoGraphQAChain

GraphQAChain

Routes

PebbloRetrievalAPIWrapper

AuthContext

SemanticEntities

SemanticTopics

SemanticContext

ChainInput

Runtime

Framework

Model

PkgInfo

VectorDB

ChainInfo

App

Context

Prompt