types

Documentation

Overview

Code generated by goctl. DO NOT EDIT.

Index

• type AnyResponse
• type BatchExecNGQLParams
• type Client
• type ConnectDBParams
• type CreateFavoriteRequest
• type CreateImportTaskData
• type CreateImportTaskRequest
• type CreateTaskDraftRequest
• type DatasourceAddData
• type DatasourceAddRequest
• type DatasourceBatchRemoveRequest
• type DatasourceConfig
• type DatasourceData
• type DatasourceListContentsData
• type DatasourceListContentsRequest
• type DatasourceListRequest
• type DatasourcePreviewFileData
• type DatasourcePreviewFileRequest
• type DatasourceRemoveRequest
• type DatasourceS3Config
• type DatasourceS3UpdateConfig
• type DatasourceSFTPConfig
• type DatasourceSFTPUpdateConfig
• type DatasourceUpdateRequest
• type DeleteFavoriteRequest
• type DeleteImportTaskRequest
• type DeleteLLMImportRequest
• type DeleteSketchRequest
• type DownloadConfigsRequest
• type DownloadLLMImportNgqlRequest
• type DownloadLogsRequest
• type Edge
• type EdgeNodeRef
• type EdgeRank
• type ExecNGQLParams
• type FavoriteIDResult
• type FavoriteItem
• type FavoriteList
• type FileConfig
• type FileConfigUpdateRequest
• type FileDestroyRequest
• type FileStat
• type FilesIndexData
• type GetHealth
• type GetImportTaskData
• type GetImportTaskLogNamesData
• type GetImportTaskLogNamesRequest
• type GetImportTaskRequest
• type GetManyImportTaskData
• type GetManyImportTaskLogData
• type GetManyImportTaskLogRequest
• type GetManyImportTaskRequest
• type GetSchemaSnapshotRequest
• type GetSketchesRequest
• type GetWorkingDirResult
• type HandleLLMImportRequest
• type ImportTaskCSV
• type ImportTaskConfig
• type ImportTaskStats
• type InitSketchRequest
• type LLMConfigRequest
• type LLMImportJobsRequest
• type LLMImportLogRequest
• type LLMImportRequest
• type LLMRequest
• type LLMResponse
• type LocalConfig
• type Log
• type LogField
• type Manager
• type NodeId
• type OSSConfig
• type Prop
• type S3Config
• type SFTPConfig
• type SchemaSnapshot
• type Sketch
• type SketchIDResult
• type SketchList
• type Source
• type StopImportTaskRequest
• type Tag
• type UpdateSchemaSnapshotRequest
• type UpdateSketchRequest
• type UpdateTaskDraftRequest

Types

type AnyResponse

type AnyResponse struct {
	Data interface{} `json:"data"`
}

type BatchExecNGQLParams

type BatchExecNGQLParams struct {
	Gqls  []string `json:"gqls"`
	Space string   `json:"space,optional"`
}

type Client

type Client struct {
	Version                  string  `json:"version,omitempty" validate:"required"`
	Address                  string  `json:"address,omitempty" validate:"required"`
	User                     string  `json:"user,omitempty" validate:"required"`
	Password                 string  `json:"password,omitempty" validate:"required"`
	ConcurrencyPerAddress    int     `json:"concurrencyPerAddress,optional"`
	ReconnectInitialInterval *string `json:"reconnectInitialInterval,optional,omitempty"`
	Retry                    int     `json:"retry,optional"`
	RetryInitialInterval     *string `json:"retryInitialInterval,optional,omitempty"`
}

type ConnectDBParams

type ConnectDBParams struct {
	Address       string `json:"address"`
	Port          int    `json:"port"`
	Authorization string `header:"Authorization"`
}

type CreateFavoriteRequest

type CreateFavoriteRequest struct {
	Content string `json:"content" validate:"required"`
}

type CreateImportTaskData

type CreateImportTaskData struct {
	Id string `json:"id"`
}

type CreateImportTaskRequest

type CreateImportTaskRequest struct {
	Id        *string `json:"id,optional,omitempty"`
	Name      string  `json:"name" validate:"required"`
	Config    string  `json:"config" validate:"required"`
	RawConfig string  `json:"rawConfig" validate:"required"`
}

type CreateTaskDraftRequest

type CreateTaskDraftRequest struct {
	Name      string `json:"name" validate:"required"`
	Space     string `json:"space" validate:"required"`
	RawConfig string `json:"rawConfig" validate:"required"`
}

type DatasourceAddData

type DatasourceAddData struct {
	ID string `json:"id"`
}

type DatasourceAddRequest

type DatasourceAddRequest struct {
	Type       string                `json:"type"`
	Platform   string                `json:"platform,optional,omitempty"`
	Name       string                `json:"name"`
	S3Config   *DatasourceS3Config   `json:"s3Config,optional"`
	SFTPConfig *DatasourceSFTPConfig `json:"sftpConfig,optional"`
}

type DatasourceBatchRemoveRequest

type DatasourceBatchRemoveRequest struct {
	IDs []string `json:"ids"`
}

type DatasourceConfig

type DatasourceConfig struct {
	ID         string                `json:"id"`
	Type       string                `json:"type"`
	Name       string                `json:"name"`
	Platform   string                `json:"platform"`
	S3Config   *DatasourceS3Config   `json:"s3Config,optional"`
	SFTPConfig *DatasourceSFTPConfig `json:"sftpConfig,optional"`
	CreateTime int64                 `json:"createTime,optional"`
}

type DatasourceData

type DatasourceData struct {
	List []DatasourceConfig `json:"list"`
}

type DatasourceListContentsData

type DatasourceListContentsData struct {
	List []FileConfig `json:"list"`
}

type DatasourceListContentsRequest

type DatasourceListContentsRequest struct {
	DatasourceID string `path:"id"`
	Path         string `form:"path,optional"`
}

type DatasourceListRequest

type DatasourceListRequest struct {
	Type string `form:"type,optional"`
}

type DatasourcePreviewFileData

type DatasourcePreviewFileData struct {
	Contents []string `json:"contents"`
}

type DatasourcePreviewFileRequest

type DatasourcePreviewFileRequest struct {
	DatasourceID string `path:"id"`
	Path         string `form:"path"`
}

type DatasourceRemoveRequest

type DatasourceRemoveRequest struct {
	ID string `path:"id"`
}

type DatasourceS3Config

type DatasourceS3Config struct {
	Endpoint     string `json:"endpoint"`
	Region       string `json:"region,optional"`
	Bucket       string `json:"bucket"`
	AccessKeyID  string `json:"accessKeyID"`
	AccessSecret string `json:"accessSecret,optional"`
}

type DatasourceS3UpdateConfig

type DatasourceS3UpdateConfig struct {
	Endpoint     string `json:"endpoint,optional,omitempty"`
	Region       string `json:"region,optional,omitempty"`
	Bucket       string `json:"bucket,optional,omitempty"`
	AccessKeyID  string `json:"accessKeyID,optional,omitempty"`
	AccessSecret string `json:"accessSecret,optional,omitempty"`
}

type DatasourceSFTPConfig

type DatasourceSFTPConfig struct {
	Host     string `json:"host"`
	Port     int    `json:"port"`
	Username string `json:"username"`
	Password string `json:"password"`
}

type DatasourceSFTPUpdateConfig

type DatasourceSFTPUpdateConfig struct {
	Host     string `json:"host,optional,omitempty"`
	Port     int    `json:"port,optional,omitempty"`
	Username string `json:"username,optional,omitempty"`
	Password string `json:"password,optional,omitempty"`
}

type DatasourceUpdateRequest

type DatasourceUpdateRequest struct {
	ID         string                      `path:"id"`
	Platform   string                      `json:"platform,optional,omitempty"`
	Type       string                      `json:"type"`
	Name       string                      `json:"name"`
	S3Config   *DatasourceS3UpdateConfig   `json:"s3Config,optional"`
	SFTPConfig *DatasourceSFTPUpdateConfig `json:"sftpConfig,optional"`
}

type DeleteFavoriteRequest

type DeleteFavoriteRequest struct {
	Id string `path:"id" validate:"required"`
}

type DeleteImportTaskRequest

type DeleteImportTaskRequest struct {
	Id string `path:"id"`
}

type DeleteLLMImportRequest

type DeleteLLMImportRequest struct {
	JobID string `path:"jobId"`
}

type DeleteSketchRequest

type DeleteSketchRequest struct {
	ID string `path:"id" validate:"required"`
}

type DownloadConfigsRequest

type DownloadConfigsRequest struct {
	Id string `path:"id" validate:"required"`
}

type DownloadLLMImportNgqlRequest

type DownloadLLMImportNgqlRequest struct {
	JobID string `json:"jobId"`
}

type DownloadLogsRequest

type DownloadLogsRequest struct {
	Id   string `path:"id" validate:"required"`
	Name string `form:"name" validate:"required"`
}

type Edge

type Edge struct {
	Name               string      `json:"name" validate:"required"`
	Src                EdgeNodeRef `json:"src" validate:"required"`
	Dst                EdgeNodeRef `json:"dst" validate:"required"`
	Props              []Prop      `json:"props" validate:"required"`
	Rank               *EdgeRank   `json:"rank,optional,omitempty"`
	IgnoreExistedIndex bool        `json:"ignoreExistedIndex,optional,omitempty"`
}

type EdgeNodeRef

type EdgeNodeRef struct {
	ID NodeId `json:"id" validate:"required"`
}

type EdgeRank

type EdgeRank struct {
	Index *int64 `json:"index,optional,omitempty"`
}

type ExecNGQLParams

type ExecNGQLParams struct {
	Gql   string `json:"gql"`
	Space string `json:"space,optional"`
}

type FavoriteIDResult

type FavoriteIDResult struct {
	ID string `json:"id"`
}

type FavoriteItem

type FavoriteItem struct {
	ID         string `json:"id"`
	Content    string `json:"content"`
	CreateTime int64  `json:"createTime"`
}

type FavoriteList

type FavoriteList struct {
	Items []FavoriteItem `json:"items"`
	Total int64          `json:"total"`
}

type FileConfig

type FileConfig struct {
	Size int64  `json:"size"`
	Type string `json:"type"`
	Name string `json:"name"`
}

type FileConfigUpdateRequest

type FileConfigUpdateRequest struct {
	WithHeader bool   `json:"withHeader, optional"`
	Delimiter  string `json:"delimiter"`
	Name       string `json:"name" validate:"required"`
}

type FileDestroyRequest

type FileDestroyRequest struct {
	Names []string `json:"names"`
}

type FileStat

type FileStat struct {
	Sample     string `json:"sample"`
	WithHeader bool   `json:"withHeader"`
	Delimiter  string `json:"delimiter"`
	Name       string `json:"name"`
	Size       int64  `json:"size"`
}

type FilesIndexData

type FilesIndexData struct {
	List []FileStat `json:"list"`
}

type GetHealth

type GetHealth struct {
	Status string `json:"status"`
}

type GetImportTaskData

type GetImportTaskData struct {
	Id            string          `json:"id"`
	Name          string          `json:"name"`
	User          string          `json:"user"`
	Address       string          `json:"address"`
	ImportAddress []string        `json:"importAddress"`
	Space         string          `json:"space"`
	Status        string          `json:"status"`
	Message       string          `json:"message"`
	CreateTime    int64           `json:"createTime"`
	UpdateTime    int64           `json:"updateTime"`
	Stats         ImportTaskStats `json:"stats"`
	RawConfig     string          `json:"rawConfig"`
	LLMJob        interface{}     `json:"llmJob"`
}

type GetImportTaskLogNamesData

type GetImportTaskLogNamesData struct {
	Names []string `json:"names"`
}

type GetImportTaskLogNamesRequest

type GetImportTaskLogNamesRequest struct {
	Id string `path:"id" validate:"required"`
}

type GetImportTaskRequest

type GetImportTaskRequest struct {
	Id string `path:"id" validate:"required"`
}

type GetManyImportTaskData

type GetManyImportTaskData struct {
	Total int64               `json:"total"`
	List  []GetImportTaskData `json:"list"`
}

type GetManyImportTaskLogData

type GetManyImportTaskLogData struct {
	Logs string `json:"logs"`
}

type GetManyImportTaskLogRequest

type GetManyImportTaskLogRequest struct {
	Id string `path:"id" validate:"required"`
}

type GetManyImportTaskRequest

type GetManyImportTaskRequest struct {
	Page     int    `form:"page,default=1"`
	PageSize int    `form:"pageSize,default=999"`
	Space    string `form:"space,optional"`
}

type GetSchemaSnapshotRequest

type GetSchemaSnapshotRequest struct {
	Space string `form:"space"`
}

type GetSketchesRequest

type GetSketchesRequest struct {
	Page     int64  `form:"page,range=[0:],optional"`
	PageSize int64  `form:"pageSize,default=10,range=[1:1000],optional"`
	Keyword  string `form:"keyword,optional"`
}

type GetWorkingDirResult

type GetWorkingDirResult struct {
	TaskDir   string `json:"taskDir,omitempty"`
	UploadDir string `json:"uploadDir,omitempty"`
}

type HandleLLMImportRequest

type HandleLLMImportRequest struct {
	JobID  string `json:"jobId"`
	Action string `path:"action"`
}

type ImportTaskCSV

type ImportTaskCSV struct {
	WithHeader *bool   `json:"withHeader,optional"`
	LazyQuotes *bool   `json:"lazyQuotes,optional"`
	Delimiter  *string `json:"delimiter,optional"`
}

type ImportTaskConfig

type ImportTaskConfig struct {
	Client  Client    `json:"client" validate:"required"`
	Manager Manager   `json:"manager" validate:"required"`
	Sources []*Source `json:"sources" validate:"required"`
	Log     *Log      `json:"log,omitempty,optional"`
}

type ImportTaskStats

type ImportTaskStats struct {
	ProcessedBytes  int64 `json:"processedBytes"`
	TotalBytes      int64 `json:"totalBytes"`
	FailedRecords   int64 `json:"failedRecords"`
	TotalRecords    int64 `json:"totalRecords"`
	FailedRequest   int64 `json:"failedRequest"`
	TotalRequest    int64 `json:"totalRequest"`
	TotalLatency    int64 `json:"totalLatency"`
	TotalRespTime   int64 `json:"totalRespTime"`
	FailedProcessed int64 `json:"failedProcessed"`
	TotalProcessed  int64 `json:"totalProcessed"`
}

type InitSketchRequest

type InitSketchRequest struct {
	Name     string `json:"name" validate:"required"`
	Schema   string `json:"schema,optional"`
	Snapshot string `json:"snapshot,optional"`
}

type LLMConfigRequest

type LLMConfigRequest struct {
	URL              string `json:"url"`
	Key              string `json:"key,optional"`
	APIType          string `json:"apiType"`
	MaxContextLength int    `json:"maxContextLength"`
	Config           string `json:"config,optional"`
}

type LLMImportJobsRequest

type LLMImportJobsRequest struct {
	Page     int    `json:"page"`
	PageSize int    `json:"pageSize"`
	Space    string `json:"space,optional"`
}

type LLMImportLogRequest

type LLMImportLogRequest struct {
	JobID string `json:"jobId"`
}

type LLMImportRequest

type LLMImportRequest struct {
	Space      string `json:"space"`
	File       string `json:"file,optional"`
	FilePath   string `json:"filePath,optional"`
	Type       string `json:"type"`
	UserPrompt string `json:"userPrompt"`
}

type LLMRequest

type LLMRequest struct {
	Data map[string]interface{} `json:"data"`
}

type LLMResponse

type LLMResponse struct {
	Data interface{} `json:"data"`
}

type LocalConfig

type LocalConfig struct {
	Path string `json:"path,omitempty"`
}

type Log

type Log struct {
	Level   *string    `json:"level,omitempty,optional"`
	Console *bool      `json:"console,omitempty,optional"`
	Files   []string   `json:"files,omitempty,optional"`
	Fields  []LogField `json:"fields,omitempty,optional"`
}

type LogField

type LogField struct {
	Key   string      `json:"key"`
	Value interface{} `json:"value"`
}

type Manager

type Manager struct {
	SpaceName           string  `json:"spaceName,omitempty" validate:"required"`
	Batch               int     `json:"batch,omitempty,optional"`
	ReaderConcurrency   int     `json:"readerConcurrency,omitempty,optional"`
	ImporterConcurrency int     `json:"importerConcurrency,omitempty,optional"`
	StatsInterval       *string `json:"statsInterval,omitempty,optional"`
}

type NodeId

type NodeId struct {
	Name        string        `json:"name,optional"`
	Type        string        `json:"type" validate:"required"`
	Index       int64         `json:"index,optional,omitempty"`
	ConcatItems []interface{} `json:"concatItems,optional,omitempty"`
	Function    string        `json:"function,optional,omitempty"`
}

type OSSConfig

type OSSConfig struct {
	Endpoint        string `json:"endpoint,omitempty"`
	AccessKeyID     string `json:"accessKeyID,omitempty"`
	AccessKeySecret string `json:"accessKeySecret,omitempty"`
	Bucket          string `json:"bucket,omitempty"`
	Key             string `json:"key,omitempty"`
}

type Prop

type Prop struct {
	Name               string  `json:"name" validate:"required"`
	Type               string  `json:"type" validate:"required"`
	Index              int64   `json:"index,optional,omitempty"`
	Nullable           bool    `json:"nullable,optional,omitempty"`
	NullValue          string  `json:"nullValue,optional,omitempty"`
	AlternativeIndices []int64 `json:"alternativeIndices,optional,omitempty"`
	DefaultValue       string  `json:"defaultValue,optional,omitempty"`
}

type S3Config

type S3Config struct {
	Endpoint        string `json:"endpoint,optional,omitempty"`
	Region          string `json:"region,omitempty"`
	AccessKeyID     string `json:"accessKeyID,omitempty"`
	AccessKeySecret string `json:"accessKeySecret,omitempty"`
	Token           string `json:"token,optional,omitempty"`
	Bucket          string `json:"bucket,omitempty"`
	Key             string `json:"key,omitempty"`
}

type SFTPConfig

type SFTPConfig struct {
	Host       string `json:"host,omitempty"`
	Port       int    `json:"port,omitempty"`
	User       string `json:"user,omitempty"`
	Password   string `json:"password,omitempty"`
	KeyFile    string `json:"keyFile,optional,omitempty"`
	KeyData    string `json:"keyData,optional,omitempty"`
	Passphrase string `json:"passphrase,optional,omitempty"`
	Path       string `json:"path,omitempty"`
}

type SchemaSnapshot

type SchemaSnapshot struct {
	Space      string `json:"space"`
	Snapshot   string `json:"snapshot"`
	UpdateTime int64  `json:"updateTime"`
	CreateTime int64  `json:"createTime"`
}

type Sketch

type Sketch struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	Schema     string `json:"schema"`
	Snapshot   string `json:"snapshot"`
	CreateTime int64  `json:"createTime"`
	UpdateTime int64  `json:"updateTime"`
}

type SketchIDResult

type SketchIDResult struct {
	ID string `json:"id"`
}

type SketchList

type SketchList struct {
	Items    []Sketch `json:"items"`
	Total    int64    `json:"total"`
	Page     int64    `json:"page"`
	PageSize int64    `json:"pageSize"`
}

type Source

type Source struct {
	CSV                ImportTaskCSV `json:"csv" validate:"required"`
	Path               string        `json:"path,optional,omitempty"`
	S3                 *S3Config     `json:"s3,optional,omitempty"`
	SFTP               *SFTPConfig   `json:"sftp,optional,omitempty"`
	OSS                *OSSConfig    `json:"oss,optional,omitempty"`
	DatasourceId       *string       `json:"datasourceId,optional,omitempty"`
	DatasourceFilePath *string       `json:"datasourceFilePath,optional,omitempty"`
	Tags               []Tag         `json:"tags,optional"`
	Edges              []Edge        `json:"edges,optional"`
}

type StopImportTaskRequest

type StopImportTaskRequest struct {
	Id string `path:"id"`
}

type Tag

type Tag struct {
	Name               string `json:"name" validate:"required"`
	ID                 NodeId `json:"id" validate:"required"`
	Props              []Prop `json:"props" validate:"required"`
	IgnoreExistedIndex bool   `json:"ignoreExistedIndex,optional,omitempty"`
}

type UpdateSchemaSnapshotRequest

type UpdateSchemaSnapshotRequest struct {
	Space    string `json:"space"`
	Snapshot string `json:"snapshot"`
}

type UpdateSketchRequest

type UpdateSketchRequest struct {
	ID       string `path:"id" validate:"required"`
	Name     string `json:"name" validate:"required"`
	Schema   string `json:"schema,optional"`
	Snapshot string `json:"snapshot,optional"`
}

type UpdateTaskDraftRequest

type UpdateTaskDraftRequest struct {
	Id        *string `path:"id" validate:"required"`
	Name      string  `json:"name" validate:"required"`
	Space     string  `json:"space" validate:"required"`
	RawConfig string  `json:"rawConfig" validate:"required"`
}