Briyah SDK - v2.0.18
Briyah
npm
Preparing search index...
Briyah SDK - v2.0.18
Enumerations
MessageAction
Classes
Agent
Briyah
BriyahConfigService
InsufficientBalanceError
NativeToolRegistry
PackInstantiationService
PackService
Room
RoomMessage
UnsupportedDocumentError
Interfaces
AgentCreationOptions
AgentInfo
AgentMessagesResponse
AllowanceState
AppService
Artifact
ArtifactMetadata
ArtifactWriteOptions
AttachDocumentResponse
BriyahConfigOptions
ChapterInfo
Character
ChartSeries
ChartSpec
ChunkablePage
ChunkOptions
ConversionAgent
ConvertedDocumentPage
CreateAgentResponse
CreateRoomResponse
CreateStoryResponse
CreditSummary
DataField
DataFilter
DataHaving
DataMetric
DataOrder
DataQuery
DataResult
DataSet
DataSource
DocumentChunk
DocumentHit
DocumentMarkdownOptions
DocumentMarkdownResult
DocumentPage
DocumentPages
DocumentSearchRequest
DocumentSource
DocumentSummary
DocumentText
DocumentTypeDetection
EmbeddingOptions
EmbeddingProvider
EmbeddingResult
FileList
FileMetadata
IConfigService
InstantiateModels
InstantiateRoomResult
LoadedPack
LocalConversionOptions
LocalDocumentConversion
LoggingOptions
Message
ModelChoice
ModelInfo
NativeToolDefinition
PackAgentTemplate
PackRoomTemplate
PackView
PageRange
PdfConversionOptions
PdfConversionResult
PdfMarkdownOptions
PdfMarkdownResult
PdfPageMarkdown
PreparedPromptResponse
ProcessTextResponse
PromptFile
PromptFileContent
PromptFilesResponse
PromptFolder
PromptFolderDefaults
PromptFolderDefaultsResponse
PromptFoldersResponse
RoomDetails
RoomErrorUpdate
RoomInfo
RoomMessagesResponse
RoomMessageUpdate
SendMessageResult
StoryErrorEvent
StoryIdea
StoryInfo
StoryIntroduceCharacterEvent
StoryProgressChapterEvent
StoryState
StoryStateEvent
ToolAgentDocuments
ToolArtifact
ToolCaller
ToolDefinition
ToolHeldDocument
ToolHelpers
ToolPackDocuments
ToolParameter
ToolRoomAccess
ToolsResponse
ToolSummary
Transaction
TransactionHistoryResponse
UsageEntry
UsageReport
UsageSource
UsageTags
UsageTotal
Type Aliases
AttachmentImageType
ChartType
ChartValidation
ChartValueFormat
DataAggregateFn
DataFieldType
DataFilterOp
DataRow
DocumentFileType
ImageAspect
PackOrigin
PromptScope
RoomTurnMode
RoomUpdate
RosterOverrides
ToolContext
ToolRunResult
Variables
ATTACHMENT_IMAGE_TYPES
CHART_BLOCK_LANGUAGE
CHART_TYPES
DEFAULT_CHUNK_MAX_CHARS
DEFAULT_CHUNK_OVERLAP_CHARS
DEFAULT_EMBEDDING_MODEL
DEFAULT_ROW_LIMIT
EMBEDDING_DIMENSIONS
MAX_ATTACHED_IMAGE_BYTES
MAX_ROW_LIMIT
Functions
availableToolPacks
buildDataGuideMarkdown
buildDocumentGuideMarkdown
buildMarkdown
chunkPages
convertLocalDocument
currentUsageTags
detectAttachmentMimeType
detectDocumentType
dnd5eTools
embeddingInput
embedTexts
formatChartValue
installToolPacks
insufficientBalanceMessage
isAttachmentImage
isLibraryAttachment
libraryAttachmentName
libraryDocumentIdOf
listDatasets
listDataSources
listDocumentSources
pageMarker
queryRows
registerDataSource
registerDocumentSource
registerToolPacks
renderChartSvg
runWithUsageTags
setInsufficientBalanceMessage
splitMarkdownIntoPages
stripWrappingFence
unregisterDataSource
unregisterDocumentSource
updateUsageTags
validateChart
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Enumerations
Message
Action
Classes
Agent
Briyah
Briyah
Config
Service
Insufficient
Balance
Error
Native
Tool
Registry
Pack
Instantiation
Service
Pack
Service
Room
Room
Message
Unsupported
Document
Error
Interfaces
Agent
Creation
Options
Agent
Info
Agent
Messages
Response
Allowance
State
App
Service
Artifact
Artifact
Metadata
Artifact
Write
Options
Attach
Document
Response
Briyah
Config
Options
Chapter
Info
Character
Chart
Series
Chart
Spec
Chunkable
Page
Chunk
Options
Conversion
Agent
Converted
Document
Page
Create
Agent
Response
Create
Room
Response
Create
Story
Response
Credit
Summary
Data
Field
Data
Filter
Data
Having
Data
Metric
Data
Order
Data
Query
Data
Result
Data
Set
Data
Source
Document
Chunk
Document
Hit
Document
Markdown
Options
Document
Markdown
Result
Document
Page
Document
Pages
Document
Search
Request
Document
Source
Document
Summary
Document
Text
Document
Type
Detection
Embedding
Options
Embedding
Provider
Embedding
Result
File
List
File
Metadata
I
Config
Service
Instantiate
Models
Instantiate
Room
Result
Loaded
Pack
Local
Conversion
Options
Local
Document
Conversion
Logging
Options
Message
Model
Choice
Model
Info
Native
Tool
Definition
Pack
Agent
Template
Pack
Room
Template
Pack
View
Page
Range
Pdf
Conversion
Options
Pdf
Conversion
Result
Pdf
Markdown
Options
Pdf
Markdown
Result
Pdf
Page
Markdown
Prepared
Prompt
Response
Process
Text
Response
Prompt
File
Prompt
File
Content
Prompt
Files
Response
Prompt
Folder
Prompt
Folder
Defaults
Prompt
Folder
Defaults
Response
Prompt
Folders
Response
Room
Details
Room
Error
Update
Room
Info
Room
Messages
Response
Room
Message
Update
Send
Message
Result
Story
Error
Event
Story
Idea
Story
Info
Story
Introduce
Character
Event
Story
Progress
Chapter
Event
Story
State
Story
State
Event
Tool
Agent
Documents
Tool
Artifact
Tool
Caller
Tool
Definition
Tool
Held
Document
Tool
Helpers
Tool
Pack
Documents
Tool
Parameter
Tool
Room
Access
Tools
Response
Tool
Summary
Transaction
Transaction
History
Response
Usage
Entry
Usage
Report
Usage
Source
Usage
Tags
Usage
Total
Type Aliases
Attachment
Image
Type
Chart
Type
Chart
Validation
Chart
Value
Format
Data
Aggregate
Fn
Data
Field
Type
Data
Filter
Op
Data
Row
Document
File
Type
Image
Aspect
Pack
Origin
Prompt
Scope
Room
Turn
Mode
Room
Update
Roster
Overrides
Tool
Context
Tool
Run
Result
Variables
ATTACHMENT_
IMAGE_
TYPES
CHART_
BLOCK_
LANGUAGE
CHART_
TYPES
DEFAULT_
CHUNK_
MAX_
CHARS
DEFAULT_
CHUNK_
OVERLAP_
CHARS
DEFAULT_
EMBEDDING_
MODEL
DEFAULT_
ROW_
LIMIT
EMBEDDING_
DIMENSIONS
MAX_
ATTACHED_
IMAGE_
BYTES
MAX_
ROW_
LIMIT
Functions
available
Tool
Packs
build
Data
Guide
Markdown
build
Document
Guide
Markdown
build
Markdown
chunk
Pages
convert
Local
Document
current
Usage
Tags
detect
Attachment
Mime
Type
detect
Document
Type
dnd5e
Tools
embedding
Input
embed
Texts
format
Chart
Value
install
Tool
Packs
insufficient
Balance
Message
is
Attachment
Image
is
Library
Attachment
library
Attachment
Name
library
Document
Id
Of
list
Datasets
list
Data
Sources
list
Document
Sources
page
Marker
query
Rows
register
Data
Source
register
Document
Source
register
Tool
Packs
render
Chart
Svg
run
With
Usage
Tags
set
Insufficient
Balance
Message
split
Markdown
Into
Pages
strip
Wrapping
Fence
unregister
Data
Source
unregister
Document
Source
update
Usage
Tags
validate
Chart
Briyah
npm
Briyah SDK - v2.0.18
Loading...