View module source on GitHub

FunctionCall

@dataclass
class FunctionCall()
This class represents a function call.

ToolCall

@dataclass
class ToolCall()
This class represents a tool call.

Message

@dataclass
class Message()
This class represents a message of a LLM response choice.

Choice

@dataclass
class Choice()
This class represents a choice of a LLM response.

Usage

@dataclass
class Usage()
This class represents the usage of a LLM response.

PromptResponse

@dataclass
class PromptResponse()
This class represents a response of a prompt.

ImageURL

class ImageURL(TypedDict)
This class represents an image URL.

ChatCompletionMessageImageContent

class ChatCompletionMessageImageContent(TypedDict)
This class represents an image content of a chat completion message.

ChatCompletionMessageTextContent

class ChatCompletionMessageTextContent(TypedDict)
This class represents a text content of a chat completion message.

ChatCompletionMessage

class ChatCompletionMessage(TypedDict)
This class represents a chat completion message.

Function

class Function(TypedDict)
This class represents a function.

Tool

class Tool(TypedDict)
This class represents a tool.

ImageUrls

class ImageUrls(TypedDict)
This class represents an image URLs.

Prompt

@dataclass
class Prompt()
This class represents a prompt.

RuleType

@dataclass
class RuleType()
This class represents a rule type.

value

adding None here

RuleGroupType

@dataclass
class RuleGroupType()
This class represents a rule group type.

PromptDeploymentRules

@dataclass
class PromptDeploymentRules()
This class represents the deployment rules of a prompt.

VersionSpecificDeploymentConfig

@dataclass
class VersionSpecificDeploymentConfig()
This class represents the deployment rules of a prompt version.

PromptVersionConfig

@dataclass
class PromptVersionConfig()
This class represents the config of a prompt version.

PromptVersion

@dataclass
class PromptVersion()
This class represents a prompt version.

VersionsAndRules

@dataclass
class VersionsAndRules()
This class represents the versions and rules of a prompt.

VersionAndRulesWithPromptId

@dataclass
class VersionAndRulesWithPromptId(VersionsAndRules)
This class represents the versions and rules of a prompt with a prompt id.

VersionAndRulesWithPromptIdEncoder

class VersionAndRulesWithPromptIdEncoder(json.JSONEncoder)
This class represents a JSON encoder for VersionAndRulesWithPromptId.

Error

@dataclass
class Error()
This class represents an error from Prompt.

PromptData

@dataclass
class PromptData()
This class represents the data of a prompt.

MaximApiPromptResponse

@dataclass
class MaximApiPromptResponse()
This class represents the response of a prompt.

MaximApiPromptsResponse

@dataclass
class MaximApiPromptsResponse()
This class represents the response of a prompts.

MaximAPIResponse

@dataclass
class MaximAPIResponse()
This class represents the response of a Maxim API.