v1
- Account
- Admin
- AdminUpload
- Analysis
- AnalysisPreview
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataFileEntryPreview
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DingTalkAuthentication
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- Identity-Token
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- NotebookView
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- ThirdParty
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WeChat4WorkAuthentication
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
v2

StreamingDatasetApi

[GET] /api/streamingdatasets/{id}

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

[GET] /api/streamingdatasets

Responses

[200] Success

[POST] /api/streamingdatasets

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AddStreamingDatasetRequestModel

Responses

[200] Success

[POST] /api/streamingdatasets/{datasetId}/data

Parameters

Name	In	Type
datasetIdRequired	path	string
pushDataToken	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

InsertDataParamVO

Responses

[200] Success

[PUT] /api/streamingdatasets/{datasetId}

Parameters

Name	In	Type
datasetIdRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

UpdateStreamingDatasetRequestModel

Responses

[200] Success

[POST] /api/streamingdatasets/rebuild-table/{datasetId}

Parameters

Name	In	Type
datasetIdRequired	path	string

Responses

[200] Success

Models

Ƭ AddStreamingDatasetRequestModel

Name	Type
nameNullable	string
descriptionNullable	string
commentNullable	string
columnsNullable	`Array<Column>`
residenceTime	int64
residenceTimeUnitNullable	string
pushDataTokenNullable	string
tagIdsNullable	`Array<string>`
aiAssistantInfo	AIAssistantInfoViewModel

Ƭ Column

Name	Type
addIndex	Boolean
nameNullable	string
dbColumnNameNullable	string
typeNullable	string
fieldDescriptionNullable	string
dataVizAIHint	DataVizAIHint

Ƭ AIAssistantInfoViewModel

The AIAssistantInfo class represents the AI assistant configuration for a dataset.

Name	Type	Description
enabled	Boolean	value indicating whether the dataset can be used in chat analysis.
descriptionNullable	string	The summary information of the dataset that will be used for AI to automatically retrieve the dataset
columnAssistantInfosNullable	`Array<ColumnAssistantInfoViewModel>`	The list of column assistant information, which contains the column name and its description.

Ƭ DataVizAIHint

Enum:

None
Currency
ImageURL
ImageBinary
GeoRegion
GeoLatitude
GeoLongitude
GeoCountry
GeoProvince
GeoCity
GeoDistrict

Ƭ ColumnAssistantInfoViewModel

Represents information about a dataset column(field), including its name and description.

Name	Type	Description
columnNameNullable	string	Column(Field) Name
descriptionNullable	string	The summary information of the dataset fields that will be used for AI to automatically retrieve the dataset and relative columns.

Ƭ InsertDataParamVO

Name	Type
datasetIdNullable	string
columnsNullable	`Array<string>`
rowsNullable	`Array<array>`
overwrite	Boolean

Ƭ UpdateStreamingDatasetRequestModel

Name	Type
datasetIdNullable	string
isTableStructureChanged	Boolean
nameNullable	string
descriptionNullable	string
commentNullable	string
columnsNullable	`Array<Column>`
residenceTime	int64
residenceTimeUnitNullable	string
pushDataTokenNullable	string
tagIdsNullable	`Array<string>`
aiAssistantInfo	AIAssistantInfoViewModel