globals
@nuclia/core
Namespaces
Enumerations
- AccountBlockingState
- AnswerOperation
- AssumeRole
- BlockedFeature
- CustomSplitStrategy
- DataResidencyStatus
- EventType
- ExtractedDataTypes
- FIELD_TYPE
- FilterOperator
- InteractionOperation
- LabelSetKind
- ModelStability
- ModelType
- NumericReasoningEffort
- RAG_METADATAS
- RagImageStrategyName
- RagStrategyName
- ReasoningEffort
- Reranker
- RESOURCE_STATUS
- ResourceFieldProperties
- ResourceProperties
- SEVERITY
- SHORT_FIELD_TYPE
- SortField
- TaskApplyTo
- TrainingExecutionStatus
- TrainingStatus
- TrainingType
- UsageType
Classes
- ActivityMonitor
- Authentication
- ConversationFieldData
- Db
- FileFieldData
- JwtHelper
- KnowledgeBox
- LinkFieldData
- Nuclia
- ReadableResource
- ReadableSession
- Resource
- Rest
- RetrievalAgent
- Session
- SyncManager
- TaskManager
- TextFieldData
- Training
- WritableKnowledgeBox
Interfaces
- Account
- AccountConfig
- AccountCreation
- AccountLimits
- AccountLimitsPatchPayload
- AccountModification
- AccountStatus
- AccountUser
- AccountUsersPayload
- ActivityLogAskFilters
- ActivityLogChatFilters
- ActivityLogDownload
- ActivityLogDownloadQuery
- ActivityLogFilter
- ActivityLogFilters
- ActivityLogPagination
- ActivityLogQueryBase
- ActivityLogResponseAskItem
- ActivityLogResponseChatItem
- ActivityLogResponseItem
- ActivityLogResponseSearchItem
- ActivityLogSearchFilters
- ActivityLogStringFilter
- AgenticConfig
- AgenticConfigDefaults
- AgenticModelConfig
- AgenticRephraseConfig
- AgenticSmartAgentConfig
- AgenticSmartAgentModels
- AgenticSummarizeConfig
- AliniaConfig
- AliniaDriver
- And
- AppliedDataAugmentation
- ARAGAgent
- AragAnswer
- ARAGDriver
- ARAGException
- AragResponse
- ARAGSchemas
- AskAgent
- AskAgentCreation
- AskConfig
- AskOperation
- AssumeRoleInfo
- AuditMetadataFilter
- AugmentedField
- AuthInfo
- AuthTokens
- AWSS3AccessKeysCredentials
- AzureCertificateCredentials
- BaseAgent
- BaseAliniaAgentCreation
- BaseConditionalAgentCreation
- BaseContextAgent
- BaseEntitiesGroup
- BaseGenerationAgent
- BaseNotificationData
- BasePostprocessAgent
- BasePreprocessAgent
- BaseSearchOptions
- BasicAskAgent
- BasicAskAgentCreation
- BraveAgent
- BraveAgentCreation
- BraveConfig
- BraveDriver
- BrowseCapabilities
- BrowseOptions
- CatalogOptions
- CatalogQuery
- ChatOptions
- CitationFootnotes
- Citations
- Classification
- CloudLink
- CommonMetricDetails
- ComputedMetadata
- Consumption
- ContextAgent
- ContextConditionalAgent
- ContextConditionalAgentCreation
- ConversationalStrategy
- ConversationField
- ConversationFieldPages
- Counters
- CustomModel
- CustomModelItem
- CypherAgent
- CypherAgentCreation
- CypherConfig
- CypherDriver
- DataAugmentationParameters
- DateCreatedFilter
- DateModifiedFilter
- DownloadOptions
- DownloadStatus
- Entities
- EntitiesGroup
- Entity
- EntityDefinition
- EntityExample
- EntityFilter
- EntityPosition
- EntityPositions
- EventList
- ExportOptions
- ExternalAgent
- ExternalAgentCreation
- ExternalConnection
- ExtractConfig
- ExtractedData
- ExtractedText
- ExtractLLMConfig
- ExtractVLLMConfig
- ExtraMetadata
- Feedback
- FieldClassification
- FieldComputedMetadata
- FieldEntities
- FieldEntity
- FieldExtensionStrategy
- FieldFilter
- FieldFullId
- FieldId
- FieldMetadata
- FieldMimetypeFilter
- FileB64
- FileExtractedData
- FileField
- FileFieldExtractedData
- FileFilter
- FileMetadata
- FilePages
- FileUploadStatus
- FileWithMetadata
- FilterExpression
- FindConfig
- FullAccountUser
- FullKbUser
- FullResourceStrategy
- GenerateAgent
- GenerateAgentCreation
- GeneratedFilter
- GenerationAgent
- GenerativeProvider
- GenerativeProviders
- GenericFieldData
- GoogleAgent
- GoogleAgentCreation
- GoogleConfig
- GoogleDriver
- GoogleSource
- GraphExtractionExample
- GraphOperation
- GraphStrategy
- GuardOperation
- HierarchyStrategy
- HistoricalAgent
- HistoricalAgentCreation
- IAuthentication
- ICreateResource
- IDb
- IDriver
- IError
- IErrorResponse
- IEvents
- IFieldData
- IFieldDataBase
- IKnowledgeBox
- IKnowledgeBoxBase
- IKnowledgeBoxItem
- IKnowledgeBoxStandalone
- ImportOptions
- InspectTaskResponse
- InteractionOptions
- InteractionRequest
- InternetConfig
- INuclia
- InviteAccountUserPayload
- InviteKbData
- IPAddressInfo
- IResource
- IRest
- IRetrievalAgent
- IStandaloneKb
- ISyncManager
- IWritableKnowledgeBox
- Job
- JobLog
- JobLogsPage
- JobPagination
- JobsPage
- JwtUser
- KbIndex
- KbInvite
- KBKVSchemas
- KbUser
- KbUserPayload
- KeyValueContainsFilter
- KeyValueEqualFilter
- KeyValueField
- KeyValueFieldData
- KeyValueRangeFilter
- KeywordFilter
- KindFilter
- KnowledgeBoxCreation
- KVRange
- KVSchema
- KVSchemaField
- Label
- LabelFilter
- LabelOperation
- LabelSet
- LabelSets
- LanguageFilter
- LearningConfiguration
- LearningConfigurationOption
- LearningConfigurationProperty
- LearningConfigurations
- LearningConfigurationSchema
- LearningConfigurationUserKeys
- LinkExtractedData
- LinkField
- LinkFieldExtractedData
- LLMConfig
- LogFilters
- MagicAction
- McpAgent
- McpAgentCreation
- McpHttpConfig
- McpHttpDriver
- MCPSource
- McpSseConfig
- McpSseDriver
- McpStdioConfig
- McpStdioDriver
- Message
- MessageAttachment
- MessageContent
- Metadata
- MetadatasStrategy
- Metric
- MinScore
- ModelConfig
- ModelConfiguration
- ModelConfigurationItem
- ModelFeatures
- ModelInfo
- ModelMetadata
- ModifiedTimeRange
- NeighbouringParagraphsStrategy
- Ner
- NestedPosition
- Not
- NotificationMessage
- NUAClient
- NUAClientEditPayload
- NUAClientPayload
- NUAClientResponse
- NuaGuardPolicy
- NucliaDBConfig
- NucliaDBDriver
- NucliaDBSource
- NucliaOptions
- NucliaTokensDetails
- NucliaTokensMetric
- OAuthCredentials
- OAuthRedirection
- OAuthUrl
- Operation
- Or
- Origin
- OriginCollaboratorFilter
- OriginMetadataFilter
- OriginPathFilter
- OriginSourceFilter
- OriginTagFilter
- PageImageStrategy
- PagePositions
- PageSelections
- PageStructure
- PageToken
- Paragraph
- ParagraphClassification
- ParagraphImageStrategy
- PendingInvitation
- PerplexityAgent
- PerplexityAgentCreation
- PerplexityDriver
- PerplexitySource
- PositionedNER
- PostConditionalAgent
- PostConditionalAgentCreation
- PostprocessAgent
- PostprocessAliniaAgent
- PostprocessAliniaCreation
- PreConditionalAgent
- PreConditionalAgentCreation
- PredictAnswerOptions
- PredictedToken
- PreprocessAgent
- PreprocessAliniaAgent
- PreprocessAliniaCreation
- PrequeriesStrategy
- Prequery
- ProcessingHook
- ProcessingOptions
- ProcessingPullResponse
- ProcessingPushResponse
- ProcessingStatus
- PromptFeedbackSchema
- Prompts
- QAOperation
- QueryInfo
- Question
- QuestionAnswer
- QuestionAnswers
- RankFusion
- ReasoningConfig
- Relation
- RelationEntity
- RelationExample
- RelationMetadata
- RemiAgent
- RemiAgentCreation
- RemiQueryCriteria
- RemiQueryResponse
- RemiQueryResponseContextDetails
- RemiQueryResponseItem
- RemiScore
- RemiScoresResponseItem
- RephraseAgent
- RephraseAgentCreation
- ResourceBaseNotification
- ResourceField
- ResourceFilter
- ResourceList
- ResourceMimetypeFilter
- ResourceOperationNotification
- ResourcePagination
- ResourceProcessedData
- ResourceWrittenData
- RestartAgent
- RestartAgentCreation
- RestrictedAgent
- RestrictedAgentCreation
- RetrievalAgentCreation
- Routing
- Row
- RowsPreview
- SamlConfig
- SearchMetricsItem
- SearchOptions
- Security
- SemanticModelMigration
- Sentence
- SentenceSearch
- SentenceToken
- ServiceAccount
- ServiceAccountCreation
- ServiceAccountKey
- SessionCreation
- SessionCreationResponse
- SessionList
- ShareFileAPIKeyCredentials
- Sheet
- SignUpInfo
- SortOption
- SparkleAgent
- SparqlAgentCreation
- SplitLLMConfig
- SplitStrategy
- SqlAgent
- SqlAgentCreation
- SqlConfig
- SqlDriver
- StartStopTaskResponse
- StatusFilter
- StorageDrive
- StorageFolder
- StorageSite
- StorageStructure
- StreamingChunk
- SuggestOptions
- SummarizeAgent
- SummarizeAgentCreation
- SyncAgent
- SyncAgentCreation
- SyncConfig
- SyncConfiguration
- SyncConfigurationCreate
- SyncConfigurationOptions
- SyncConfigurationUpdate
- SyncDriver
- SyncSource
- TaskDefinition
- TaskFullDefinition
- TaskListResponse
- TaskOnBatch
- TaskOnGoing
- TaskResults
- TaskStatus
- TaskTrigger
- TavilyAgent
- TavilyAgentCreation
- TavilyDriver
- TextField
- TokenAnnotation
- TokenConsumption
- TokenSearch
- TrainingExecution
- TrainingExecutions
- TrainingExecutionWithDuration
- TrainingLastExecution
- TrainingTask
- UpdateKVSchema
- UploadResponse
- UploadStatus
- UsageMetric
- UsagePoint
- UserClassification
- UserFieldMetadata
- UserMetadata
- ValidationFeedbackSchema
- VisualSelection
- Welcome
- WelcomeUser
- Workflow
- WriteFileField
Type Aliases
- AccountRoles
- AccountTypes
- ActivityLogAskQuery
ActivityLogAskShowField- ActivityLogAskShowFields
- ActivityLogBaseQuery
- ActivityLogChatQuery
ActivityLogChatShowField- ActivityLogChatShowFields
- ActivityLogItem
- ActivityLogQuery
- ActivityLogResponseItemUnion
- ActivityLogSearchQuery
ActivityLogSearchShowField- ActivityLogSearchShowFields
- ActivityLogShowFields
- AgenticConfigs
- AgenticConfigSchema
- AgenticSmartAgentMode
- AgenticSource
- AgenticSources
- Answer
- AnyFieldData
- ApplyOption
- AragModule
- ContextAgentCreation
- ContextModule
- DownloadFormat
- Driver
- DriverCreation
- Event
- ExternalConnectionCredentials
- ExtractStrategies
- FieldFilterExpression
- Filter
- GenerationAgentCreation
- GenerationModule
- GoogleTimeRange
- GuardrailsPreconfig
- GuardrailsProviderType
- HistoryEntry
- InternetDriver
- InternetProviderType
- IRetrievalAgentBase
- IRetrievalAgentItem
- ISession
- KBRoles
- KBStates
- KeyValueFilterExpression
- KnowledgeBoxMode
- KVFieldType
- KVValue
- Language
- LearningConfigurationSet
- MagicActionType
- ModelConfigurationCreation
- NotificationOperation
- NotificationType
- NuaGuardPolicyPayload
- NuaGuardPolicyResponse
- NucliaDBRole
- NullableUploadLimits
- NullableUsageLimits
- ParagraphFilterExpression
- PerplexityConfig
- PostprocessAgentCreation
- PostprocessModule
- PreprocessAgentCreation
- PreprocessModule
- PromiseMapper
- ProviderType
- RAGImageStrategy
- RAGStrategy
- ReasoningParam
- RelationEntityType
- RelationType
- RemiAnswerStatus
- ResourceData
- ResourceFilterExpression
- ResourceProcessingNotification
- ResourceStatus
- SearchConfig
- SearchConfigs
- SessionPagination
- SessionProperties
- SomeAgent
- SortOrder
- SplitStrategies
- TaskName
- TaskParameters
- TavilyConfig
- TextFieldFormat
- TextFormat
- TypeParagraph
- UploadLimits
- UploadLimitsEntries
- UsageAggregation
- UsageLimits
- UsageLimitsEntries
- UserType
- WorkflowType
Variables
- ABORT_STREAMING_REASON
- ACTIVITY_LOG_ASK_SHOW_FIELDS
- ACTIVITY_LOG_CHAT_SHOW_FIELDS
- ACTIVITY_LOG_SEARCH_SHOW_FIELDS
- ACTIVITY_LOG_SHOW_FIELDS
- CREATION_END_PREFIX
- CREATION_START_PREFIX
- DEFAULT_GENERATIVE_ANSWER_CONFIG
- DEFAULT_NER_KEY
- DEFAULT_RESULT_DISPLAY_CONFIG
- DEFAULT_ROUTING_CONFIG
- DEFAULT_SEARCH_BOX_CONFIG
- HIDDEN_PREFIX
- INITIAL_CITATION_THRESHOLD
- LABEL_FILTER_PREFIX
- LANGUAGE_FACET
- MAX_FACETS_PER_REQUEST
- MIME_FACETS
- MIME_FILTER_PREFIX
- NER_FILTER_PREFIX
- NUCLIA_STANDARD_SEARCH_CONFIG
- NUCLIA_STANDARD_SEARCH_CONFIG_ID
- PATH_FILTER_PREFIX
- setLabels
- SUMMARY_PROMPT
- USER_PROMPTS
Functions
- ask
- batchUpload
- catalog
- deDuplicateList
- evaluateExpression
- find
- format
- formatObject
- getAgenticConfigDefaults
- getAllNotifications
- getCategoryFromModule
- getDataKeyFromFieldType
- getDateFromFilter
- getEntityFromFilter
- getFeatures
- getFieldTypeFromString
- getFileMetadata
- getFilterFromDate
- getFilterFromEntity
- getFilterFromLabel
- getFilterFromLabelSet
- getFilterFromVisibility
- getJsonSchemaValue
- getLabelFromFilter
- getLabelSetFromFilter
- getLearningConfigPropType
- getObjectValue
- getPreselectedFilterValue
- getRagStrategies
- getSubSchema
- getVisibilityFromFilter
- getWidgetParameters
- improveSchemaNames
- isContextModule
- isGenerationModule
- isPostprocessModule
- isPreprocessModule
- lengthUnicode
- longToShortFieldType
- mapErrorResponseFromAnswer
- normalizeGlobalBackendUrl
- normalizeSchemaProperty
- parsePreselectedFilters
- parseRAGImageStrategies
- parseRAGStrategies
- predictAnswer
- replaceSubdomainInUrl
- retry429Config
- search
- setupAgenticWSHandlers
- setZoneInRegionalUrl
- shortToLongFieldType
- sliceUnicode
- suggest
- trimLabelSets
- TUSuploadFile
- upload
- uploadFile
- uploadToProcess