API Classes

These are the classes that are available in the Python SDK. Use the links below to learn more about each class.

---

AbacusApi

An Abacus API.

Address

Address object

Agent

An AI agent.

AgentChatMessage

A single chat message with Agent Chat.

AgentConversation

List of messages with Agent chat

AgentDataDocumentInfo

Information for documents uploaded to agents.

AgentDataExecutionResult

Results of agent execution with uploaded data.

AgentVersion

A version of an AI agent.

AiBuildingTask

A task for Data Science Co-pilot to help build AI.

Algorithm

Customer created algorithm

Annotation

An Annotation Store Annotation

AnnotationConfig

Annotation config for a feature group

AnnotationDocument

Document to be annotated.

AnnotationEntry

An Annotation Store entry for an Annotation

AnnotationsStatus

The status of annotations for a feature group

ApiEndpoint

An collection of endpoints which can be used to make requests to, such as api calls or predict calls

ApiKey

An API Key to authenticate requests to the Abacus.AI API

AppUserGroup

An app user group. This is used to determine which users have permissions for external chatbots.

AppUserGroupSignInToken

User Group Sign In Token

ApplicationConnector

A connector to an external service

BatchPrediction

Make batch predictions.

BatchPredictionVersion

Batch Prediction Version

BatchPredictionVersionLogs

Logs from batch prediction version.

BotInfo

Information about an external application and LLM.

CategoricalRangeViolation

Summary of important range mismatches for a numerical feature discovered by a model monitoring instance

ChatMessage

A single chat message with Abacus Chat.

ChatSession

A chat session with Abacus Data Science Co-pilot.

ChatllmReferralInvite

The response of the Chatllm Referral Invite for different emails

CodeAutocompleteResponse

A autocomplete response from an LLM

NlpChatResponse

A chat response from an LLM

CodeEditResponse

A code edit response from an LLM

CodeSource

Code source for python-based custom feature groups and models

ComputePointInfo

The compute point info of the organization

ConcatenationConfig

Feature Group Concatenation Config

CustomChatInstructions

Custom Chat Instructions

CustomLossFunction

Custom Loss Function

CustomMetric

Custom metric.

CustomMetricVersion

Custom metric version

CustomTrainFunctionInfo

Information about how to call the customer provided train function.

DataConsistencyDuplication

Data Consistency for duplication within data

DataMetrics

Processed Metrics and Schema for a dataset version or feature group version

DataPrepLogs

Logs from data preparation.

DataQualityResults

Data Quality results from normalization stage

DataUploadResult

Results of uploading data to agent.

DatabaseColumnFeatureMapping

Mapping for export of feature group version to database column

DatabaseConnector

A connector to an external service

DatabaseConnectorColumn

A schema description for a column from a database connector

DatabaseConnectorSchema

A schema description for a table from a database connector

Dataset

A dataset reference

DatasetColumn

A schema description for a column

DatasetVersion

A specific version of a dataset

DatasetVersionLogs

Logs from dataset version.

Deployment

A model deployment

DeploymentAuthToken

A deployment authentication token that is used to authenticate prediction requests

DeploymentConversation

A deployment conversation.

DeploymentConversationEvent

A single deployment conversation message.

DeploymentConversationExport

A deployment conversation html export, to be used for downloading the conversation.

DeploymentStatistics

A set of statistics for a realtime deployment.

DocumentData

Data extracted from a docstore document.

DocumentRetriever

A vector store that stores embeddings for a list of document trunks.

DocumentRetrieverConfig

A config for document retriever creation.

DocumentRetrieverLookupResult

Result of a document retriever lookup.

DocumentRetrieverVersion

A version of document retriever.

DriftDistribution

How actuals or predicted values have changed in the training data versus predicted data

DriftDistributions

For either actuals or predicted values, how it has changed in the training data versus some specified window

Eda

A exploratory data analysis object

EdaChartDescription

Eda Chart Description.

EdaCollinearity

Eda Collinearity of the latest version of the data between all the features.

EdaDataConsistency

Eda Data Consistency, contained the duplicates in the base version, Comparison version, Deletions between the base and comparison and feature transformations between the base and comparison data.

EdaFeatureAssociation

Eda Feature Association between two features in the data.

EdaFeatureCollinearity

Eda Collinearity of the latest version of the data for a given feature.

EdaForecastingAnalysis

Eda Forecasting Analysis of the latest version of the data.

EdaVersion

A version of an eda object

EmbeddingFeatureDriftDistribution

Feature distribution for embeddings

ExecuteFeatureGroupOperation

The result of executing a SQL query

ExternalApplication

An external application.

ExternalInvite

The response of the invites for different emails

ExtractedFields

The fields extracted from a document.

Feature

A feature in a feature group

FeatureDistribution

For a single feature, how it has changed in the training data versus some specified window

FeatureDriftRecord

Value of each type of drift

FeatureDriftSummary

Summary of important model monitoring statistics for features available in a model monitoring instance

FeatureGroup

A feature group.

FeatureGroupDocument

A document of a feature group.

FeatureGroupExport

A feature Group Export Job

FeatureGroupExportConfig

Export configuration (file connector or database connector information) for feature group exports.

FeatureGroupRefreshExportConfig

A Feature Group Connector Export Config outlines the export configuration for a feature group.

FeatureGroupExportDownloadUrl

A Feature Group Export Download Url, which is used to download the feature group version

IndexingConfig

The indexing config for a Feature Group

FeatureGroupLineage

Directed acyclic graph of feature group lineage for all feature groups in a project

FeatureGroupRow

A row of a feature group.

FeatureGroupRowProcess

A feature group row process

FeatureGroupRowProcessLogs

Logs for the feature group row process.

FeatureGroupRowProcessSummary

A summary of the feature group processes for a deployment.

FeatureGroupTemplate

A template for creating feature groups.

FeatureGroupTemplateVariableOptions

Feature Group Template Variable Options

FeatureGroupVersion

A materialized version of a feature group

FeatureGroupVersionLogs

Logs from feature group version.

FeatureImportance

Feature importance for a specified model monitor

FeatureMapping

A description of the data use for a feature

FeaturePerformanceAnalysis

A feature performance analysis for Monitor

FeatureRecord

A feature record

Schema

A schema description for a feature

FileConnector

Verification result for an external storage service

FileConnectorInstructions

An object with a full description of the cloud storage bucket authentication options and bucket policy. Returns an error message if the parameters are invalid.

FileConnectorVerification

To verify the file connector

FinetunedPretrainedModel

A finetuned pretrained model

ForecastingAnalysisGraphData

Forecasting Analysis Graph Data representation.

ForecastingMonitorItemAnalysis

Forecasting Monitor Item Analysis of the latest version of the data.

ForecastingMonitorSummary

Forecasting Monitor Summary of the latest version of the data.

FunctionLogs

Logs from an invocation of a function.

GeneratedPitFeatureConfigOption

The options to display for possible generated PIT aggregation functions

GraphDashboard

A Graph Dashboard

HoldoutAnalysis

A holdout analysis object.

HoldoutAnalysisVersion

A holdout analysis version object.

HostedModelToken

A hosted model authentication token that is used to authenticate requests to an abacus hosted model

ImageGenSettings

Image generation settings

InferredDatabaseColumnToFeatureMappings

Autocomplete mappings for database to connector columns

InferredFeatureMappings

A description of the data use for a feature

ItemStatistics

ItemStatistics representation.

LlmApp

An LLM App that can be used for generation. LLM Apps are specifically crafted to help with certain tasks like code generation or question answering.

LlmCodeBlock

Parsed code block from an LLM response

LlmExecutionPreview

Preview of executing queries using LLM.

LlmExecutionResult

Results of executing queries using LLM.

LlmGeneratedCode

Code generated by LLM.

LlmInput

The result of encoding an object as input for a language model.

LlmParameters

The parameters of LLM for given inputs.

LlmResponse

The response returned by LLM

MemoryOptions

The overall memory options for executing a job

CpuGpuMemorySpecs

Includes the memory specs of the CPU/GPU

MessagingConnectorResponse

The response to view label data for Teams

Model

A model

ModelArtifactsExport

A Model Artifacts Export Job

ModelBlueprintExport

Model Blueprint

ModelBlueprintStage

A stage in the model blueprint export process.

ModelLocation

Provide location information for the plug-and-play model.

ModelMetrics

Metrics of the trained model.

ModelMonitor

A model monitor

ModelMonitorOrgSummary

A summary of an organization's model monitors

ModelMonitorSummary

A summary of model monitor

ModelMonitorSummaryFromOrg

A summary of model monitor given an organization

ModelMonitorVersion

A version of a model monitor

ModelMonitorVersionMetricData

Data for displaying model monitor version metric data

ModelTrainingTypeForDeployment

Model training types for deployment.

ModelUpload

A model version that includes the upload identifiers for the various required files.

ModelVersion

A version of a model

ModelVersionFeatureGroupSchema

Schema for a feature group used in model version

ModificationLockInfo

Information about a modification lock for a certain object

Module

Customer created python module

MonitorAlert

A Monitor Alert

MonitorAlertVersion

A monitor alert version

MonitorDriftAndDistributions

Summary of important model monitoring statistics for features available in a model monitoring instance

NaturalLanguageExplanation

Natural language explanation of an artifact/object

NestedFeature

A nested feature in a feature group

NestedFeatureSchema

A schema description for a nested feature

NewsSearchResult

A single news search result.

NotebookCompletion

The result of a notebook code completion request

NotebookTemplate

A template for notebooks.

NullViolation

Summary of anomalous null frequencies for a feature discovered by a model monitoring instance

OrganizationExternalApplicationSettings

The External Application Settings for an Organization.

OrganizationGroup

An Organization Group. Defines the permissions available to the users who are members of the group.

OrganizationSearchResult

A search result object which contains the retrieved artifact and its relevance score

OrganizationSecret

Organization secret

PageData

Data extracted from a docstore page.

Pipeline

A Pipeline For Steps.

PipelineReference

A reference to a pipeline to the objects it is run on.

PipelineStep

A step in a pipeline.

PipelineStepVersion

A version of a pipeline step.

PipelineStepVersionReference

A reference from a pipeline step version to the versions that were output from the pipeline step.

PipelineVersion

A version of a pipeline.

PipelineVersionLogs

Logs for a given pipeline version.

PlaygroundText

The text content inside of a playground segment.

PointInTimeFeature

A point-in-time feature description

PointInTimeFeatureInfo

A point-in-time infos for a feature

PointInTimeGroup

A point in time group containing point in time features

PointInTimeGroupFeature

A point in time group feature

PredictionDataset

Batch Input Datasets

PredictionFeatureGroup

Batch Input Feature Group

PredictionInput

Batch inputs

PredictionLogRecord

A Record for a prediction request log.

PredictionOperator

A prediction operator.

PredictionOperatorVersion

A prediction operator version.

ProblemType

Description of a problem type which is the common underlying problem for different use cases.

Project

A project is a container which holds datasets, models and deployments

ProjectConfig

Project-specific config for a feature group

ProjectFeatureGroup

A feature group along with project specific mappings

ProjectFeatureGroupSchema

A schema description for a project feature group

ProjectValidation

A validation result for a project

PythonFunction

Customer created python function

PythonPlotFunction

Create a Plot for a Dashboard

RangeViolation

Summary of important range mismatches for a numerical feature discovered by a model monitoring instance

RealtimeMonitor

A real-time monitor

RefreshPipelineRun

This keeps track of the overall status of a refresh. A refresh can span multiple resources such as the creation of new dataset versions and the training of a new model version based on them.

RefreshPolicy

A Refresh Policy describes the frequency at which one or more datasets/models/deployments/batch_predictions can be updated.

RefreshSchedule

A refresh schedule for an object. Defines when the next version of the object will be created

RegenerateLlmExternalApplication

An external application that specifies an LLM user can regenerate with in RouteLLM.

ResolvedFeatureGroupTemplate

Final SQL from resolving a feature group template.

RoutingAction

Routing action

ProjectFeatureGroupSchemaVersion

A version of a schema

PipelineStepVersionLogs

Logs for a given pipeline step version.

StreamingAuthToken

A streaming authentication token that is used to authenticate requests to append data to streaming datasets

StreamingConnector

A connector to an external service

StreamingRowCount

Returns the number of rows in a streaming feature group from the specified time

StreamingSampleCode

Sample code for adding to a streaming feature group with examples from different locations.

TemplateNodeDetails

Details about WorkflowGraphNode object and notebook code for adding template nodes in workflow.

TestPointPredictions

Test Point Predictions

ToneDetails

Tone details for audio

TrainingConfigOptions

Training options for a model

TwitterSearchResult

A single twitter search result.

Upload

A Upload Reference for uploading file parts

UploadPart

Unique identifiers for a part

UseCase

A Project Use Case

UseCaseRequirements

Use Case Requirements

User

An Abacus.AI User

UserException

Exception information for errors in usercode.

VideoGenSettings

Video generation settings

VideoSearchResult

A single video search result.

WebSearchResponse

Result of running a web search with optional content fetching.

WebSearchResult

A single search result.

Webhook

A Abacus.AI Webhook attached to an endpoint and event trigger for a given object.

WorkflowNodeTemplate

A workflow node template.