larkaily

package
v3.4.4-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 5, 2024 License: MIT Imports: 5 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AilyKnowledgeAskProcessData added in v3.3.5

type AilyKnowledgeAskProcessData struct {
	ChartDsls []string `json:"chart_dsls,omitempty"` // 有数据分析时,根据数据生成的图表描述,按markdown语义描述

	Chunks []string `json:"chunks,omitempty"` // 召回的知识视图切片的文本数据

	SqlData []string `json:"sql_data,omitempty"` // 有数据分析时,查询到数据结果,每个元素为 json 序列化后的数据结果
}

type AilyKnowledgeAskProcessDataBuilder added in v3.3.5

type AilyKnowledgeAskProcessDataBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeAskProcessDataBuilder added in v3.3.5

func NewAilyKnowledgeAskProcessDataBuilder() *AilyKnowledgeAskProcessDataBuilder

func (*AilyKnowledgeAskProcessDataBuilder) Build added in v3.3.5

func (*AilyKnowledgeAskProcessDataBuilder) ChartDsls added in v3.3.5

有数据分析时,根据数据生成的图表描述,按markdown语义描述

示例值:

func (*AilyKnowledgeAskProcessDataBuilder) Chunks added in v3.3.5

召回的知识视图切片的文本数据

示例值:

func (*AilyKnowledgeAskProcessDataBuilder) SqlData added in v3.3.5

有数据分析时,查询到数据结果,每个元素为 json 序列化后的数据结果

示例值:

type AilyKnowledgeDataset added in v3.2.6

type AilyKnowledgeDataset struct {
	ApiName *string `json:"api_name,omitempty"` // 分析表ID

	Title *string `json:"title,omitempty"` // 分析表标题
}

type AilyKnowledgeDatasetBuilder added in v3.2.6

type AilyKnowledgeDatasetBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeDatasetBuilder added in v3.2.6

func NewAilyKnowledgeDatasetBuilder() *AilyKnowledgeDatasetBuilder

func (*AilyKnowledgeDatasetBuilder) ApiName added in v3.2.6

分析表ID

示例值:object_x

func (*AilyKnowledgeDatasetBuilder) Build added in v3.2.6

func (*AilyKnowledgeDatasetBuilder) Title added in v3.2.6

分析表标题

示例值:title

type AilyKnowledgeDatatable added in v3.2.6

type AilyKnowledgeDatatable struct {
	ApiName *string `json:"api_name,omitempty"` // 数据表ID

	Title *string `json:"title,omitempty"` // 数据表标题
}

type AilyKnowledgeDatatableBuilder added in v3.2.6

type AilyKnowledgeDatatableBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeDatatableBuilder added in v3.2.6

func NewAilyKnowledgeDatatableBuilder() *AilyKnowledgeDatatableBuilder

func (*AilyKnowledgeDatatableBuilder) ApiName added in v3.2.6

数据表ID

示例值:object_x

func (*AilyKnowledgeDatatableBuilder) Build added in v3.2.6

func (*AilyKnowledgeDatatableBuilder) Title added in v3.2.6

数据表标题

示例值:title

type AilyKnowledgeDocs added in v3.2.6

type AilyKnowledgeDocs struct {
	Title *string `json:"title,omitempty"` // 标题

	Type *string `json:"type,omitempty"` // 飞书云文档类型

	Token *string `json:"token,omitempty"` // 飞书云文档标识

	Url *string `json:"url,omitempty"` // 链接
}

type AilyKnowledgeDocsBuilder added in v3.2.6

type AilyKnowledgeDocsBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeDocsBuilder added in v3.2.6

func NewAilyKnowledgeDocsBuilder() *AilyKnowledgeDocsBuilder

func (*AilyKnowledgeDocsBuilder) Build added in v3.2.6

func (builder *AilyKnowledgeDocsBuilder) Build() *AilyKnowledgeDocs

func (*AilyKnowledgeDocsBuilder) Title added in v3.2.6

标题

示例值:title

func (*AilyKnowledgeDocsBuilder) Token added in v3.2.6

飞书云文档标识

示例值:NWicfaD1Rlp2utdR0zycOabcdef

func (*AilyKnowledgeDocsBuilder) Type added in v3.2.6

飞书云文档类型

示例值:docx

func (*AilyKnowledgeDocsBuilder) Url added in v3.2.6

链接

示例值:https://feishu.cn/docx/NWicfaD1Rlp2utdR0zycOabcdef

type AilyKnowledgeFaq added in v3.3.5

type AilyKnowledgeFaq struct {
	Question *string `json:"question,omitempty"` // 匹配问题

	Answer *string `json:"answer,omitempty"` // 匹配描述
}

type AilyKnowledgeFaqBuilder added in v3.3.5

type AilyKnowledgeFaqBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeFaqBuilder added in v3.3.5

func NewAilyKnowledgeFaqBuilder() *AilyKnowledgeFaqBuilder

func (*AilyKnowledgeFaqBuilder) Answer added in v3.3.5

func (builder *AilyKnowledgeFaqBuilder) Answer(answer string) *AilyKnowledgeFaqBuilder

匹配描述

示例值:答案

func (*AilyKnowledgeFaqBuilder) Build added in v3.3.5

func (builder *AilyKnowledgeFaqBuilder) Build() *AilyKnowledgeFaq

func (*AilyKnowledgeFaqBuilder) Question added in v3.3.5

func (builder *AilyKnowledgeFaqBuilder) Question(question string) *AilyKnowledgeFaqBuilder

匹配问题

示例值:问题

type AilyKnowledgeFile added in v3.2.6

type AilyKnowledgeFile struct {
	Title *string `json:"title,omitempty"` // 标题

	MimeType *string `json:"mime_type,omitempty"` // 文件mime类型

	Content *string `json:"content,omitempty"` // 文件内容

	SourceUrl *string `json:"source_url,omitempty"` // 文件来源URL
}

type AilyKnowledgeFileBuilder added in v3.2.6

type AilyKnowledgeFileBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeFileBuilder added in v3.2.6

func NewAilyKnowledgeFileBuilder() *AilyKnowledgeFileBuilder

func (*AilyKnowledgeFileBuilder) Build added in v3.2.6

func (builder *AilyKnowledgeFileBuilder) Build() *AilyKnowledgeFile

func (*AilyKnowledgeFileBuilder) Content added in v3.2.6

func (builder *AilyKnowledgeFileBuilder) Content(content string) *AilyKnowledgeFileBuilder

文件内容

示例值:content

func (*AilyKnowledgeFileBuilder) MimeType added in v3.2.6

func (builder *AilyKnowledgeFileBuilder) MimeType(mimeType string) *AilyKnowledgeFileBuilder

文件mime类型

示例值:text/plain

func (*AilyKnowledgeFileBuilder) SourceUrl added in v3.2.9

func (builder *AilyKnowledgeFileBuilder) SourceUrl(sourceUrl string) *AilyKnowledgeFileBuilder

文件来源URL

示例值:https://www.xx.xx

func (*AilyKnowledgeFileBuilder) Title added in v3.2.6

标题

示例值:title

type AilyKnowledgeFolder added in v3.2.6

type AilyKnowledgeFolder struct {
	Title *string `json:"title,omitempty"` // 文件夹标题

	Token *string `json:"token,omitempty"` // 文件夹标识

	Url *string `json:"url,omitempty"` // 链接
}

type AilyKnowledgeFolderBuilder added in v3.2.6

type AilyKnowledgeFolderBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeFolderBuilder added in v3.2.6

func NewAilyKnowledgeFolderBuilder() *AilyKnowledgeFolderBuilder

func (*AilyKnowledgeFolderBuilder) Build added in v3.2.6

func (*AilyKnowledgeFolderBuilder) Title added in v3.2.6

文件夹标题

示例值:title

func (*AilyKnowledgeFolderBuilder) Token added in v3.2.6

文件夹标识

示例值:xxx

func (*AilyKnowledgeFolderBuilder) Url added in v3.2.6

链接

示例值:xxx

type AilyKnowledgeHelpdesk added in v3.2.6

type AilyKnowledgeHelpdesk struct {
	HelpdeskId *string `json:"helpdesk_id,omitempty"` // 服务台ID

	Title *string `json:"title,omitempty"` // 服务台标题
}

type AilyKnowledgeHelpdeskBuilder added in v3.2.6

type AilyKnowledgeHelpdeskBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeHelpdeskBuilder added in v3.2.6

func NewAilyKnowledgeHelpdeskBuilder() *AilyKnowledgeHelpdeskBuilder

func (*AilyKnowledgeHelpdeskBuilder) Build added in v3.2.6

func (*AilyKnowledgeHelpdeskBuilder) HelpdeskId added in v3.2.6

func (builder *AilyKnowledgeHelpdeskBuilder) HelpdeskId(helpdeskId string) *AilyKnowledgeHelpdeskBuilder

服务台ID

示例值:123

func (*AilyKnowledgeHelpdeskBuilder) Title added in v3.2.6

服务台标题

示例值:title

type AilyKnowledgeMessage added in v3.3.5

type AilyKnowledgeMessage struct {
	Content *string `json:"content,omitempty"` // 消息内容
}

type AilyKnowledgeMessageBuilder added in v3.3.5

type AilyKnowledgeMessageBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeMessageBuilder added in v3.3.5

func NewAilyKnowledgeMessageBuilder() *AilyKnowledgeMessageBuilder

func (*AilyKnowledgeMessageBuilder) Build added in v3.3.5

func (*AilyKnowledgeMessageBuilder) Content added in v3.3.5

消息内容

示例值:推荐一部电影

type AilyKnowledgeWeb added in v3.2.6

type AilyKnowledgeWeb struct {
	Url *string `json:"url,omitempty"` // 链接

	Title *string `json:"title,omitempty"` // 网页标题
}

type AilyKnowledgeWebBuilder added in v3.2.6

type AilyKnowledgeWebBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeWebBuilder added in v3.2.6

func NewAilyKnowledgeWebBuilder() *AilyKnowledgeWebBuilder

func (*AilyKnowledgeWebBuilder) Build added in v3.2.6

func (builder *AilyKnowledgeWebBuilder) Build() *AilyKnowledgeWeb

func (*AilyKnowledgeWebBuilder) Title added in v3.2.6

网页标题

示例值:title

func (*AilyKnowledgeWebBuilder) Url added in v3.2.6

链接

示例值:xxx

type AilyKnowledgeWikiSpace added in v3.2.6

type AilyKnowledgeWikiSpace struct {
	Title *string `json:"title,omitempty"` // 知识空间标题

	SpaceId *string `json:"space_id,omitempty"` // 知识空间ID

	SubDocs []*AilyKnowledgeDocs `json:"sub_docs,omitempty"` // 子节点
}

type AilyKnowledgeWikiSpaceBuilder added in v3.2.6

type AilyKnowledgeWikiSpaceBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyKnowledgeWikiSpaceBuilder added in v3.2.6

func NewAilyKnowledgeWikiSpaceBuilder() *AilyKnowledgeWikiSpaceBuilder

func (*AilyKnowledgeWikiSpaceBuilder) Build added in v3.2.6

func (*AilyKnowledgeWikiSpaceBuilder) SpaceId added in v3.2.6

知识空间ID

示例值:123

func (*AilyKnowledgeWikiSpaceBuilder) SubDocs added in v3.2.6

子节点

示例值:

func (*AilyKnowledgeWikiSpaceBuilder) Title added in v3.2.6

知识空间标题

示例值:title

type AilyMention

type AilyMention struct {
	EntityId *string `json:"entity_id,omitempty"` // 实体 ID

	IdentityProvider *string `json:"identity_provider,omitempty"` // 身份提供者

	Key *string `json:"key,omitempty"` // 被@实体在消息体中的占位符

	Name *string `json:"name,omitempty"` // 被@实体的名称

	AilyId *string `json:"aily_id,omitempty"` // Aily 账号体系下的 ID
}

type AilyMentionBuilder

type AilyMentionBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMentionBuilder

func NewAilyMentionBuilder() *AilyMentionBuilder

func (*AilyMentionBuilder) AilyId

func (builder *AilyMentionBuilder) AilyId(ailyId string) *AilyMentionBuilder

Aily 账号体系下的 ID

示例值:1794840334557292

func (*AilyMentionBuilder) Build

func (builder *AilyMentionBuilder) Build() *AilyMention

func (*AilyMentionBuilder) EntityId

func (builder *AilyMentionBuilder) EntityId(entityId string) *AilyMentionBuilder

实体 ID

示例值:ou_5ad573a6411d72b8305fda3a9c15c70e

func (*AilyMentionBuilder) IdentityProvider

func (builder *AilyMentionBuilder) IdentityProvider(identityProvider string) *AilyMentionBuilder

身份提供者

示例值:FEISHU

func (*AilyMentionBuilder) Key

func (builder *AilyMentionBuilder) Key(key string) *AilyMentionBuilder

被@实体在消息体中的占位符

示例值:@_user_1

func (*AilyMentionBuilder) Name

func (builder *AilyMentionBuilder) Name(name string) *AilyMentionBuilder

被@实体的名称

示例值:张三

type AilyMessage

type AilyMessage struct {
	Id *string `json:"id,omitempty"` // 消息 ID

	SessionId *string `json:"session_id,omitempty"` // 会话 ID

	RunId *string `json:"run_id,omitempty"` // 运行 ID

	ContentType *string `json:"content_type,omitempty"` // 消息内容类型

	Content *string `json:"content,omitempty"` // 消息内容

	Files []*AilyMessageFile `json:"files,omitempty"` // 消息中包含的文件

	QuoteMessageId *string `json:"quote_message_id,omitempty"` // 引用的消息 ID

	Sender *AilySender `json:"sender,omitempty"` // 发送者

	Mentions []*AilyMention `json:"mentions,omitempty"` // 被@的实体

	PlainText *string `json:"plain_text,omitempty"` // 消息体的纯文本表达

	CreatedAt *string `json:"created_at,omitempty"` // 消息的创建时间,毫秒时间戳

	Status *string `json:"status,omitempty"` // 状态
}

type AilyMessageBuilder

type AilyMessageBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMessageBuilder

func NewAilyMessageBuilder() *AilyMessageBuilder

func (*AilyMessageBuilder) Build

func (builder *AilyMessageBuilder) Build() *AilyMessage

func (*AilyMessageBuilder) Content

func (builder *AilyMessageBuilder) Content(content string) *AilyMessageBuilder

消息内容

示例值:你好

func (*AilyMessageBuilder) ContentType

func (builder *AilyMessageBuilder) ContentType(contentType string) *AilyMessageBuilder

消息内容类型

示例值:MDX

func (*AilyMessageBuilder) CreatedAt

func (builder *AilyMessageBuilder) CreatedAt(createdAt string) *AilyMessageBuilder

消息的创建时间,毫秒时间戳

示例值:1711975665710

func (*AilyMessageBuilder) Files

func (builder *AilyMessageBuilder) Files(files []*AilyMessageFile) *AilyMessageBuilder

消息中包含的文件

示例值:

func (*AilyMessageBuilder) Id

func (builder *AilyMessageBuilder) Id(id string) *AilyMessageBuilder

消息 ID

示例值:message_4df45f2xknvcc

func (*AilyMessageBuilder) Mentions

func (builder *AilyMessageBuilder) Mentions(mentions []*AilyMention) *AilyMessageBuilder

被@的实体

示例值:

func (*AilyMessageBuilder) PlainText

func (builder *AilyMessageBuilder) PlainText(plainText string) *AilyMessageBuilder

消息体的纯文本表达

示例值:你好

func (*AilyMessageBuilder) QuoteMessageId

func (builder *AilyMessageBuilder) QuoteMessageId(quoteMessageId string) *AilyMessageBuilder

引用的消息 ID

示例值:message_4de9bpg70qskh

func (*AilyMessageBuilder) RunId

func (builder *AilyMessageBuilder) RunId(runId string) *AilyMessageBuilder

运行 ID

示例值:run_4dfrxvctjqzzj

func (*AilyMessageBuilder) Sender

func (builder *AilyMessageBuilder) Sender(sender *AilySender) *AilyMessageBuilder

发送者

示例值:

func (*AilyMessageBuilder) SessionId

func (builder *AilyMessageBuilder) SessionId(sessionId string) *AilyMessageBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*AilyMessageBuilder) Status

func (builder *AilyMessageBuilder) Status(status string) *AilyMessageBuilder

状态

示例值:IN_PROGRESS

type AilyMessageFile

type AilyMessageFile struct {
	Id *string `json:"id,omitempty"` // 文件 ID

	MimeType *string `json:"mime_type,omitempty"` // 文件类型,参见 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/MIME_types

	FileName *string `json:"file_name,omitempty"` // 文件名

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息

	CreatedAt *string `json:"created_at,omitempty"` // 文件的创建时间,毫秒时间戳

	PreviewUrl *AilyMessageFilePreview `json:"preview_url,omitempty"` // 文件预览链接
}

type AilyMessageFileBuilder

type AilyMessageFileBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMessageFileBuilder

func NewAilyMessageFileBuilder() *AilyMessageFileBuilder

func (*AilyMessageFileBuilder) Build

func (builder *AilyMessageFileBuilder) Build() *AilyMessageFile

func (*AilyMessageFileBuilder) CreatedAt

func (builder *AilyMessageFileBuilder) CreatedAt(createdAt string) *AilyMessageFileBuilder

文件的创建时间,毫秒时间戳

示例值:1711975665710

func (*AilyMessageFileBuilder) FileName

func (builder *AilyMessageFileBuilder) FileName(fileName string) *AilyMessageFileBuilder

文件名

示例值:发票.png

func (*AilyMessageFileBuilder) Id

文件 ID

示例值:file_4d9nu1ev3a2rq

func (*AilyMessageFileBuilder) Metadata

func (builder *AilyMessageFileBuilder) Metadata(metadata string) *AilyMessageFileBuilder

其他透传信息

示例值:{}

func (*AilyMessageFileBuilder) MimeType

func (builder *AilyMessageFileBuilder) MimeType(mimeType string) *AilyMessageFileBuilder

文件类型,参见 https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Basics_of_HTTP/MIME_types

示例值:image/png

func (*AilyMessageFileBuilder) PreviewUrl added in v3.2.8

func (builder *AilyMessageFileBuilder) PreviewUrl(previewUrl *AilyMessageFilePreview) *AilyMessageFileBuilder

文件预览链接

示例值:

type AilyMessageFileFilter added in v3.2.8

type AilyMessageFileFilter struct {
	WithPreviewUrl *bool `json:"with_preview_url,omitempty"` // 返回文件的预览链接
}

type AilyMessageFileFilterBuilder added in v3.2.8

type AilyMessageFileFilterBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMessageFileFilterBuilder added in v3.2.8

func NewAilyMessageFileFilterBuilder() *AilyMessageFileFilterBuilder

func (*AilyMessageFileFilterBuilder) Build added in v3.2.8

func (*AilyMessageFileFilterBuilder) WithPreviewUrl added in v3.2.8

func (builder *AilyMessageFileFilterBuilder) WithPreviewUrl(withPreviewUrl bool) *AilyMessageFileFilterBuilder

返回文件的预览链接

示例值:false

type AilyMessageFilePreview added in v3.2.8

type AilyMessageFilePreview struct {
	Url *string `json:"url,omitempty"` // 文件的 URL

	ExpiredAt *string `json:"expired_at,omitempty"` // url 过期时间,秒时间戳
}

type AilyMessageFilePreviewBuilder added in v3.2.8

type AilyMessageFilePreviewBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMessageFilePreviewBuilder added in v3.2.8

func NewAilyMessageFilePreviewBuilder() *AilyMessageFilePreviewBuilder

func (*AilyMessageFilePreviewBuilder) Build added in v3.2.8

func (*AilyMessageFilePreviewBuilder) ExpiredAt added in v3.2.8

url 过期时间,秒时间戳

示例值:1719413169

func (*AilyMessageFilePreviewBuilder) Url added in v3.2.8

文件的 URL

示例值:http://path_to_file

type AilyMessageFilter

type AilyMessageFilter struct {
	RunId *string `json:"run_id,omitempty"` // 运行 ID

	WithPartialMessage *bool `json:"with_partial_message,omitempty"` // 返回生成中的消息
}

type AilyMessageFilterBuilder

type AilyMessageFilterBuilder struct {
	// contains filtered or unexported fields
}

func NewAilyMessageFilterBuilder

func NewAilyMessageFilterBuilder() *AilyMessageFilterBuilder

func (*AilyMessageFilterBuilder) Build

func (builder *AilyMessageFilterBuilder) Build() *AilyMessageFilter

func (*AilyMessageFilterBuilder) RunId

运行 ID

示例值:run_4dfrxvctjqzzj

func (*AilyMessageFilterBuilder) WithPartialMessage

func (builder *AilyMessageFilterBuilder) WithPartialMessage(withPartialMessage bool) *AilyMessageFilterBuilder

返回生成中的消息

示例值:false

type AilySender

type AilySender struct {
	EntityId *string `json:"entity_id,omitempty"` // 实体 ID

	IdentityProvider *string `json:"identity_provider,omitempty"` // 身份提供者

	SenderType *string `json:"sender_type,omitempty"` // 发送人类型

	AilyId *string `json:"aily_id,omitempty"` // Aily 账号体系下的 ID
}

type AilySenderBuilder

type AilySenderBuilder struct {
	// contains filtered or unexported fields
}

func NewAilySenderBuilder

func NewAilySenderBuilder() *AilySenderBuilder

func (*AilySenderBuilder) AilyId

func (builder *AilySenderBuilder) AilyId(ailyId string) *AilySenderBuilder

Aily 账号体系下的 ID

示例值:1794840334557292

func (*AilySenderBuilder) Build

func (builder *AilySenderBuilder) Build() *AilySender

func (*AilySenderBuilder) EntityId

func (builder *AilySenderBuilder) EntityId(entityId string) *AilySenderBuilder

实体 ID

示例值:ou_5ad573a6411d72b8305fda3a9c15c70e

func (*AilySenderBuilder) IdentityProvider

func (builder *AilySenderBuilder) IdentityProvider(identityProvider string) *AilySenderBuilder

身份提供者

示例值:FEISHU

func (*AilySenderBuilder) SenderType

func (builder *AilySenderBuilder) SenderType(senderType string) *AilySenderBuilder

发送人类型

示例值:USER

type AilySession

type AilySession struct {
	Id *string `json:"id,omitempty"` // 会话 ID

	CreatedAt *string `json:"created_at,omitempty"` // 会话的创建时间,毫秒时间戳

	ModifiedAt *string `json:"modified_at,omitempty"` // 会话的上次更新时间,毫秒时间戳

	CreatedBy *string `json:"created_by,omitempty"` // 会话的创建人

	ChannelContext *string `json:"channel_context,omitempty"` // 渠道上下文

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息
}

type AilySessionBuilder

type AilySessionBuilder struct {
	// contains filtered or unexported fields
}

func NewAilySessionBuilder

func NewAilySessionBuilder() *AilySessionBuilder

func (*AilySessionBuilder) Build

func (builder *AilySessionBuilder) Build() *AilySession

func (*AilySessionBuilder) ChannelContext

func (builder *AilySessionBuilder) ChannelContext(channelContext string) *AilySessionBuilder

渠道上下文

示例值:{}

func (*AilySessionBuilder) CreatedAt

func (builder *AilySessionBuilder) CreatedAt(createdAt string) *AilySessionBuilder

会话的创建时间,毫秒时间戳

示例值:1711975665710

func (*AilySessionBuilder) CreatedBy

func (builder *AilySessionBuilder) CreatedBy(createdBy string) *AilySessionBuilder

会话的创建人

示例值:1794840334557292

func (*AilySessionBuilder) Id

func (builder *AilySessionBuilder) Id(id string) *AilySessionBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*AilySessionBuilder) Metadata

func (builder *AilySessionBuilder) Metadata(metadata string) *AilySessionBuilder

其他透传信息

示例值:{}

func (*AilySessionBuilder) ModifiedAt

func (builder *AilySessionBuilder) ModifiedAt(modifiedAt string) *AilySessionBuilder

会话的上次更新时间,毫秒时间戳

示例值:1711975665710

type App

type App struct {
	Id *string `json:"id,omitempty"` // aily app_id

	Label *string `json:"label,omitempty"` // 应用名称
}

type AppBuilder

type AppBuilder struct {
	// contains filtered or unexported fields
}

func NewAppBuilder

func NewAppBuilder() *AppBuilder

func (*AppBuilder) Build

func (builder *AppBuilder) Build() *App

func (*AppBuilder) Id

func (builder *AppBuilder) Id(id string) *AppBuilder

aily app_id

示例值:spring_xxx__c

func (*AppBuilder) Label

func (builder *AppBuilder) Label(label string) *AppBuilder

应用名称

示例值:应用A

type AskAppKnowledgePathReqBodyBuilder added in v3.3.7

type AskAppKnowledgePathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewAskAppKnowledgePathReqBodyBuilder added in v3.3.7

func NewAskAppKnowledgePathReqBodyBuilder() *AskAppKnowledgePathReqBodyBuilder

func (*AskAppKnowledgePathReqBodyBuilder) Build added in v3.3.7

func (*AskAppKnowledgePathReqBodyBuilder) DataAssetIds added in v3.3.7

func (builder *AskAppKnowledgePathReqBodyBuilder) DataAssetIds(dataAssetIds []string) *AskAppKnowledgePathReqBodyBuilder

控制知识问答所依据的数据知识范围

示例值:

func (*AskAppKnowledgePathReqBodyBuilder) DataAssetTagIds added in v3.3.7

func (builder *AskAppKnowledgePathReqBodyBuilder) DataAssetTagIds(dataAssetTagIds []string) *AskAppKnowledgePathReqBodyBuilder

控制知识问答所依据的数据知识分类范围

示例值:

func (*AskAppKnowledgePathReqBodyBuilder) Message added in v3.3.7

输入消息(当前仅支持纯文本输入)

示例值:

type AskAppKnowledgeReq added in v3.3.7

type AskAppKnowledgeReq struct {
	Body *AskAppKnowledgeReqBody `body:""`
	// contains filtered or unexported fields
}

type AskAppKnowledgeReqBody added in v3.3.7

type AskAppKnowledgeReqBody struct {
	Message *AilyKnowledgeMessage `json:"message,omitempty"` // 输入消息(当前仅支持纯文本输入)

	DataAssetIds []string `json:"data_asset_ids,omitempty"` // 控制知识问答所依据的数据知识范围

	DataAssetTagIds []string `json:"data_asset_tag_ids,omitempty"` // 控制知识问答所依据的数据知识分类范围
}

type AskAppKnowledgeReqBodyBuilder added in v3.3.7

type AskAppKnowledgeReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewAskAppKnowledgeReqBodyBuilder added in v3.3.7

func NewAskAppKnowledgeReqBodyBuilder() *AskAppKnowledgeReqBodyBuilder

func (*AskAppKnowledgeReqBodyBuilder) Build added in v3.3.7

func (*AskAppKnowledgeReqBodyBuilder) DataAssetIds added in v3.3.7

func (builder *AskAppKnowledgeReqBodyBuilder) DataAssetIds(dataAssetIds []string) *AskAppKnowledgeReqBodyBuilder

控制知识问答所依据的数据知识范围

示例值:

func (*AskAppKnowledgeReqBodyBuilder) DataAssetTagIds added in v3.3.7

func (builder *AskAppKnowledgeReqBodyBuilder) DataAssetTagIds(dataAssetTagIds []string) *AskAppKnowledgeReqBodyBuilder

控制知识问答所依据的数据知识分类范围

示例值:

func (*AskAppKnowledgeReqBodyBuilder) Message added in v3.3.7

输入消息(当前仅支持纯文本输入)

示例值:

type AskAppKnowledgeReqBuilder added in v3.3.7

type AskAppKnowledgeReqBuilder struct {
	// contains filtered or unexported fields
}

func NewAskAppKnowledgeReqBuilder added in v3.3.7

func NewAskAppKnowledgeReqBuilder() *AskAppKnowledgeReqBuilder

func (*AskAppKnowledgeReqBuilder) AppId added in v3.3.7

飞书智能伙伴搭建平台的AppID

示例值:spring_5862e4fea8__c

func (*AskAppKnowledgeReqBuilder) Body added in v3.3.7

执行一次数据知识问答

func (*AskAppKnowledgeReqBuilder) Build added in v3.3.7

type AskAppKnowledgeResp added in v3.3.7

type AskAppKnowledgeResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *AskAppKnowledgeRespData `json:"data"` // 业务数据
}

func (*AskAppKnowledgeResp) Success added in v3.3.7

func (resp *AskAppKnowledgeResp) Success() bool

type AskAppKnowledgeRespData added in v3.3.7

type AskAppKnowledgeRespData struct {
	Status *string `json:"status,omitempty"` // 响应状态,枚举值

	FinishType *string `json:"finish_type,omitempty"` // 结束类型,枚举值

	Message *AilyKnowledgeMessage `json:"message,omitempty"` // 响应消息

	ProcessData *AilyKnowledgeAskProcessData `json:"process_data,omitempty"` // 知识问答运行过程结构化数据,status=finished 且 finish_type=qa 时返回

	FaqResult *AilyKnowledgeFaq `json:"faq_result,omitempty"` // 匹配标准问答对结果,status=finished 且 finish_type=faq时返回

	HasAnswer *bool `json:"has_answer,omitempty"` // 是否有结果,true 则 代表 message 中的内容是通过配置知识而生成的
}

type BuiltinAction

type BuiltinAction struct {
	BuiltinActionType *string `json:"builtin_action_type,omitempty"` // 内置的消息交互类型

	Enable *bool `json:"enable,omitempty"` // 是否可交互

	ActionStatus *string `json:"action_status,omitempty"` // action 状态

	Extra *string `json:"extra,omitempty"` // action 的其它信息
}

type BuiltinActionBuilder

type BuiltinActionBuilder struct {
	// contains filtered or unexported fields
}

func NewBuiltinActionBuilder

func NewBuiltinActionBuilder() *BuiltinActionBuilder

func (*BuiltinActionBuilder) ActionStatus

func (builder *BuiltinActionBuilder) ActionStatus(actionStatus string) *BuiltinActionBuilder

action 状态

示例值:DISLIKE

func (*BuiltinActionBuilder) Build

func (builder *BuiltinActionBuilder) Build() *BuiltinAction

func (*BuiltinActionBuilder) BuiltinActionType

func (builder *BuiltinActionBuilder) BuiltinActionType(builtinActionType string) *BuiltinActionBuilder

内置的消息交互类型

示例值:CANCEL

func (*BuiltinActionBuilder) Enable

func (builder *BuiltinActionBuilder) Enable(enable bool) *BuiltinActionBuilder

是否可交互

示例值:true

func (*BuiltinActionBuilder) Extra

func (builder *BuiltinActionBuilder) Extra(extra string) *BuiltinActionBuilder

action 的其它信息

示例值:{}

type CancelAilySessionRunReq

type CancelAilySessionRunReq struct {
	// contains filtered or unexported fields
}

type CancelAilySessionRunReqBuilder

type CancelAilySessionRunReqBuilder struct {
	// contains filtered or unexported fields
}

func NewCancelAilySessionRunReqBuilder

func NewCancelAilySessionRunReqBuilder() *CancelAilySessionRunReqBuilder

func (*CancelAilySessionRunReqBuilder) AilySessionId

func (builder *CancelAilySessionRunReqBuilder) AilySessionId(ailySessionId string) *CancelAilySessionRunReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*CancelAilySessionRunReqBuilder) Build

func (*CancelAilySessionRunReqBuilder) RunId

运行 ID

示例值:run_4dfrxvctjqzzj

type CancelAilySessionRunResp

type CancelAilySessionRunResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CancelAilySessionRunRespData `json:"data"` // 业务数据
}

func (*CancelAilySessionRunResp) Success

func (resp *CancelAilySessionRunResp) Success() bool

type CancelAilySessionRunRespData

type CancelAilySessionRunRespData struct {
	Run *Run `json:"run,omitempty"` // 运行信息
}

type Channel added in v3.3.5

type Channel struct {
	Variables *string `json:"variables,omitempty"` // 自定义传入的变量
}

type ChannelBuilder added in v3.3.5

type ChannelBuilder struct {
	// contains filtered or unexported fields
}

func NewChannelBuilder added in v3.3.5

func NewChannelBuilder() *ChannelBuilder

func (*ChannelBuilder) Build added in v3.3.5

func (builder *ChannelBuilder) Build() *Channel

func (*ChannelBuilder) Variables added in v3.3.5

func (builder *ChannelBuilder) Variables(variables string) *ChannelBuilder

自定义传入的变量

示例值:{"custom_key": "custom_value"}

type CreateAilySessionAilyMessagePathReqBodyBuilder

type CreateAilySessionAilyMessagePathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionAilyMessagePathReqBodyBuilder

func NewCreateAilySessionAilyMessagePathReqBodyBuilder() *CreateAilySessionAilyMessagePathReqBodyBuilder

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) Build

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) Content

消息内容

示例值:你好

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) ContentType

消息内容类型

示例值:MDX

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) FileIds

消息中包含的文件 ID 列表

示例值:

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) IdempotentId

幂等id,同一 session 下相同的幂等 id 算一条消息,有效期72h

示例值:idempotent_id_1

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) Mentions

被@的实体

示例值:

func (*CreateAilySessionAilyMessagePathReqBodyBuilder) QuoteMessageId

引用的消息 ID

示例值:message_4de9bpg70qskh

type CreateAilySessionAilyMessageReq

type CreateAilySessionAilyMessageReq struct {
	Body *CreateAilySessionAilyMessageReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateAilySessionAilyMessageReqBody

type CreateAilySessionAilyMessageReqBody struct {
	IdempotentId *string `json:"idempotent_id,omitempty"` // 幂等id,同一 session 下相同的幂等 id 算一条消息,有效期72h

	ContentType *string `json:"content_type,omitempty"` // 消息内容类型

	Content *string `json:"content,omitempty"` // 消息内容

	FileIds []string `json:"file_ids,omitempty"` // 消息中包含的文件 ID 列表

	QuoteMessageId *string `json:"quote_message_id,omitempty"` // 引用的消息 ID

	Mentions []*AilyMention `json:"mentions,omitempty"` // 被@的实体
}

type CreateAilySessionAilyMessageReqBodyBuilder

type CreateAilySessionAilyMessageReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionAilyMessageReqBodyBuilder

func NewCreateAilySessionAilyMessageReqBodyBuilder() *CreateAilySessionAilyMessageReqBodyBuilder

func (*CreateAilySessionAilyMessageReqBodyBuilder) Build

func (*CreateAilySessionAilyMessageReqBodyBuilder) Content

消息内容

示例值:你好

func (*CreateAilySessionAilyMessageReqBodyBuilder) ContentType

消息内容类型

示例值:MDX

func (*CreateAilySessionAilyMessageReqBodyBuilder) FileIds

消息中包含的文件 ID 列表

示例值:

func (*CreateAilySessionAilyMessageReqBodyBuilder) IdempotentId

幂等id,同一 session 下相同的幂等 id 算一条消息,有效期72h

示例值:idempotent_id_1

func (*CreateAilySessionAilyMessageReqBodyBuilder) Mentions

被@的实体

示例值:

func (*CreateAilySessionAilyMessageReqBodyBuilder) QuoteMessageId

引用的消息 ID

示例值:message_4de9bpg70qskh

type CreateAilySessionAilyMessageReqBuilder

type CreateAilySessionAilyMessageReqBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionAilyMessageReqBuilder

func NewCreateAilySessionAilyMessageReqBuilder() *CreateAilySessionAilyMessageReqBuilder

func (*CreateAilySessionAilyMessageReqBuilder) AilySessionId

会话 ID

示例值:session_4dfunz7sp1g8m

func (*CreateAilySessionAilyMessageReqBuilder) Body

该 API 用于向某个飞书智能伙伴应用发送一条消息(Message)。

func (*CreateAilySessionAilyMessageReqBuilder) Build

type CreateAilySessionAilyMessageResp

type CreateAilySessionAilyMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateAilySessionAilyMessageRespData `json:"data"` // 业务数据
}

func (*CreateAilySessionAilyMessageResp) Success

func (resp *CreateAilySessionAilyMessageResp) Success() bool

type CreateAilySessionAilyMessageRespData

type CreateAilySessionAilyMessageRespData struct {
	Message *AilyMessage `json:"message,omitempty"` // 消息信息
}

type CreateAilySessionPathReqBodyBuilder

type CreateAilySessionPathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionPathReqBodyBuilder

func NewCreateAilySessionPathReqBodyBuilder() *CreateAilySessionPathReqBodyBuilder

func (*CreateAilySessionPathReqBodyBuilder) Build

func (*CreateAilySessionPathReqBodyBuilder) ChannelContext

func (builder *CreateAilySessionPathReqBodyBuilder) ChannelContext(channelContext string) *CreateAilySessionPathReqBodyBuilder

渠道上下文

示例值:{}

func (*CreateAilySessionPathReqBodyBuilder) Metadata

其他透传信息

示例值:{}

type CreateAilySessionReq

type CreateAilySessionReq struct {
	Body *CreateAilySessionReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateAilySessionReqBody

type CreateAilySessionReqBody struct {
	ChannelContext *string `json:"channel_context,omitempty"` // 渠道上下文

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息
}

type CreateAilySessionReqBodyBuilder

type CreateAilySessionReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionReqBodyBuilder

func NewCreateAilySessionReqBodyBuilder() *CreateAilySessionReqBodyBuilder

func (*CreateAilySessionReqBodyBuilder) Build

func (*CreateAilySessionReqBodyBuilder) ChannelContext

func (builder *CreateAilySessionReqBodyBuilder) ChannelContext(channelContext string) *CreateAilySessionReqBodyBuilder

渠道上下文

示例值:{}

func (*CreateAilySessionReqBodyBuilder) Metadata

其他透传信息

示例值:{}

type CreateAilySessionReqBuilder

type CreateAilySessionReqBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionReqBuilder

func NewCreateAilySessionReqBuilder() *CreateAilySessionReqBuilder

func (*CreateAilySessionReqBuilder) Body

该 API 用于创建与某个飞书智能伙伴应用的一次会话(Session)。

func (*CreateAilySessionReqBuilder) Build

type CreateAilySessionResp

type CreateAilySessionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateAilySessionRespData `json:"data"` // 业务数据
}

func (*CreateAilySessionResp) Success

func (resp *CreateAilySessionResp) Success() bool

type CreateAilySessionRespData

type CreateAilySessionRespData struct {
	Session *AilySession `json:"session,omitempty"` // 创建的会话信息
}

type CreateAilySessionRunPathReqBodyBuilder

type CreateAilySessionRunPathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionRunPathReqBodyBuilder

func NewCreateAilySessionRunPathReqBodyBuilder() *CreateAilySessionRunPathReqBodyBuilder

func (*CreateAilySessionRunPathReqBodyBuilder) AppId

应用 ID

示例值:spring_xxx__c

func (*CreateAilySessionRunPathReqBodyBuilder) Build

func (*CreateAilySessionRunPathReqBodyBuilder) Metadata

其他透传信息

示例值:{}

func (*CreateAilySessionRunPathReqBodyBuilder) SkillId

技能 ID

示例值:skill_6cc6166178ca

func (*CreateAilySessionRunPathReqBodyBuilder) SkillInput

指定技能 ID 时可以同时指定技能输入

示例值:{"key": "value"}

type CreateAilySessionRunReq

type CreateAilySessionRunReq struct {
	Body *CreateAilySessionRunReqBody `body:""`
	// contains filtered or unexported fields
}

type CreateAilySessionRunReqBody

type CreateAilySessionRunReqBody struct {
	AppId *string `json:"app_id,omitempty"` // 应用 ID

	SkillId *string `json:"skill_id,omitempty"` // 技能 ID

	SkillInput *string `json:"skill_input,omitempty"` // 指定技能 ID 时可以同时指定技能输入

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息
}

type CreateAilySessionRunReqBodyBuilder

type CreateAilySessionRunReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionRunReqBodyBuilder

func NewCreateAilySessionRunReqBodyBuilder() *CreateAilySessionRunReqBodyBuilder

func (*CreateAilySessionRunReqBodyBuilder) AppId

应用 ID

示例值:spring_xxx__c

func (*CreateAilySessionRunReqBodyBuilder) Build

func (*CreateAilySessionRunReqBodyBuilder) Metadata

其他透传信息

示例值:{}

func (*CreateAilySessionRunReqBodyBuilder) SkillId

技能 ID

示例值:skill_6cc6166178ca

func (*CreateAilySessionRunReqBodyBuilder) SkillInput

指定技能 ID 时可以同时指定技能输入

示例值:{"key": "value"}

type CreateAilySessionRunReqBuilder

type CreateAilySessionRunReqBuilder struct {
	// contains filtered or unexported fields
}

func NewCreateAilySessionRunReqBuilder

func NewCreateAilySessionRunReqBuilder() *CreateAilySessionRunReqBuilder

func (*CreateAilySessionRunReqBuilder) AilySessionId

func (builder *CreateAilySessionRunReqBuilder) AilySessionId(ailySessionId string) *CreateAilySessionRunReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*CreateAilySessionRunReqBuilder) Body

该 API 用于启动一次运行(Run)。

func (*CreateAilySessionRunReqBuilder) Build

type CreateAilySessionRunResp

type CreateAilySessionRunResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *CreateAilySessionRunRespData `json:"data"` // 业务数据
}

func (*CreateAilySessionRunResp) Success

func (resp *CreateAilySessionRunResp) Success() bool

type CreateAilySessionRunRespData

type CreateAilySessionRunRespData struct {
	Run *Run `json:"run,omitempty"` // 运行信息
}

type DataAsset added in v3.3.5

type DataAsset struct {
	DataAssetId *string `json:"data_asset_id,omitempty"` // 数据知识ID

	Label map[string]string `json:"label,omitempty"` // 数据知识标题

	Description map[string]string `json:"description,omitempty"` // 数据知识描述

	DataSourceType *string `json:"data_source_type,omitempty"` // 数据资源类型

	ConnectStatus *string `json:"connect_status,omitempty"` // 数据连接状态

	Tags []*DataAssetTag `json:"tags,omitempty"` // 数据知识分类列表

	Items []*DataAssetItem `json:"items,omitempty"` // 数据知识项列表

	ConnectFailedReason *string `json:"connect_failed_reason,omitempty"` // 连接状态失败信息

	ImportKnowledgeSetting *DataAssetImportKnowledgeSetting `json:"import_knowledge_setting,omitempty"` // 知识导入配置

	ConnectType *string `json:"connect_type,omitempty"` // 数据连接类型

	CreatedTime *string `json:"created_time,omitempty"` // 创建时间,毫秒时间戳

	UpdatedTime *string `json:"updated_time,omitempty"` // 更新时间,毫秒时间戳
}

type DataAssetBuilder added in v3.3.5

type DataAssetBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetBuilder added in v3.3.5

func NewDataAssetBuilder() *DataAssetBuilder

func (*DataAssetBuilder) Build added in v3.3.5

func (builder *DataAssetBuilder) Build() *DataAsset

func (*DataAssetBuilder) ConnectFailedReason added in v3.3.7

func (builder *DataAssetBuilder) ConnectFailedReason(connectFailedReason string) *DataAssetBuilder

连接状态失败信息

示例值:连接超时

func (*DataAssetBuilder) ConnectStatus added in v3.3.5

func (builder *DataAssetBuilder) ConnectStatus(connectStatus string) *DataAssetBuilder

数据连接状态

示例值:successful

func (*DataAssetBuilder) ConnectType added in v3.3.7

func (builder *DataAssetBuilder) ConnectType(connectType string) *DataAssetBuilder

数据连接类型

示例值:direct

func (*DataAssetBuilder) CreatedTime added in v3.3.7

func (builder *DataAssetBuilder) CreatedTime(createdTime string) *DataAssetBuilder

创建时间,毫秒时间戳

示例值:1711975665710

func (*DataAssetBuilder) DataAssetId added in v3.3.5

func (builder *DataAssetBuilder) DataAssetId(dataAssetId string) *DataAssetBuilder

数据知识ID

示例值:asset_aadg3mcgvpybu

func (*DataAssetBuilder) DataSourceType added in v3.3.5

func (builder *DataAssetBuilder) DataSourceType(dataSourceType string) *DataAssetBuilder

数据资源类型

示例值:excel

func (*DataAssetBuilder) Description added in v3.3.5

func (builder *DataAssetBuilder) Description(description map[string]string) *DataAssetBuilder

数据知识描述

示例值:

func (*DataAssetBuilder) ImportKnowledgeSetting added in v3.4.2

func (builder *DataAssetBuilder) ImportKnowledgeSetting(importKnowledgeSetting *DataAssetImportKnowledgeSetting) *DataAssetBuilder

知识导入配置

示例值:

func (*DataAssetBuilder) Items added in v3.3.5

func (builder *DataAssetBuilder) Items(items []*DataAssetItem) *DataAssetBuilder

数据知识项列表

示例值:

func (*DataAssetBuilder) Label added in v3.3.5

func (builder *DataAssetBuilder) Label(label map[string]string) *DataAssetBuilder

数据知识标题

示例值:

func (*DataAssetBuilder) Tags added in v3.3.5

func (builder *DataAssetBuilder) Tags(tags []*DataAssetTag) *DataAssetBuilder

数据知识分类列表

示例值:

func (*DataAssetBuilder) UpdatedTime added in v3.3.7

func (builder *DataAssetBuilder) UpdatedTime(updatedTime string) *DataAssetBuilder

更新时间,毫秒时间戳

示例值:1711975665710

type DataAssetFile added in v3.3.7

type DataAssetFile struct {
	Token *string `json:"token,omitempty"` // 文件token

	MimeType *string `json:"mime_type,omitempty"` // 文件内容类型
}

type DataAssetFileBuilder added in v3.3.7

type DataAssetFileBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetFileBuilder added in v3.3.7

func NewDataAssetFileBuilder() *DataAssetFileBuilder

func (*DataAssetFileBuilder) Build added in v3.3.7

func (builder *DataAssetFileBuilder) Build() *DataAssetFile

func (*DataAssetFileBuilder) MimeType added in v3.3.7

func (builder *DataAssetFileBuilder) MimeType(mimeType string) *DataAssetFileBuilder

文件内容类型

示例值:excel

func (*DataAssetFileBuilder) Token added in v3.3.7

func (builder *DataAssetFileBuilder) Token(token string) *DataAssetFileBuilder

文件token

示例值:file_token_abcd123

type DataAssetImportKnowledgeFile added in v3.3.7

type DataAssetImportKnowledgeFile struct {
	Title *string `json:"title,omitempty"` // 文件标题

	Token *string `json:"token,omitempty"` // 上传文件获取到的token。和content二选一,优先使用token。

	Content *string `json:"content,omitempty"` // 文件内容。和token二选一,优先使用token。有长度限制,大文件优先使用token方式。

	MimeType *string `json:"mime_type,omitempty"` // 文件内容对应的 MIME 类型,使用token方式必须填写

	Url *string `json:"url,omitempty"` // 文件源的URL
}

type DataAssetImportKnowledgeFileBuilder added in v3.3.7

type DataAssetImportKnowledgeFileBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeFileBuilder added in v3.3.7

func NewDataAssetImportKnowledgeFileBuilder() *DataAssetImportKnowledgeFileBuilder

func (*DataAssetImportKnowledgeFileBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeFileBuilder) Content added in v3.3.7

文件内容。和token二选一,优先使用token。有长度限制,大文件优先使用token方式。

示例值:这是文件内容

func (*DataAssetImportKnowledgeFileBuilder) MimeType added in v3.3.7

文件内容对应的 MIME 类型,使用token方式必须填写

示例值:.docx

func (*DataAssetImportKnowledgeFileBuilder) Title added in v3.3.7

文件标题

示例值:文件标题

func (*DataAssetImportKnowledgeFileBuilder) Token added in v3.3.7

上传文件获取到的token。和content二选一,优先使用token。

示例值:bb690637b49440b08f39459a2fdcd2ca

func (*DataAssetImportKnowledgeFileBuilder) Url added in v3.3.7

文件源的URL

示例值:https://document.com/1

type DataAssetImportKnowledgeHelpdesk added in v3.3.7

type DataAssetImportKnowledgeHelpdesk struct {
	HelpdeskId *string `json:"helpdesk_id,omitempty"` // 飞书服务台ID
}

type DataAssetImportKnowledgeHelpdeskBuilder added in v3.3.7

type DataAssetImportKnowledgeHelpdeskBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeHelpdeskBuilder added in v3.3.7

func NewDataAssetImportKnowledgeHelpdeskBuilder() *DataAssetImportKnowledgeHelpdeskBuilder

func (*DataAssetImportKnowledgeHelpdeskBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeHelpdeskBuilder) HelpdeskId added in v3.3.7

飞书服务台ID

示例值:123

type DataAssetImportKnowledgeLarkDoc added in v3.3.7

type DataAssetImportKnowledgeLarkDoc struct {
	Type *string `json:"type,omitempty"` // 云文档类型

	Token *string `json:"token,omitempty"` // 云文档标识

	WithSubDocs *bool `json:"with_sub_docs,omitempty"` // 是否包含子文档,只有wiki类型的云文档支持

	Url *string `json:"url,omitempty"` // 文档链接
}

type DataAssetImportKnowledgeLarkDocBuilder added in v3.3.7

type DataAssetImportKnowledgeLarkDocBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeLarkDocBuilder added in v3.3.7

func NewDataAssetImportKnowledgeLarkDocBuilder() *DataAssetImportKnowledgeLarkDocBuilder

func (*DataAssetImportKnowledgeLarkDocBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeLarkDocBuilder) Token added in v3.3.7

云文档标识

示例值:T8FAcuilgC1fdaxkt58vcp91xngh

func (*DataAssetImportKnowledgeLarkDocBuilder) Type added in v3.3.7

云文档类型

示例值:docx

func (*DataAssetImportKnowledgeLarkDocBuilder) Url added in v3.4.2

文档链接

示例值:https://abc.feihsu.cn/docx/abcd123

func (*DataAssetImportKnowledgeLarkDocBuilder) WithSubDocs added in v3.3.7

是否包含子文档,只有wiki类型的云文档支持

示例值:

type DataAssetImportKnowledgeSetting added in v3.3.7

type DataAssetImportKnowledgeSetting struct {
	ChunkSetting *DataAssetKnowledgeChunkSetting `json:"chunk_setting,omitempty"` // 知识切片配置

	File *DataAssetImportKnowledgeFile `json:"file,omitempty"` // 知识导入-文件

	LarkDoc *DataAssetImportKnowledgeLarkDoc `json:"lark_doc,omitempty"` // 知识导入-飞书云文档

	LarkWikiSpace *DataAssetImportKnowledgeWiki `json:"lark_wiki_space,omitempty"` // 知识导入-飞书知识空间

	LarkHelpdesk *DataAssetImportKnowledgeHelpdesk `json:"lark_helpdesk,omitempty"` // 知识导入-飞书服务台
}

type DataAssetImportKnowledgeSettingBuilder added in v3.3.7

type DataAssetImportKnowledgeSettingBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeSettingBuilder added in v3.3.7

func NewDataAssetImportKnowledgeSettingBuilder() *DataAssetImportKnowledgeSettingBuilder

func (*DataAssetImportKnowledgeSettingBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeSettingBuilder) ChunkSetting added in v3.3.7

知识切片配置

示例值:

func (*DataAssetImportKnowledgeSettingBuilder) File added in v3.3.7

知识导入-文件

示例值:

func (*DataAssetImportKnowledgeSettingBuilder) LarkDoc added in v3.3.7

知识导入-飞书云文档

示例值:

func (*DataAssetImportKnowledgeSettingBuilder) LarkHelpdesk added in v3.3.7

知识导入-飞书服务台

示例值:

func (*DataAssetImportKnowledgeSettingBuilder) LarkWikiSpace added in v3.3.7

知识导入-飞书知识空间

示例值:

type DataAssetImportKnowledgeWiki added in v3.3.7

type DataAssetImportKnowledgeWiki struct {
	SpaceId *string `json:"space_id,omitempty"` // 飞书知识空间ID

	SubDocs []*DataAssetImportKnowledgeWikiSubDoc `json:"sub_docs,omitempty"` // 指定知识空间子节点时使用

	Url *string `json:"url,omitempty"` // 知识空间URL
}

type DataAssetImportKnowledgeWikiBuilder added in v3.3.7

type DataAssetImportKnowledgeWikiBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeWikiBuilder added in v3.3.7

func NewDataAssetImportKnowledgeWikiBuilder() *DataAssetImportKnowledgeWikiBuilder

func (*DataAssetImportKnowledgeWikiBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeWikiBuilder) SpaceId added in v3.3.7

飞书知识空间ID

示例值:798546548961351

func (*DataAssetImportKnowledgeWikiBuilder) SubDocs added in v3.3.7

指定知识空间子节点时使用

示例值:

func (*DataAssetImportKnowledgeWikiBuilder) Url added in v3.3.7

知识空间URL

示例值:https://ai-tenant.feishu-boe.cn/wiki/space/7283525110814736404

type DataAssetImportKnowledgeWikiSubDoc added in v3.3.7

type DataAssetImportKnowledgeWikiSubDoc struct {
	Type *string `json:"type,omitempty"` // 云文档类型,只支持wiki中的云文档

	Token *string `json:"token,omitempty"` // 云文档标识

	Url *string `json:"url,omitempty"` // 云文档链接
}

type DataAssetImportKnowledgeWikiSubDocBuilder added in v3.3.7

type DataAssetImportKnowledgeWikiSubDocBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetImportKnowledgeWikiSubDocBuilder added in v3.3.7

func NewDataAssetImportKnowledgeWikiSubDocBuilder() *DataAssetImportKnowledgeWikiSubDocBuilder

func (*DataAssetImportKnowledgeWikiSubDocBuilder) Build added in v3.3.7

func (*DataAssetImportKnowledgeWikiSubDocBuilder) Token added in v3.3.7

云文档标识

示例值:T8FAcuilgC1fdaxkt58vcp91xngh

func (*DataAssetImportKnowledgeWikiSubDocBuilder) Type added in v3.3.7

云文档类型,只支持wiki中的云文档

示例值:wiki

func (*DataAssetImportKnowledgeWikiSubDocBuilder) Url added in v3.3.7

云文档链接

示例值:https://cdas.feishu.cn/wiki/fdisu1

type DataAssetItem added in v3.3.5

type DataAssetItem struct {
	DataAssetItemId *string `json:"data_asset_item_id,omitempty"` // 数据知识项ID

	ApiName *string `json:"api_name,omitempty"` // 数据知识项标识

	Label map[string]string `json:"label,omitempty"` // 数据知识项标题

	Description map[string]string `json:"description,omitempty"` // 数据知识项描述

	Resources []*DataAssetResource `json:"resources,omitempty"` // 数据知识资源
}

type DataAssetItemBuilder added in v3.3.5

type DataAssetItemBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetItemBuilder added in v3.3.5

func NewDataAssetItemBuilder() *DataAssetItemBuilder

func (*DataAssetItemBuilder) ApiName added in v3.3.5

func (builder *DataAssetItemBuilder) ApiName(apiName string) *DataAssetItemBuilder

数据知识项标识

示例值:movie

func (*DataAssetItemBuilder) Build added in v3.3.5

func (builder *DataAssetItemBuilder) Build() *DataAssetItem

func (*DataAssetItemBuilder) DataAssetItemId added in v3.3.5

func (builder *DataAssetItemBuilder) DataAssetItemId(dataAssetItemId string) *DataAssetItemBuilder

数据知识项ID

示例值:asset_item_aadg3mcgvpydu

func (*DataAssetItemBuilder) Description added in v3.3.5

func (builder *DataAssetItemBuilder) Description(description map[string]string) *DataAssetItemBuilder

数据知识项描述

示例值:

func (*DataAssetItemBuilder) Label added in v3.3.5

func (builder *DataAssetItemBuilder) Label(label map[string]string) *DataAssetItemBuilder

数据知识项标题

示例值:

func (*DataAssetItemBuilder) Resources added in v3.3.5

func (builder *DataAssetItemBuilder) Resources(resources []*DataAssetResource) *DataAssetItemBuilder

数据知识资源

示例值:

type DataAssetKnowledgeChunkSetting added in v3.3.7

type DataAssetKnowledgeChunkSetting struct {
	RuleType *string `json:"rule_type,omitempty"` // 切片规则

	SeparateType *string `json:"separate_type,omitempty"` // 切片分割符类型

	Size *int `json:"size,omitempty"` // 分段最大长度(字符),按标识符切片时必须填写

	Overlap *int `json:"overlap,omitempty"` // 分段重叠字符数,按标识符切片时必须填写,不能超过size的数值
}

type DataAssetKnowledgeChunkSettingBuilder added in v3.3.7

type DataAssetKnowledgeChunkSettingBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetKnowledgeChunkSettingBuilder added in v3.3.7

func NewDataAssetKnowledgeChunkSettingBuilder() *DataAssetKnowledgeChunkSettingBuilder

func (*DataAssetKnowledgeChunkSettingBuilder) Build added in v3.3.7

func (*DataAssetKnowledgeChunkSettingBuilder) Overlap added in v3.3.7

分段重叠字符数,按标识符切片时必须填写,不能超过size的数值

示例值:10

func (*DataAssetKnowledgeChunkSettingBuilder) RuleType added in v3.3.7

切片规则

示例值:intelligent

func (*DataAssetKnowledgeChunkSettingBuilder) SeparateType added in v3.3.7

切片分割符类型

示例值:paragraph

func (*DataAssetKnowledgeChunkSettingBuilder) Size added in v3.3.7

分段最大长度(字符),按标识符切片时必须填写

示例值:600

type DataAssetResource added in v3.3.5

type DataAssetResource struct {
	ResourceId *string `json:"resource_id,omitempty"` // 数据知识资源ID

	ResouceType *string `json:"resouce_type,omitempty"` // 数据知识资源类型

	ResourceType *string `json:"resource_type,omitempty"` // 数据知识资源类型
}

type DataAssetResourceBuilder added in v3.3.5

type DataAssetResourceBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetResourceBuilder added in v3.3.5

func NewDataAssetResourceBuilder() *DataAssetResourceBuilder

func (*DataAssetResourceBuilder) Build added in v3.3.5

func (builder *DataAssetResourceBuilder) Build() *DataAssetResource

func (*DataAssetResourceBuilder) ResouceType added in v3.3.5

func (builder *DataAssetResourceBuilder) ResouceType(resouceType string) *DataAssetResourceBuilder

数据知识资源类型

示例值:dataset

func (*DataAssetResourceBuilder) ResourceId added in v3.3.5

func (builder *DataAssetResourceBuilder) ResourceId(resourceId string) *DataAssetResourceBuilder

数据知识资源ID

示例值:spring_5862e4fea8__c__dataset_aadg3lxm4j6mg

func (*DataAssetResourceBuilder) ResourceType added in v3.3.7

func (builder *DataAssetResourceBuilder) ResourceType(resourceType string) *DataAssetResourceBuilder

数据知识资源类型

示例值:dataset

type DataAssetTag added in v3.3.5

type DataAssetTag struct {
	DataAssetTagId *string `json:"data_asset_tag_id,omitempty"` // 数据知识分类名称

	Name *string `json:"name,omitempty"` // 数据知识分类ID
}

type DataAssetTagBuilder added in v3.3.5

type DataAssetTagBuilder struct {
	// contains filtered or unexported fields
}

func NewDataAssetTagBuilder added in v3.3.5

func NewDataAssetTagBuilder() *DataAssetTagBuilder

func (*DataAssetTagBuilder) Build added in v3.3.5

func (builder *DataAssetTagBuilder) Build() *DataAssetTag

func (*DataAssetTagBuilder) DataAssetTagId added in v3.3.5

func (builder *DataAssetTagBuilder) DataAssetTagId(dataAssetTagId string) *DataAssetTagBuilder

数据知识分类名称

示例值:spring_5862e4fea8__c__asset_tag_aadg2b5ql4gbs

func (*DataAssetTagBuilder) Name added in v3.3.5

func (builder *DataAssetTagBuilder) Name(name string) *DataAssetTagBuilder

数据知识分类ID

示例值:电影

type DatasetSource

type DatasetSource struct {
	Type *string `json:"type,omitempty"` // 分析表类型:object/external/dataflow

	Settings *SourceSetting `json:"settings,omitempty"` // 分析表数据源信息配置
}

type DatasetSourceBuilder

type DatasetSourceBuilder struct {
	// contains filtered or unexported fields
}

func NewDatasetSourceBuilder

func NewDatasetSourceBuilder() *DatasetSourceBuilder

func (*DatasetSourceBuilder) Build

func (builder *DatasetSourceBuilder) Build() *DatasetSource

func (*DatasetSourceBuilder) Settings

func (builder *DatasetSourceBuilder) Settings(settings *SourceSetting) *DatasetSourceBuilder

分析表数据源信息配置

示例值:

func (*DatasetSourceBuilder) Type

func (builder *DatasetSourceBuilder) Type(type_ string) *DatasetSourceBuilder

分析表类型:object/external/dataflow

示例值:object

type DeleteAilySessionReq

type DeleteAilySessionReq struct {
	// contains filtered or unexported fields
}

type DeleteAilySessionReqBuilder

type DeleteAilySessionReqBuilder struct {
	// contains filtered or unexported fields
}

func NewDeleteAilySessionReqBuilder

func NewDeleteAilySessionReqBuilder() *DeleteAilySessionReqBuilder

func (*DeleteAilySessionReqBuilder) AilySessionId

func (builder *DeleteAilySessionReqBuilder) AilySessionId(ailySessionId string) *DeleteAilySessionReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*DeleteAilySessionReqBuilder) Build

type DeleteAilySessionResp

type DeleteAilySessionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
}

func (*DeleteAilySessionResp) Success

func (resp *DeleteAilySessionResp) Success() bool

type DepartmentId

type DepartmentId struct {
	DepartmentId *string `json:"department_id,omitempty"` //

	OpenDepartmentId *string `json:"open_department_id,omitempty"` //
}

type DepartmentIdBuilder

type DepartmentIdBuilder struct {
	// contains filtered or unexported fields
}

func NewDepartmentIdBuilder

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId

func (builder *DepartmentIdBuilder) DepartmentId(departmentId string) *DepartmentIdBuilder

示例值:

func (*DepartmentIdBuilder) OpenDepartmentId

func (builder *DepartmentIdBuilder) OpenDepartmentId(openDepartmentId string) *DepartmentIdBuilder

示例值:

type Field

type Field struct {
	ApiName *string `json:"api_name,omitempty"` // 字段标识

	Label map[string]string `json:"label,omitempty"` // 字段名称

	AiDescription *string `json:"ai_description,omitempty"` // 字段描述信息

	AccessItems []string `json:"access_items,omitempty"` // 字段值读写权限

	TypeName *string `json:"type_name,omitempty"` // 字段的类型

	FieldSetting *FieldSetting `json:"field_setting,omitempty"` // 字段的属性
}

type FieldBuilder

type FieldBuilder struct {
	// contains filtered or unexported fields
}

func NewFieldBuilder

func NewFieldBuilder() *FieldBuilder

func (*FieldBuilder) AccessItems

func (builder *FieldBuilder) AccessItems(accessItems []string) *FieldBuilder

字段值读写权限

示例值:

func (*FieldBuilder) AiDescription

func (builder *FieldBuilder) AiDescription(aiDescription string) *FieldBuilder

字段描述信息

示例值:这是一个商品的数据表

func (*FieldBuilder) ApiName

func (builder *FieldBuilder) ApiName(apiName string) *FieldBuilder

字段标识

示例值:object_a

func (*FieldBuilder) Build

func (builder *FieldBuilder) Build() *Field

func (*FieldBuilder) FieldSetting

func (builder *FieldBuilder) FieldSetting(fieldSetting *FieldSetting) *FieldBuilder

字段的属性

示例值:

func (*FieldBuilder) Label

func (builder *FieldBuilder) Label(label map[string]string) *FieldBuilder

字段名称

示例值:

func (*FieldBuilder) TypeName

func (builder *FieldBuilder) TypeName(typeName string) *FieldBuilder

字段的类型

示例值:bool

type FieldSetting

type FieldSetting struct {
	Required *bool `json:"required,omitempty"` // 必填属性

	Unique *bool `json:"unique,omitempty"` // 唯一性属性

	CaseSensitive *bool `json:"case_sensitive,omitempty"` // 大小写敏感的唯一性

	TextMaxLength *int `json:"text_max_length,omitempty"` // 文本最大长度

	Multiple *bool `json:"multiple,omitempty"` // 是否多值

	LookupObjectApiName *string `json:"lookup_object_api_name,omitempty"` // 关联对象的标识

	Options []string `json:"options,omitempty"` // 选项字段的选项值

	Detail *string `json:"detail,omitempty"` // 属性扩展信息
}

type FieldSettingBuilder

type FieldSettingBuilder struct {
	// contains filtered or unexported fields
}

func NewFieldSettingBuilder

func NewFieldSettingBuilder() *FieldSettingBuilder

func (*FieldSettingBuilder) Build

func (builder *FieldSettingBuilder) Build() *FieldSetting

func (*FieldSettingBuilder) CaseSensitive

func (builder *FieldSettingBuilder) CaseSensitive(caseSensitive bool) *FieldSettingBuilder

大小写敏感的唯一性

示例值:

func (*FieldSettingBuilder) Detail

func (builder *FieldSettingBuilder) Detail(detail string) *FieldSettingBuilder

属性扩展信息

示例值:[ { "label": { "zh_cn": "示例文本", "en_us": "Sample text" }, "api_name": "optionA", "description":{ "zh_cn": "示例文本", "en_us": "Sample text" }, "color": "R", "active": true } ]

func (*FieldSettingBuilder) LookupObjectApiName

func (builder *FieldSettingBuilder) LookupObjectApiName(lookupObjectApiName string) *FieldSettingBuilder

关联对象的标识

示例值:_user

func (*FieldSettingBuilder) Multiple

func (builder *FieldSettingBuilder) Multiple(multiple bool) *FieldSettingBuilder

是否多值

示例值:

func (*FieldSettingBuilder) Options

func (builder *FieldSettingBuilder) Options(options []string) *FieldSettingBuilder

选项字段的选项值

示例值:

func (*FieldSettingBuilder) Required

func (builder *FieldSettingBuilder) Required(required bool) *FieldSettingBuilder

必填属性

示例值:false

func (*FieldSettingBuilder) TextMaxLength

func (builder *FieldSettingBuilder) TextMaxLength(textMaxLength int) *FieldSettingBuilder

文本最大长度

示例值:200

func (*FieldSettingBuilder) Unique

func (builder *FieldSettingBuilder) Unique(unique bool) *FieldSettingBuilder

唯一性属性

示例值:

type GetAilySessionAilyMessageReq

type GetAilySessionAilyMessageReq struct {
	// contains filtered or unexported fields
}

type GetAilySessionAilyMessageReqBuilder

type GetAilySessionAilyMessageReqBuilder struct {
	// contains filtered or unexported fields
}

func NewGetAilySessionAilyMessageReqBuilder

func NewGetAilySessionAilyMessageReqBuilder() *GetAilySessionAilyMessageReqBuilder

func (*GetAilySessionAilyMessageReqBuilder) AilyMessageId

消息 ID

示例值:message_4df45f2xknvcc

func (*GetAilySessionAilyMessageReqBuilder) AilySessionId

会话 ID

示例值:session_4dfunz7sp1g8m

func (*GetAilySessionAilyMessageReqBuilder) Build

type GetAilySessionAilyMessageResp

type GetAilySessionAilyMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetAilySessionAilyMessageRespData `json:"data"` // 业务数据
}

func (*GetAilySessionAilyMessageResp) Success

func (resp *GetAilySessionAilyMessageResp) Success() bool

type GetAilySessionAilyMessageRespData

type GetAilySessionAilyMessageRespData struct {
	Message *AilyMessage `json:"message,omitempty"` // 消息信息
}

type GetAilySessionReq

type GetAilySessionReq struct {
	// contains filtered or unexported fields
}

type GetAilySessionReqBuilder

type GetAilySessionReqBuilder struct {
	// contains filtered or unexported fields
}

func NewGetAilySessionReqBuilder

func NewGetAilySessionReqBuilder() *GetAilySessionReqBuilder

func (*GetAilySessionReqBuilder) AilySessionId

func (builder *GetAilySessionReqBuilder) AilySessionId(ailySessionId string) *GetAilySessionReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*GetAilySessionReqBuilder) Build

func (builder *GetAilySessionReqBuilder) Build() *GetAilySessionReq

type GetAilySessionResp

type GetAilySessionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetAilySessionRespData `json:"data"` // 业务数据
}

func (*GetAilySessionResp) Success

func (resp *GetAilySessionResp) Success() bool

type GetAilySessionRespData

type GetAilySessionRespData struct {
	Session *AilySession `json:"session,omitempty"` // 会话信息
}

type GetAilySessionRunReq

type GetAilySessionRunReq struct {
	// contains filtered or unexported fields
}

type GetAilySessionRunReqBuilder

type GetAilySessionRunReqBuilder struct {
	// contains filtered or unexported fields
}

func NewGetAilySessionRunReqBuilder

func NewGetAilySessionRunReqBuilder() *GetAilySessionRunReqBuilder

func (*GetAilySessionRunReqBuilder) AilySessionId

func (builder *GetAilySessionRunReqBuilder) AilySessionId(ailySessionId string) *GetAilySessionRunReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*GetAilySessionRunReqBuilder) Build

func (*GetAilySessionRunReqBuilder) RunId

运行 ID

示例值:run_4dfrxvctjqzzj

type GetAilySessionRunResp

type GetAilySessionRunResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetAilySessionRunRespData `json:"data"` // 业务数据
}

func (*GetAilySessionRunResp) Success

func (resp *GetAilySessionRunResp) Success() bool

type GetAilySessionRunRespData

type GetAilySessionRunRespData struct {
	Run *Run `json:"run,omitempty"` // 运行信息
}

type GetAppSkillReq added in v3.3.7

type GetAppSkillReq struct {
	// contains filtered or unexported fields
}

type GetAppSkillReqBuilder added in v3.3.7

type GetAppSkillReqBuilder struct {
	// contains filtered or unexported fields
}

func NewGetAppSkillReqBuilder added in v3.3.7

func NewGetAppSkillReqBuilder() *GetAppSkillReqBuilder

func (*GetAppSkillReqBuilder) AppId added in v3.3.7

func (builder *GetAppSkillReqBuilder) AppId(appId string) *GetAppSkillReqBuilder

应用 ID

示例值:spring_xxx__c

func (*GetAppSkillReqBuilder) Build added in v3.3.7

func (builder *GetAppSkillReqBuilder) Build() *GetAppSkillReq

func (*GetAppSkillReqBuilder) SkillId added in v3.3.7

func (builder *GetAppSkillReqBuilder) SkillId(skillId string) *GetAppSkillReqBuilder

技能 ID

示例值:skill_6cc6166178ca

type GetAppSkillResp added in v3.3.7

type GetAppSkillResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *GetAppSkillRespData `json:"data"` // 业务数据
}

func (*GetAppSkillResp) Success added in v3.3.7

func (resp *GetAppSkillResp) Success() bool

type GetAppSkillRespData added in v3.3.7

type GetAppSkillRespData struct {
	Skill *Skill `json:"skill,omitempty"` // 技能信息
}

type Intent

type Intent struct {
	Id *string `json:"id,omitempty"` // 意图 id

	CreatedAt *string `json:"created_at,omitempty"` // 意图创建时间,毫秒时间戳

	SessionId *string `json:"session_id,omitempty"` // 意图所属会话 id

	Status *string `json:"status,omitempty"` // 意图状态

	SubStatus *string `json:"sub_status,omitempty"` // 意图子状态

	ChannelType *string `json:"channel_type,omitempty"` // 渠道类型

	Error *MessageError `json:"error,omitempty"` // 意图失败原因
}

type IntentBuilder

type IntentBuilder struct {
	// contains filtered or unexported fields
}

func NewIntentBuilder

func NewIntentBuilder() *IntentBuilder

func (*IntentBuilder) Build

func (builder *IntentBuilder) Build() *Intent

func (*IntentBuilder) ChannelType

func (builder *IntentBuilder) ChannelType(channelType string) *IntentBuilder

渠道类型

示例值:LARK_OPEN_API

func (*IntentBuilder) CreatedAt

func (builder *IntentBuilder) CreatedAt(createdAt string) *IntentBuilder

意图创建时间,毫秒时间戳

示例值:1703658042000

func (*IntentBuilder) Error

func (builder *IntentBuilder) Error(error *MessageError) *IntentBuilder

意图失败原因

示例值:

func (*IntentBuilder) Id

func (builder *IntentBuilder) Id(id string) *IntentBuilder

意图 id

示例值:7317093049367298068

func (*IntentBuilder) SessionId

func (builder *IntentBuilder) SessionId(sessionId string) *IntentBuilder

意图所属会话 id

示例值:7317091019140972563

func (*IntentBuilder) Status

func (builder *IntentBuilder) Status(status string) *IntentBuilder

意图状态

示例值:RUNNING

func (*IntentBuilder) SubStatus

func (builder *IntentBuilder) SubStatus(subStatus string) *IntentBuilder

意图子状态

示例值:WAITING_USER_RESPOND

type Kctx

type Kctx struct {
	TenantId *int `json:"tenant_id,omitempty"` // 租户 id

	UserId *int `json:"user_id,omitempty"` // 用户 id

	TenantDomainName *string `json:"tenant_domain_name,omitempty"` // 租户域名

	UserSetting *string `json:"user_setting,omitempty"` // 用户设置

	LangId *int `json:"lang_id,omitempty"` // 语言

	RequestId *string `json:"request_id,omitempty"` // 请求 id

	Host *string `json:"host,omitempty"` // 域名

	TenantResourceRouteKey *string `json:"tenant_resource_route_key,omitempty"` // 资源路由 key

	Namespace *string `json:"namespace,omitempty"` // 命名空间

	TenantType *int `json:"tenant_type,omitempty"` // 租户类型

	TransactionId *int `json:"transaction_id,omitempty"` // 事务ID

	ConsistencyRetryType *string `json:"ConsistencyRetryType,omitempty"` // consistency retry type

	PsmLink *string `json:"PsmLink,omitempty"` // psm link

	BreakoutRetryPsm *string `json:"BreakoutRetryPsm,omitempty"` // breakout retry psm

	CredentialID *string `json:"CredentialID,omitempty"` // credential id

	AuthenticationType *string `json:"AuthenticationType,omitempty"` // 鉴权类型
}

type KctxBuilder

type KctxBuilder struct {
	// contains filtered or unexported fields
}

func NewKctxBuilder

func NewKctxBuilder() *KctxBuilder

func (*KctxBuilder) AuthenticationType

func (builder *KctxBuilder) AuthenticationType(authenticationType string) *KctxBuilder

鉴权类型

示例值:user

func (*KctxBuilder) BreakoutRetryPsm

func (builder *KctxBuilder) BreakoutRetryPsm(breakoutRetryPsm string) *KctxBuilder

breakout retry psm

示例值:a

func (*KctxBuilder) Build

func (builder *KctxBuilder) Build() *Kctx

func (*KctxBuilder) ConsistencyRetryType

func (builder *KctxBuilder) ConsistencyRetryType(consistencyRetryType string) *KctxBuilder

consistency retry type

示例值:a

func (*KctxBuilder) CredentialID

func (builder *KctxBuilder) CredentialID(credentialID string) *KctxBuilder

credential id

示例值:a

func (*KctxBuilder) Host

func (builder *KctxBuilder) Host(host string) *KctxBuilder

域名

示例值:a

func (*KctxBuilder) LangId

func (builder *KctxBuilder) LangId(langId int) *KctxBuilder

语言

示例值:1033

func (*KctxBuilder) Namespace

func (builder *KctxBuilder) Namespace(namespace string) *KctxBuilder

命名空间

示例值:package_abc

func (builder *KctxBuilder) PsmLink(psmLink string) *KctxBuilder

psm link

示例值:a

func (*KctxBuilder) RequestId

func (builder *KctxBuilder) RequestId(requestId string) *KctxBuilder

请求 id

示例值:a

func (*KctxBuilder) TenantDomainName

func (builder *KctxBuilder) TenantDomainName(tenantDomainName string) *KctxBuilder

租户域名

示例值:apaas

func (*KctxBuilder) TenantId

func (builder *KctxBuilder) TenantId(tenantId int) *KctxBuilder

租户 id

示例值:0

func (*KctxBuilder) TenantResourceRouteKey

func (builder *KctxBuilder) TenantResourceRouteKey(tenantResourceRouteKey string) *KctxBuilder

资源路由 key

示例值:"a"

func (*KctxBuilder) TenantType

func (builder *KctxBuilder) TenantType(tenantType int) *KctxBuilder

租户类型

示例值:1

func (*KctxBuilder) TransactionId

func (builder *KctxBuilder) TransactionId(transactionId int) *KctxBuilder

事务ID

示例值:0

func (*KctxBuilder) UserId

func (builder *KctxBuilder) UserId(userId int) *KctxBuilder

用户 id

示例值:

func (*KctxBuilder) UserSetting

func (builder *KctxBuilder) UserSetting(userSetting string) *KctxBuilder

用户设置

示例值:"{}"

type Knowledge added in v3.2.6

type Knowledge struct {
	Id *string `json:"id,omitempty"` // 知识ID

	KnowledgeBaseId *string `json:"knowledge_base_id,omitempty"` // 知识库ID

	Status *string `json:"status,omitempty"` // 学习状态

	Title *string `json:"title,omitempty"` // 知识标题

	Type *string `json:"type,omitempty"` // 知识类型

	File *AilyKnowledgeFile `json:"file,omitempty"` // 文件信息

	Docs *AilyKnowledgeDocs `json:"docs,omitempty"` // 飞书云文档信息

	WikiSpace *AilyKnowledgeWikiSpace `json:"wiki_space,omitempty"` // 飞书知识空间信息

	Folder *AilyKnowledgeFolder `json:"folder,omitempty"` // 飞书文件夹信息

	Helpdesk *AilyKnowledgeHelpdesk `json:"helpdesk,omitempty"` // 飞书服务台信息

	Datatable *AilyKnowledgeDatatable `json:"datatable,omitempty"` // 智能伙伴数据表

	Dataset *AilyKnowledgeDataset `json:"dataset,omitempty"` // 智能伙伴分析表

	Web *AilyKnowledgeWeb `json:"web,omitempty"` // 网页信息

	ChunkCount *int `json:"chunk_count,omitempty"` // 切片数量

	CreateTime *int `json:"create_time,omitempty"` // 创建时间

	UpdateTime *int `json:"update_time,omitempty"` // 更新时间

	FailMessage *string `json:"fail_message,omitempty"` // 学习失败提示
}

type KnowledgeBuilder added in v3.2.6

type KnowledgeBuilder struct {
	// contains filtered or unexported fields
}

func NewKnowledgeBuilder added in v3.2.6

func NewKnowledgeBuilder() *KnowledgeBuilder

func (*KnowledgeBuilder) Build added in v3.2.6

func (builder *KnowledgeBuilder) Build() *Knowledge

func (*KnowledgeBuilder) ChunkCount added in v3.2.6

func (builder *KnowledgeBuilder) ChunkCount(chunkCount int) *KnowledgeBuilder

切片数量

示例值:1

func (*KnowledgeBuilder) CreateTime added in v3.2.6

func (builder *KnowledgeBuilder) CreateTime(createTime int) *KnowledgeBuilder

创建时间

示例值:1715247397

func (*KnowledgeBuilder) Dataset added in v3.2.6

func (builder *KnowledgeBuilder) Dataset(dataset *AilyKnowledgeDataset) *KnowledgeBuilder

智能伙伴分析表

示例值:

func (*KnowledgeBuilder) Datatable added in v3.2.6

func (builder *KnowledgeBuilder) Datatable(datatable *AilyKnowledgeDatatable) *KnowledgeBuilder

智能伙伴数据表

示例值:

func (*KnowledgeBuilder) Docs added in v3.2.6

func (builder *KnowledgeBuilder) Docs(docs *AilyKnowledgeDocs) *KnowledgeBuilder

飞书云文档信息

示例值:

func (*KnowledgeBuilder) FailMessage added in v3.2.6

func (builder *KnowledgeBuilder) FailMessage(failMessage string) *KnowledgeBuilder

学习失败提示

示例值:success

func (*KnowledgeBuilder) File added in v3.2.6

func (builder *KnowledgeBuilder) File(file *AilyKnowledgeFile) *KnowledgeBuilder

文件信息

示例值:

func (*KnowledgeBuilder) Folder added in v3.2.6

func (builder *KnowledgeBuilder) Folder(folder *AilyKnowledgeFolder) *KnowledgeBuilder

飞书文件夹信息

示例值:

func (*KnowledgeBuilder) Helpdesk added in v3.2.6

func (builder *KnowledgeBuilder) Helpdesk(helpdesk *AilyKnowledgeHelpdesk) *KnowledgeBuilder

飞书服务台信息

示例值:

func (*KnowledgeBuilder) Id added in v3.2.6

func (builder *KnowledgeBuilder) Id(id string) *KnowledgeBuilder

知识ID

示例值:spring_03c49e32bb__c_sdb_aadgfh

func (*KnowledgeBuilder) KnowledgeBaseId added in v3.2.6

func (builder *KnowledgeBuilder) KnowledgeBaseId(knowledgeBaseId string) *KnowledgeBuilder

知识库ID

示例值:knowledge_aadgd7ozoxseilqpor

func (*KnowledgeBuilder) Status added in v3.2.6

func (builder *KnowledgeBuilder) Status(status string) *KnowledgeBuilder

学习状态

示例值:

func (*KnowledgeBuilder) Title added in v3.2.6

func (builder *KnowledgeBuilder) Title(title string) *KnowledgeBuilder

知识标题

示例值:title

func (*KnowledgeBuilder) Type added in v3.2.6

func (builder *KnowledgeBuilder) Type(type_ string) *KnowledgeBuilder

知识类型

示例值:

func (*KnowledgeBuilder) UpdateTime added in v3.2.6

func (builder *KnowledgeBuilder) UpdateTime(updateTime int) *KnowledgeBuilder

更新时间

示例值:1715247397

func (*KnowledgeBuilder) Web added in v3.2.6

网页信息

示例值:

func (*KnowledgeBuilder) WikiSpace added in v3.2.6

func (builder *KnowledgeBuilder) WikiSpace(wikiSpace *AilyKnowledgeWikiSpace) *KnowledgeBuilder

飞书知识空间信息

示例值:

type ListAilySessionAilyMessageIterator

type ListAilySessionAilyMessageIterator struct {
	// contains filtered or unexported fields
}

func (*ListAilySessionAilyMessageIterator) Next

func (*ListAilySessionAilyMessageIterator) NextPageToken

func (iterator *ListAilySessionAilyMessageIterator) NextPageToken() *string

type ListAilySessionAilyMessageReq

type ListAilySessionAilyMessageReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListAilySessionAilyMessageReqBuilder

type ListAilySessionAilyMessageReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListAilySessionAilyMessageReqBuilder

func NewListAilySessionAilyMessageReqBuilder() *ListAilySessionAilyMessageReqBuilder

func (*ListAilySessionAilyMessageReqBuilder) AilySessionId

会话 ID

示例值:session_4dfunz7sp1g8m

func (*ListAilySessionAilyMessageReqBuilder) Build

func (*ListAilySessionAilyMessageReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*ListAilySessionAilyMessageReqBuilder) PageSize

页面大小

示例值:

func (*ListAilySessionAilyMessageReqBuilder) PageToken

分页偏移量

示例值:

func (*ListAilySessionAilyMessageReqBuilder) RunId

运行 ID

示例值:run_4dfrxvctjqzzj

func (*ListAilySessionAilyMessageReqBuilder) WithPartialMessage

func (builder *ListAilySessionAilyMessageReqBuilder) WithPartialMessage(withPartialMessage bool) *ListAilySessionAilyMessageReqBuilder

返回生成中的消息

示例值:false

type ListAilySessionAilyMessageResp

type ListAilySessionAilyMessageResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListAilySessionAilyMessageRespData `json:"data"` // 业务数据
}

func (*ListAilySessionAilyMessageResp) Success

func (resp *ListAilySessionAilyMessageResp) Success() bool

type ListAilySessionAilyMessageRespData

type ListAilySessionAilyMessageRespData struct {
	Messages []*AilyMessage `json:"messages,omitempty"` // 消息列表

	PageToken *string `json:"page_token,omitempty"` // 下一页的起始偏移量

	HasMore *bool `json:"has_more,omitempty"` // 是否还有更多数据
}

type ListAilySessionRunIterator

type ListAilySessionRunIterator struct {
	// contains filtered or unexported fields
}

func (*ListAilySessionRunIterator) Next

func (iterator *ListAilySessionRunIterator) Next() (bool, *Run, error)

func (*ListAilySessionRunIterator) NextPageToken

func (iterator *ListAilySessionRunIterator) NextPageToken() *string

type ListAilySessionRunReq

type ListAilySessionRunReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListAilySessionRunReqBuilder

type ListAilySessionRunReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListAilySessionRunReqBuilder

func NewListAilySessionRunReqBuilder() *ListAilySessionRunReqBuilder

func (*ListAilySessionRunReqBuilder) AilySessionId

func (builder *ListAilySessionRunReqBuilder) AilySessionId(ailySessionId string) *ListAilySessionRunReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*ListAilySessionRunReqBuilder) Build

func (*ListAilySessionRunReqBuilder) Limit

最大返回多少记录,当使用迭代器访问时才有效

func (*ListAilySessionRunReqBuilder) PageSize

func (builder *ListAilySessionRunReqBuilder) PageSize(pageSize int) *ListAilySessionRunReqBuilder

页面大小

示例值:

func (*ListAilySessionRunReqBuilder) PageToken

func (builder *ListAilySessionRunReqBuilder) PageToken(pageToken string) *ListAilySessionRunReqBuilder

分页偏移量

示例值:

type ListAilySessionRunResp

type ListAilySessionRunResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListAilySessionRunRespData `json:"data"` // 业务数据
}

func (*ListAilySessionRunResp) Success

func (resp *ListAilySessionRunResp) Success() bool

type ListAilySessionRunRespData

type ListAilySessionRunRespData struct {
	Runs []*Run `json:"runs,omitempty"` // 运行列表

	PageToken *string `json:"page_token,omitempty"` // 下一页的起始偏移量

	HasMore *bool `json:"has_more,omitempty"` // 是否还有更多数据
}

type ListAppDataAssetIterator added in v3.3.7

type ListAppDataAssetIterator struct {
	// contains filtered or unexported fields
}

func (*ListAppDataAssetIterator) Next added in v3.3.7

func (iterator *ListAppDataAssetIterator) Next() (bool, *DataAsset, error)

func (*ListAppDataAssetIterator) NextPageToken added in v3.3.7

func (iterator *ListAppDataAssetIterator) NextPageToken() *string

type ListAppDataAssetReq added in v3.3.7

type ListAppDataAssetReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListAppDataAssetReqBuilder added in v3.3.7

type ListAppDataAssetReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListAppDataAssetReqBuilder added in v3.3.7

func NewListAppDataAssetReqBuilder() *ListAppDataAssetReqBuilder

func (*ListAppDataAssetReqBuilder) AppId added in v3.3.7

AppID

示例值:spring_5862e4fea8__c

func (*ListAppDataAssetReqBuilder) Build added in v3.3.7

func (*ListAppDataAssetReqBuilder) DataAssetIds added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) DataAssetIds(dataAssetIds []string) *ListAppDataAssetReqBuilder

根据数据知识 ID 进行过滤

示例值:

func (*ListAppDataAssetReqBuilder) DataAssetTagIds added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) DataAssetTagIds(dataAssetTagIds []string) *ListAppDataAssetReqBuilder

根据数据知识分类 ID 进行过滤

示例值:

func (*ListAppDataAssetReqBuilder) Keyword added in v3.3.7

模糊匹配关键词

示例值:电影

func (*ListAppDataAssetReqBuilder) Limit added in v3.3.7

最大返回多少记录,当使用迭代器访问时才有效

func (*ListAppDataAssetReqBuilder) PageSize added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) PageSize(pageSize int) *ListAppDataAssetReqBuilder

分页参数:分页大小,默认:20,最大:100

示例值:

func (*ListAppDataAssetReqBuilder) PageToken added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) PageToken(pageToken string) *ListAppDataAssetReqBuilder

分页参数:分页起始位置,为空表示首页

示例值:

func (*ListAppDataAssetReqBuilder) WithConnectStatus added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) WithConnectStatus(withConnectStatus bool) *ListAppDataAssetReqBuilder

结果是否包含数据连接状态

示例值:

func (*ListAppDataAssetReqBuilder) WithDataAssetItem added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) WithDataAssetItem(withDataAssetItem bool) *ListAppDataAssetReqBuilder

结果是否包含数据与知识项目

示例值:

func (*ListAppDataAssetReqBuilder) WithImportSetting added in v3.3.7

func (builder *ListAppDataAssetReqBuilder) WithImportSetting(withImportSetting bool) *ListAppDataAssetReqBuilder

结果是否包含导入数据源信息

示例值:

type ListAppDataAssetResp added in v3.3.7

type ListAppDataAssetResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListAppDataAssetRespData `json:"data"` // 业务数据
}

func (*ListAppDataAssetResp) Success added in v3.3.7

func (resp *ListAppDataAssetResp) Success() bool

type ListAppDataAssetRespData added in v3.3.7

type ListAppDataAssetRespData struct {
	Items []*DataAsset `json:"items,omitempty"` // 数据知识列表

	PageToken *string `json:"page_token,omitempty"` // has_more=true,可使用page_token继续查询

	HasMore *bool `json:"has_more,omitempty"` // 是否有更多
}

type ListAppDataAssetTagIterator added in v3.3.7

type ListAppDataAssetTagIterator struct {
	// contains filtered or unexported fields
}

func (*ListAppDataAssetTagIterator) Next added in v3.3.7

func (iterator *ListAppDataAssetTagIterator) Next() (bool, *DataAssetTag, error)

func (*ListAppDataAssetTagIterator) NextPageToken added in v3.3.7

func (iterator *ListAppDataAssetTagIterator) NextPageToken() *string

type ListAppDataAssetTagReq added in v3.3.7

type ListAppDataAssetTagReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListAppDataAssetTagReqBuilder added in v3.3.7

type ListAppDataAssetTagReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListAppDataAssetTagReqBuilder added in v3.3.7

func NewListAppDataAssetTagReqBuilder() *ListAppDataAssetTagReqBuilder

func (*ListAppDataAssetTagReqBuilder) AppId added in v3.3.7

AppID

示例值:spring_5862e4fea8__c

func (*ListAppDataAssetTagReqBuilder) Build added in v3.3.7

func (*ListAppDataAssetTagReqBuilder) DataAssetTagIds added in v3.3.7

func (builder *ListAppDataAssetTagReqBuilder) DataAssetTagIds(dataAssetTagIds []string) *ListAppDataAssetTagReqBuilder

模糊匹配分类名称

示例值:

func (*ListAppDataAssetTagReqBuilder) Keyword added in v3.3.7

模糊匹配分类名称

示例值:电影

func (*ListAppDataAssetTagReqBuilder) Limit added in v3.3.7

最大返回多少记录,当使用迭代器访问时才有效

func (*ListAppDataAssetTagReqBuilder) PageSize added in v3.3.7

分页参数:分页大小,默认:20,最大:100

示例值:

func (*ListAppDataAssetTagReqBuilder) PageToken added in v3.3.7

分页参数:分页起始位置,为空表示首页

示例值:

type ListAppDataAssetTagResp added in v3.3.7

type ListAppDataAssetTagResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListAppDataAssetTagRespData `json:"data"` // 业务数据
}

func (*ListAppDataAssetTagResp) Success added in v3.3.7

func (resp *ListAppDataAssetTagResp) Success() bool

type ListAppDataAssetTagRespData added in v3.3.7

type ListAppDataAssetTagRespData struct {
	Items []*DataAssetTag `json:"items,omitempty"` // 数据知识分类列表

	PageToken *string `json:"page_token,omitempty"` // has_more=true,可使用 page_token继续查询

	HasMore *bool `json:"has_more,omitempty"` // 是否有更多
}

type ListAppSkillIterator added in v3.3.7

type ListAppSkillIterator struct {
	// contains filtered or unexported fields
}

func (*ListAppSkillIterator) Next added in v3.3.7

func (iterator *ListAppSkillIterator) Next() (bool, *Skill, error)

func (*ListAppSkillIterator) NextPageToken added in v3.3.7

func (iterator *ListAppSkillIterator) NextPageToken() *string

type ListAppSkillReq added in v3.3.7

type ListAppSkillReq struct {
	Limit int // 最多返回多少记录,只有在使用迭代器访问时,才有效
	// contains filtered or unexported fields
}

type ListAppSkillReqBuilder added in v3.3.7

type ListAppSkillReqBuilder struct {
	// contains filtered or unexported fields
}

func NewListAppSkillReqBuilder added in v3.3.7

func NewListAppSkillReqBuilder() *ListAppSkillReqBuilder

func (*ListAppSkillReqBuilder) AppId added in v3.3.7

func (builder *ListAppSkillReqBuilder) AppId(appId string) *ListAppSkillReqBuilder

应用 ID

示例值:spring_xxx__c

func (*ListAppSkillReqBuilder) Build added in v3.3.7

func (builder *ListAppSkillReqBuilder) Build() *ListAppSkillReq

func (*ListAppSkillReqBuilder) Limit added in v3.3.7

func (builder *ListAppSkillReqBuilder) Limit(limit int) *ListAppSkillReqBuilder

最大返回多少记录,当使用迭代器访问时才有效

func (*ListAppSkillReqBuilder) PageSize added in v3.3.7

func (builder *ListAppSkillReqBuilder) PageSize(pageSize int) *ListAppSkillReqBuilder

页面大小

示例值:

func (*ListAppSkillReqBuilder) PageToken added in v3.3.7

func (builder *ListAppSkillReqBuilder) PageToken(pageToken string) *ListAppSkillReqBuilder

分页偏移量

示例值:

type ListAppSkillResp added in v3.3.7

type ListAppSkillResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *ListAppSkillRespData `json:"data"` // 业务数据
}

func (*ListAppSkillResp) Success added in v3.3.7

func (resp *ListAppSkillResp) Success() bool

type ListAppSkillRespData added in v3.3.7

type ListAppSkillRespData struct {
	Skills []*Skill `json:"skills,omitempty"` // 技能列表

	PageToken *string `json:"page_token,omitempty"` // 下一页的起始偏移量

	HasMore *bool `json:"has_more,omitempty"` // 是否还有更多数据
}

type Message

type Message struct {
	Id *string `json:"id,omitempty"` // 消息 id

	Title *string `json:"title,omitempty"` // 消息标题

	Content *string `json:"content,omitempty"` // 消息内容

	MessageStatus *string `json:"message_status,omitempty"` // 消息状态

	BuiltinActions []*BuiltinAction `json:"builtin_actions,omitempty"` // 消息上可接收的 action

	SkillBaseInfos []*SkillBaseInfo `json:"skill_base_infos,omitempty"` // 使用的 skill 信息

	MessageProgress *MessageProgress `json:"message_progress,omitempty"` // 进度条消息

	Sender *Sender `json:"sender,omitempty"` // 发送者信息

	Error *MessageError `json:"error,omitempty"` // 错误信息

	TriggerType *string `json:"trigger_type,omitempty"` // 触发类型

	Visibility *string `json:"visibility,omitempty"` // 消息的可见性
}

type MessageBuilder

type MessageBuilder struct {
	// contains filtered or unexported fields
}

func NewMessageBuilder

func NewMessageBuilder() *MessageBuilder

func (*MessageBuilder) Build

func (builder *MessageBuilder) Build() *Message

func (*MessageBuilder) BuiltinActions

func (builder *MessageBuilder) BuiltinActions(builtinActions []*BuiltinAction) *MessageBuilder

消息上可接收的 action

示例值:

func (*MessageBuilder) Content

func (builder *MessageBuilder) Content(content string) *MessageBuilder

消息内容

示例值:{}

func (*MessageBuilder) Error

func (builder *MessageBuilder) Error(error *MessageError) *MessageBuilder

错误信息

示例值:

func (*MessageBuilder) Id

func (builder *MessageBuilder) Id(id string) *MessageBuilder

消息 id

示例值:7316801852719906836

func (*MessageBuilder) MessageProgress

func (builder *MessageBuilder) MessageProgress(messageProgress *MessageProgress) *MessageBuilder

进度条消息

示例值:

func (*MessageBuilder) MessageStatus

func (builder *MessageBuilder) MessageStatus(messageStatus string) *MessageBuilder

消息状态

示例值:FINISHED

func (*MessageBuilder) Sender

func (builder *MessageBuilder) Sender(sender *Sender) *MessageBuilder

发送者信息

示例值:

func (*MessageBuilder) SkillBaseInfos

func (builder *MessageBuilder) SkillBaseInfos(skillBaseInfos []*SkillBaseInfo) *MessageBuilder

使用的 skill 信息

示例值:

func (*MessageBuilder) Title

func (builder *MessageBuilder) Title(title string) *MessageBuilder

消息标题

示例值:正在生成中...

func (*MessageBuilder) TriggerType

func (builder *MessageBuilder) TriggerType(triggerType string) *MessageBuilder

触发类型

示例值:”

func (*MessageBuilder) Visibility

func (builder *MessageBuilder) Visibility(visibility string) *MessageBuilder

消息的可见性

示例值:SELF

type MessageError

type MessageError struct {
	Code *string `json:"code,omitempty"` // 错误码

	Message *string `json:"message,omitempty"` // 错误消息

	ErrorType *string `json:"error_type,omitempty"` // 错误类型

	LogId *string `json:"log_id,omitempty"` // 反馈码

	Title *string `json:"title,omitempty"` // 错误标题
}

type MessageErrorBuilder

type MessageErrorBuilder struct {
	// contains filtered or unexported fields
}

func NewMessageErrorBuilder

func NewMessageErrorBuilder() *MessageErrorBuilder

func (*MessageErrorBuilder) Build

func (builder *MessageErrorBuilder) Build() *MessageError

func (*MessageErrorBuilder) Code

func (builder *MessageErrorBuilder) Code(code string) *MessageErrorBuilder

错误码

示例值:sp_ec_cr_200001

func (*MessageErrorBuilder) ErrorType

func (builder *MessageErrorBuilder) ErrorType(errorType string) *MessageErrorBuilder

错误类型

示例值:SYSTEM

func (*MessageErrorBuilder) LogId

func (builder *MessageErrorBuilder) LogId(logId string) *MessageErrorBuilder

反馈码

示例值:2023122620474996FAC90E4B49302D7C93

func (*MessageErrorBuilder) Message

func (builder *MessageErrorBuilder) Message(message string) *MessageErrorBuilder

错误消息

示例值:意图状态不合法,当前为1,实际为4

func (*MessageErrorBuilder) Title

func (builder *MessageErrorBuilder) Title(title string) *MessageErrorBuilder

错误标题

示例值:意图状态不合法

type MessageProgress

type MessageProgress struct {
	ProgressType *string `json:"progress_type,omitempty"` // 进度条类型

	ProgressItems []*ProgressItem `json:"progress_items,omitempty"` // 进度条项
}

type MessageProgressBuilder

type MessageProgressBuilder struct {
	// contains filtered or unexported fields
}

func NewMessageProgressBuilder

func NewMessageProgressBuilder() *MessageProgressBuilder

func (*MessageProgressBuilder) Build

func (builder *MessageProgressBuilder) Build() *MessageProgress

func (*MessageProgressBuilder) ProgressItems

func (builder *MessageProgressBuilder) ProgressItems(progressItems []*ProgressItem) *MessageProgressBuilder

进度条项

示例值:

func (*MessageProgressBuilder) ProgressType

func (builder *MessageProgressBuilder) ProgressType(progressType string) *MessageProgressBuilder

进度条类型

示例值:LIST

type MessageWithOperation

type MessageWithOperation struct {
	Message *Message `json:"message,omitempty"` // 消息内容

	OperationType *string `json:"operation_type,omitempty"` // 操作类型

	OperationId *string `json:"operation_id,omitempty"` // 操作 id

	IntentId *string `json:"intent_id,omitempty"` // 产生操作的意图 id
}

type MessageWithOperationBuilder

type MessageWithOperationBuilder struct {
	// contains filtered or unexported fields
}

func NewMessageWithOperationBuilder

func NewMessageWithOperationBuilder() *MessageWithOperationBuilder

func (*MessageWithOperationBuilder) Build

func (*MessageWithOperationBuilder) IntentId

func (builder *MessageWithOperationBuilder) IntentId(intentId string) *MessageWithOperationBuilder

产生操作的意图 id

示例值:7317093049367298068

func (*MessageWithOperationBuilder) Message

消息内容

示例值:

func (*MessageWithOperationBuilder) OperationId

func (builder *MessageWithOperationBuilder) OperationId(operationId string) *MessageWithOperationBuilder

操作 id

示例值:7317091517491167252

func (*MessageWithOperationBuilder) OperationType

func (builder *MessageWithOperationBuilder) OperationType(operationType string) *MessageWithOperationBuilder

操作类型

示例值:APPEND

type ObjectSetting

type ObjectSetting struct {
	DisplayName *string `json:"display_name,omitempty"` // 数据表展示字段

	FieldOrders []string `json:"field_orders,omitempty"` // 字段顺序
}

type ObjectSettingBuilder

type ObjectSettingBuilder struct {
	// contains filtered or unexported fields
}

func NewObjectSettingBuilder

func NewObjectSettingBuilder() *ObjectSettingBuilder

func (*ObjectSettingBuilder) Build

func (builder *ObjectSettingBuilder) Build() *ObjectSetting

func (*ObjectSettingBuilder) DisplayName

func (builder *ObjectSettingBuilder) DisplayName(displayName string) *ObjectSettingBuilder

数据表展示字段

示例值:"_id"

func (*ObjectSettingBuilder) FieldOrders

func (builder *ObjectSettingBuilder) FieldOrders(fieldOrders []string) *ObjectSettingBuilder

字段顺序

示例值:

type OrderCondition

type OrderCondition struct {
	Field *string `json:"field,omitempty"` // 字段名

	Direction *string `json:"direction,omitempty"` // 排序方式
}

type OrderConditionBuilder

type OrderConditionBuilder struct {
	// contains filtered or unexported fields
}

func NewOrderConditionBuilder

func NewOrderConditionBuilder() *OrderConditionBuilder

func (*OrderConditionBuilder) Build

func (builder *OrderConditionBuilder) Build() *OrderCondition

func (*OrderConditionBuilder) Direction

func (builder *OrderConditionBuilder) Direction(direction string) *OrderConditionBuilder

排序方式

示例值:asc

func (*OrderConditionBuilder) Field

func (builder *OrderConditionBuilder) Field(field string) *OrderConditionBuilder

字段名

示例值:name

type ProgressItem

type ProgressItem struct {
	ProgressItemState *string `json:"progress_item_state,omitempty"` // 进度条项状态

	Content *string `json:"content,omitempty"` // 进度条项内容

	SkillId *string `json:"skill_id,omitempty"` // 选中的技能 id

	NodeId *string `json:"node_id,omitempty"` // 节点 id

	NodeType *string `json:"node_type,omitempty"` // 节点类型

	Input *string `json:"input,omitempty"` // 节点输入,调试模式返回

	Output *string `json:"output,omitempty"` // 节点输出,调试模式返回

	Usages []string `json:"usages,omitempty"` // 节点的时间以及 Token 消耗

	SkillStrategy *string `json:"skill_strategy,omitempty"` // 技能选择策略
}

type ProgressItemBuilder

type ProgressItemBuilder struct {
	// contains filtered or unexported fields
}

func NewProgressItemBuilder

func NewProgressItemBuilder() *ProgressItemBuilder

func (*ProgressItemBuilder) Build

func (builder *ProgressItemBuilder) Build() *ProgressItem

func (*ProgressItemBuilder) Content

func (builder *ProgressItemBuilder) Content(content string) *ProgressItemBuilder

进度条项内容

示例值:抽取字段

func (*ProgressItemBuilder) Input

func (builder *ProgressItemBuilder) Input(input string) *ProgressItemBuilder

节点输入,调试模式返回

示例值:{}

func (*ProgressItemBuilder) NodeId

func (builder *ProgressItemBuilder) NodeId(nodeId string) *ProgressItemBuilder

节点 id

示例值:7316877623309058067

func (*ProgressItemBuilder) NodeType

func (builder *ProgressItemBuilder) NodeType(nodeType string) *ProgressItemBuilder

节点类型

示例值:skill-selector

func (*ProgressItemBuilder) Output

func (builder *ProgressItemBuilder) Output(output string) *ProgressItemBuilder

节点输出,调试模式返回

示例值:{}

func (*ProgressItemBuilder) ProgressItemState

func (builder *ProgressItemBuilder) ProgressItemState(progressItemState string) *ProgressItemBuilder

进度条项状态

示例值:RUNNING

func (*ProgressItemBuilder) SkillId

func (builder *ProgressItemBuilder) SkillId(skillId string) *ProgressItemBuilder

选中的技能 id

示例值:skill_43ec7b438a59

func (*ProgressItemBuilder) SkillStrategy

func (builder *ProgressItemBuilder) SkillStrategy(skillStrategy string) *ProgressItemBuilder

技能选择策略

示例值:AUTO

func (*ProgressItemBuilder) Usages

func (builder *ProgressItemBuilder) Usages(usages []string) *ProgressItemBuilder

节点的时间以及 Token 消耗

示例值:

type RecordError

type RecordError struct {
	Code *string `json:"code,omitempty"` // 内部错误码

	Message *string `json:"message,omitempty"` // 错误文本
}

type RecordErrorBuilder

type RecordErrorBuilder struct {
	// contains filtered or unexported fields
}

func NewRecordErrorBuilder

func NewRecordErrorBuilder() *RecordErrorBuilder

func (*RecordErrorBuilder) Build

func (builder *RecordErrorBuilder) Build() *RecordError

func (*RecordErrorBuilder) Code

func (builder *RecordErrorBuilder) Code(code string) *RecordErrorBuilder

内部错误码

示例值:k_mt_ec_001000

func (*RecordErrorBuilder) Message

func (builder *RecordErrorBuilder) Message(message string) *RecordErrorBuilder

错误文本

示例值:权限不足

type RecordQueryOption

type RecordQueryOption struct {
	StringifyNumber *bool `json:"stringify_number,omitempty"` // 是否以字符串形式返回数字

	NormalizeColumnName *bool `json:"normalize_column_name,omitempty"` // 返回的列名是否去除特殊字符
}

type RecordQueryOptionBuilder

type RecordQueryOptionBuilder struct {
	// contains filtered or unexported fields
}

func NewRecordQueryOptionBuilder

func NewRecordQueryOptionBuilder() *RecordQueryOptionBuilder

func (*RecordQueryOptionBuilder) Build

func (builder *RecordQueryOptionBuilder) Build() *RecordQueryOption

func (*RecordQueryOptionBuilder) NormalizeColumnName

func (builder *RecordQueryOptionBuilder) NormalizeColumnName(normalizeColumnName bool) *RecordQueryOptionBuilder

返回的列名是否去除特殊字符

示例值:false

func (*RecordQueryOptionBuilder) StringifyNumber

func (builder *RecordQueryOptionBuilder) StringifyNumber(stringifyNumber bool) *RecordQueryOptionBuilder

是否以字符串形式返回数字

示例值:false

type RecordResult

type RecordResult struct {
	Success *bool `json:"success,omitempty"` // 是否成功

	PrimaryKeyValue *string `json:"primary_key_value,omitempty"` // 记录失败的唯一键对应值

	Errors []*RecordError `json:"errors,omitempty"` // 记录失败的第一条报错

	Id *string `json:"_id,omitempty"` // 记录的内部 id
}

type RecordResultBuilder

type RecordResultBuilder struct {
	// contains filtered or unexported fields
}

func NewRecordResultBuilder

func NewRecordResultBuilder() *RecordResultBuilder

func (*RecordResultBuilder) Build

func (builder *RecordResultBuilder) Build() *RecordResult

func (*RecordResultBuilder) Errors

func (builder *RecordResultBuilder) Errors(errors []*RecordError) *RecordResultBuilder

记录失败的第一条报错

示例值:

func (*RecordResultBuilder) Id

记录的内部 id

示例值:543276126389

func (*RecordResultBuilder) PrimaryKeyValue

func (builder *RecordResultBuilder) PrimaryKeyValue(primaryKeyValue string) *RecordResultBuilder

记录失败的唯一键对应值

示例值:name

func (*RecordResultBuilder) Success

func (builder *RecordResultBuilder) Success(success bool) *RecordResultBuilder

是否成功

示例值:

type Run

type Run struct {
	Id *string `json:"id,omitempty"` // 运行 ID

	CreatedAt *string `json:"created_at,omitempty"` // 运行的创建时间,毫秒时间戳

	AppId *string `json:"app_id,omitempty"` // 应用 ID

	SessionId *string `json:"session_id,omitempty"` // 会话 ID

	Status *string `json:"status,omitempty"` // 状态

	StartedAt *string `json:"started_at,omitempty"` // 开始时间,毫秒时间戳

	EndedAt *string `json:"ended_at,omitempty"` // 结束时间,毫秒时间戳

	Error *RunError `json:"error,omitempty"` // 失败时的错误信息

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息
}

type RunBuilder

type RunBuilder struct {
	// contains filtered or unexported fields
}

func NewRunBuilder

func NewRunBuilder() *RunBuilder

func (*RunBuilder) AppId

func (builder *RunBuilder) AppId(appId string) *RunBuilder

应用 ID

示例值:spring_xxx__c

func (*RunBuilder) Build

func (builder *RunBuilder) Build() *Run

func (*RunBuilder) CreatedAt

func (builder *RunBuilder) CreatedAt(createdAt string) *RunBuilder

运行的创建时间,毫秒时间戳

示例值:1711975665710

func (*RunBuilder) EndedAt

func (builder *RunBuilder) EndedAt(endedAt string) *RunBuilder

结束时间,毫秒时间戳

示例值:1711975665710

func (*RunBuilder) Error

func (builder *RunBuilder) Error(error *RunError) *RunBuilder

失败时的错误信息

示例值:

func (*RunBuilder) Id

func (builder *RunBuilder) Id(id string) *RunBuilder

运行 ID

示例值:run_4dfrxvctjqzzj

func (*RunBuilder) Metadata

func (builder *RunBuilder) Metadata(metadata string) *RunBuilder

其他透传信息

示例值:{}

func (*RunBuilder) SessionId

func (builder *RunBuilder) SessionId(sessionId string) *RunBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*RunBuilder) StartedAt

func (builder *RunBuilder) StartedAt(startedAt string) *RunBuilder

开始时间,毫秒时间戳

示例值:1711975665710

func (*RunBuilder) Status

func (builder *RunBuilder) Status(status string) *RunBuilder

状态

示例值:IN_PROGRESS

type RunError

type RunError struct {
	Code *string `json:"code,omitempty"` // 错误码

	Message *string `json:"message,omitempty"` // 错误信息
}

type RunErrorBuilder

type RunErrorBuilder struct {
	// contains filtered or unexported fields
}

func NewRunErrorBuilder

func NewRunErrorBuilder() *RunErrorBuilder

func (*RunErrorBuilder) Build

func (builder *RunErrorBuilder) Build() *RunError

func (*RunErrorBuilder) Code

func (builder *RunErrorBuilder) Code(code string) *RunErrorBuilder

错误码

示例值:sp_ec_sm_900101

func (*RunErrorBuilder) Message

func (builder *RunErrorBuilder) Message(message string) *RunErrorBuilder

错误信息

示例值:技能不存在或已删除

type Sender

type Sender struct {
	Id *string `json:"id,omitempty"` // 发送人 id

	SenderType *string `json:"sender_type,omitempty"` // 发送者类型

	Name *string `json:"name,omitempty"` // 发送者名称

	Desc *string `json:"desc,omitempty"` // 发送者描述

	SenderId *string `json:"sender_id,omitempty"` // 发送者id
}

type SenderBuilder

type SenderBuilder struct {
	// contains filtered or unexported fields
}

func NewSenderBuilder

func NewSenderBuilder() *SenderBuilder

func (*SenderBuilder) Build

func (builder *SenderBuilder) Build() *Sender

func (*SenderBuilder) Desc

func (builder *SenderBuilder) Desc(desc string) *SenderBuilder

发送者描述

示例值:”

func (*SenderBuilder) Id

func (builder *SenderBuilder) Id(id string) *SenderBuilder

发送人 id

示例值:1785351368700027

func (*SenderBuilder) Name

func (builder *SenderBuilder) Name(name string) *SenderBuilder

发送者名称

示例值:天气预报

func (*SenderBuilder) SenderId

func (builder *SenderBuilder) SenderId(senderId string) *SenderBuilder

发送者id

示例值:skill_43ec7b438a59

func (*SenderBuilder) SenderType

func (builder *SenderBuilder) SenderType(senderType string) *SenderBuilder

发送者类型

示例值:SKILL

type Session

type Session struct {
	Id *string `json:"id,omitempty"` // session 的唯一标识

	CreatedAt *string `json:"created_at,omitempty"` // session 的创建时间,毫秒时间戳

	EffectedAt *string `json:"effected_at,omitempty"` // session 的过期时间,毫秒时间戳

	Type *string `json:"type,omitempty"` // session 类型

	Status *string `json:"status,omitempty"` // session 状态

	ActiveIntentId *string `json:"active_intent_id,omitempty"` // 当前运行中的意图 id

	ChannelType *string `json:"channel_type,omitempty"` // 渠道类型

	EnableDebug *bool `json:"enable_debug,omitempty"` // 是否开启调试模式

	Kvs *string `json:"kvs,omitempty"` // 会话中的自定义 kv 对,包括创建时传入的渠道上下文
}

type SessionBuilder

type SessionBuilder struct {
	// contains filtered or unexported fields
}

func NewSessionBuilder

func NewSessionBuilder() *SessionBuilder

func (*SessionBuilder) ActiveIntentId

func (builder *SessionBuilder) ActiveIntentId(activeIntentId string) *SessionBuilder

当前运行中的意图 id

示例值:7312657247586009109

func (*SessionBuilder) Build

func (builder *SessionBuilder) Build() *Session

func (*SessionBuilder) ChannelType

func (builder *SessionBuilder) ChannelType(channelType string) *SessionBuilder

渠道类型

示例值:LARK_OPEN_API

func (*SessionBuilder) CreatedAt

func (builder *SessionBuilder) CreatedAt(createdAt string) *SessionBuilder

session 的创建时间,毫秒时间戳

示例值:1703486238000

func (*SessionBuilder) EffectedAt

func (builder *SessionBuilder) EffectedAt(effectedAt string) *SessionBuilder

session 的过期时间,毫秒时间戳

示例值:1703486238000

func (*SessionBuilder) EnableDebug

func (builder *SessionBuilder) EnableDebug(enableDebug bool) *SessionBuilder

是否开启调试模式

示例值:false

func (*SessionBuilder) Id

func (builder *SessionBuilder) Id(id string) *SessionBuilder

session 的唯一标识

示例值:7316801852719906836

func (*SessionBuilder) Kvs

func (builder *SessionBuilder) Kvs(kvs string) *SessionBuilder

会话中的自定义 kv 对,包括创建时传入的渠道上下文

示例值:{}

func (*SessionBuilder) Status

func (builder *SessionBuilder) Status(status string) *SessionBuilder

session 状态

示例值:VALID

func (*SessionBuilder) Type

func (builder *SessionBuilder) Type(type_ string) *SessionBuilder

session 类型

示例值:LONG-TERM

type Skill added in v3.3.5

type Skill struct {
	Id *string `json:"id,omitempty"` // 技能 ID

	Label *string `json:"label,omitempty"` // 技能名称

	Description *string `json:"description,omitempty"` // 技能描述

	Samples []string `json:"samples,omitempty"` // 用户提问示例

	InputSchema *string `json:"input_schema,omitempty"` // 技能入参定义

	OutputSchema *string `json:"output_schema,omitempty"` // 技能出参定义
}

type SkillBaseInfo

type SkillBaseInfo struct {
	Name *string `json:"name,omitempty"` // 技能名称

	SkillId *string `json:"skill_id,omitempty"` // 技能 id

	Type *string `json:"type,omitempty"` // 技能类型

	BuiltinType *string `json:"builtin_type,omitempty"` // 内置技能类型
}

type SkillBaseInfoBuilder

type SkillBaseInfoBuilder struct {
	// contains filtered or unexported fields
}

func NewSkillBaseInfoBuilder

func NewSkillBaseInfoBuilder() *SkillBaseInfoBuilder

func (*SkillBaseInfoBuilder) Build

func (builder *SkillBaseInfoBuilder) Build() *SkillBaseInfo

func (*SkillBaseInfoBuilder) BuiltinType

func (builder *SkillBaseInfoBuilder) BuiltinType(builtinType string) *SkillBaseInfoBuilder

内置技能类型

示例值:qna

func (*SkillBaseInfoBuilder) Name

func (builder *SkillBaseInfoBuilder) Name(name string) *SkillBaseInfoBuilder

技能名称

示例值:天气预报

func (*SkillBaseInfoBuilder) SkillId

func (builder *SkillBaseInfoBuilder) SkillId(skillId string) *SkillBaseInfoBuilder

技能 id

示例值:skill_43ec7b438a59

func (*SkillBaseInfoBuilder) Type

func (builder *SkillBaseInfoBuilder) Type(type_ string) *SkillBaseInfoBuilder

技能类型

示例值:custom

type SkillBuilder added in v3.3.5

type SkillBuilder struct {
	// contains filtered or unexported fields
}

func NewSkillBuilder added in v3.3.5

func NewSkillBuilder() *SkillBuilder

func (*SkillBuilder) Build added in v3.3.5

func (builder *SkillBuilder) Build() *Skill

func (*SkillBuilder) Description added in v3.3.5

func (builder *SkillBuilder) Description(description string) *SkillBuilder

技能描述

示例值:理解用户提出的问题,对当前助手已经配置的数据资产进行知识搜索、数据分析、文档阅读,总结并返回答案。

func (*SkillBuilder) Id added in v3.3.5

func (builder *SkillBuilder) Id(id string) *SkillBuilder

技能 ID

示例值:skill_6cc6166178ca

func (*SkillBuilder) InputSchema added in v3.3.5

func (builder *SkillBuilder) InputSchema(inputSchema string) *SkillBuilder

技能入参定义

示例值:[{"name":"custom_s","type":"String","required":true,"defaultValue":"qwert","description":"自定义字符串"},{"name":"custom_i","type":"Integer","required":true,"defaultValue":null,"description":""},{"name":"custom_b","type":"Boolean","required":true,"defaultValue":true,"description":""},{"name":"custom_f","type":"Float","required":true,"defaultValue":2.1,"description":""}]

func (*SkillBuilder) Label added in v3.3.5

func (builder *SkillBuilder) Label(label string) *SkillBuilder

技能名称

示例值:数据分析和问答

func (*SkillBuilder) OutputSchema added in v3.3.5

func (builder *SkillBuilder) OutputSchema(outputSchema string) *SkillBuilder

技能出参定义

示例值:[{"name":"input","type":"String","required":false,"defaultValue":null},{"name":"custom","type":"Boolean","required":false,"defaultValue":null}]

func (*SkillBuilder) Samples added in v3.3.5

func (builder *SkillBuilder) Samples(samples []string) *SkillBuilder

用户提问示例

示例值:

type SkillCall

type SkillCall struct {
	SkillCallId *string `json:"skill_call_id,omitempty"` // 中断调用 schema

	Input *string `json:"input,omitempty"` // 用户对中断的响应内容

	WaitingType *string `json:"waiting_type,omitempty"` // WAITING_USER_MESSAGE or WAITING_USER_RESPOND

	InputDsl *string `json:"input_dsl,omitempty"` // input 的 DSL,用户可参考 DSL 来写 input
}

type SkillCallBuilder

type SkillCallBuilder struct {
	// contains filtered or unexported fields
}

func NewSkillCallBuilder

func NewSkillCallBuilder() *SkillCallBuilder

func (*SkillCallBuilder) Build

func (builder *SkillCallBuilder) Build() *SkillCall

func (*SkillCallBuilder) Input

func (builder *SkillCallBuilder) Input(input string) *SkillCallBuilder

用户对中断的响应内容

示例值:{}

func (*SkillCallBuilder) InputDsl

func (builder *SkillCallBuilder) InputDsl(inputDsl string) *SkillCallBuilder

input 的 DSL,用户可参考 DSL 来写 input

示例值:{}

func (*SkillCallBuilder) SkillCallId

func (builder *SkillCallBuilder) SkillCallId(skillCallId string) *SkillCallBuilder

中断调用 schema

示例值:123

func (*SkillCallBuilder) WaitingType

func (builder *SkillCallBuilder) WaitingType(waitingType string) *SkillCallBuilder

WAITING_USER_MESSAGE or WAITING_USER_RESPOND

示例值:WAITING_USER_RESPOND

type SkillGlobalVariable added in v3.3.5

type SkillGlobalVariable struct {
	Query *string `json:"query,omitempty"` // 触发技能的消息文本

	Files []string `json:"files,omitempty"` // 触发技能的消息文件

	Channel *Channel `json:"channel,omitempty"` // 渠道信息
}

type SkillGlobalVariableBuilder added in v3.3.5

type SkillGlobalVariableBuilder struct {
	// contains filtered or unexported fields
}

func NewSkillGlobalVariableBuilder added in v3.3.5

func NewSkillGlobalVariableBuilder() *SkillGlobalVariableBuilder

func (*SkillGlobalVariableBuilder) Build added in v3.3.5

func (*SkillGlobalVariableBuilder) Channel added in v3.3.5

渠道信息

示例值:

func (*SkillGlobalVariableBuilder) Files added in v3.3.5

触发技能的消息文件

示例值:

func (*SkillGlobalVariableBuilder) Query added in v3.3.5

触发技能的消息文本

示例值:你好

type SkillInstance

type SkillInstance struct {
	SkillInstanceId *string `json:"skill_instance_id,omitempty"` // skill_instance 的唯一标识

	Status *string `json:"status,omitempty"` // skill_instance 的状态

	Input *string `json:"input,omitempty"` // skill_instance 的输入,结构需要符合 skill 的 input schema

	Output *string `json:"output,omitempty"` // skill_instance 的输出,结构需要符合 skill 的 output schema
}

type SkillInstanceBuilder

type SkillInstanceBuilder struct {
	// contains filtered or unexported fields
}

func NewSkillInstanceBuilder

func NewSkillInstanceBuilder() *SkillInstanceBuilder

func (*SkillInstanceBuilder) Build

func (builder *SkillInstanceBuilder) Build() *SkillInstance

func (*SkillInstanceBuilder) Input

func (builder *SkillInstanceBuilder) Input(input string) *SkillInstanceBuilder

skill_instance 的输入,结构需要符合 skill 的 input schema

示例值:{ "userInput": "今天天气怎么样" }

func (*SkillInstanceBuilder) Output

func (builder *SkillInstanceBuilder) Output(output string) *SkillInstanceBuilder

skill_instance 的输出,结构需要符合 skill 的 output schema

示例值:{}

func (*SkillInstanceBuilder) SkillInstanceId

func (builder *SkillInstanceBuilder) SkillInstanceId(skillInstanceId string) *SkillInstanceBuilder

skill_instance 的唯一标识

示例值:1234567890

func (*SkillInstanceBuilder) Status

func (builder *SkillInstanceBuilder) Status(status string) *SkillInstanceBuilder

skill_instance 的状态

示例值:success

type SourceSetting

type SourceSetting struct {
	ApiId *string `json:"api_id,omitempty"` // 分表数据源api_id

	ApiName *string `json:"api_name,omitempty"` // 分表数据源api_name

	Label map[string]string `json:"label,omitempty"` // 分表数据源名称,国际化文本

	FromType *string `json:"from_type,omitempty"` // 数据源具体来源

	AuthKey *string `json:"auth_key,omitempty"` // 外部数据源的凭证key

	AuthName map[string]string `json:"auth_name,omitempty"` // 外部数据源的凭证名称,国际化文本(同上)

	DataSourceIntegrationType *string `json:"data_source_integration_type,omitempty"` // 外部数据源和对接方式 - direct: 直连 - Import: 导入
}

type SourceSettingBuilder

type SourceSettingBuilder struct {
	// contains filtered or unexported fields
}

func NewSourceSettingBuilder

func NewSourceSettingBuilder() *SourceSettingBuilder

func (*SourceSettingBuilder) ApiId

func (builder *SourceSettingBuilder) ApiId(apiId string) *SourceSettingBuilder

分表数据源api_id

示例值:"source_api_id"

func (*SourceSettingBuilder) ApiName

func (builder *SourceSettingBuilder) ApiName(apiName string) *SourceSettingBuilder

分表数据源api_name

示例值:"source_api_name"

func (*SourceSettingBuilder) AuthKey

func (builder *SourceSettingBuilder) AuthKey(authKey string) *SourceSettingBuilder

外部数据源的凭证key

示例值:"auth_key_001"

func (*SourceSettingBuilder) AuthName

func (builder *SourceSettingBuilder) AuthName(authName map[string]string) *SourceSettingBuilder

外部数据源的凭证名称,国际化文本(同上)

示例值:

func (*SourceSettingBuilder) Build

func (builder *SourceSettingBuilder) Build() *SourceSetting

func (*SourceSettingBuilder) DataSourceIntegrationType

func (builder *SourceSettingBuilder) DataSourceIntegrationType(dataSourceIntegrationType string) *SourceSettingBuilder

外部数据源和对接方式 - direct: 直连 - Import: 导入

示例值:"Import"

func (*SourceSettingBuilder) FromType

func (builder *SourceSettingBuilder) FromType(fromType string) *SourceSettingBuilder

数据源具体来源

示例值:"mysql"

func (*SourceSettingBuilder) Label

func (builder *SourceSettingBuilder) Label(label map[string]string) *SourceSettingBuilder

分表数据源名称,国际化文本

示例值:

type StartAppSkillPathReqBodyBuilder added in v3.3.7

type StartAppSkillPathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewStartAppSkillPathReqBodyBuilder added in v3.3.7

func NewStartAppSkillPathReqBodyBuilder() *StartAppSkillPathReqBodyBuilder

func (*StartAppSkillPathReqBodyBuilder) Build added in v3.3.7

func (*StartAppSkillPathReqBodyBuilder) GlobalVariable added in v3.3.7

技能的全局变量

示例值:

func (*StartAppSkillPathReqBodyBuilder) Input added in v3.3.7

技能的自定义变量

示例值:{"custom_s":"text","custom_i":12,"custom_b":true,"custom_f":1.2}

type StartAppSkillReq added in v3.3.7

type StartAppSkillReq struct {
	Body *StartAppSkillReqBody `body:""`
	// contains filtered or unexported fields
}

type StartAppSkillReqBody added in v3.3.7

type StartAppSkillReqBody struct {
	GlobalVariable *SkillGlobalVariable `json:"global_variable,omitempty"` // 技能的全局变量

	Input *string `json:"input,omitempty"` // 技能的自定义变量
}

type StartAppSkillReqBodyBuilder added in v3.3.7

type StartAppSkillReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewStartAppSkillReqBodyBuilder added in v3.3.7

func NewStartAppSkillReqBodyBuilder() *StartAppSkillReqBodyBuilder

func (*StartAppSkillReqBodyBuilder) Build added in v3.3.7

func (*StartAppSkillReqBodyBuilder) GlobalVariable added in v3.3.7

func (builder *StartAppSkillReqBodyBuilder) GlobalVariable(globalVariable *SkillGlobalVariable) *StartAppSkillReqBodyBuilder

技能的全局变量

示例值:

func (*StartAppSkillReqBodyBuilder) Input added in v3.3.7

技能的自定义变量

示例值:{"custom_s":"text","custom_i":12,"custom_b":true,"custom_f":1.2}

type StartAppSkillReqBuilder added in v3.3.7

type StartAppSkillReqBuilder struct {
	// contains filtered or unexported fields
}

func NewStartAppSkillReqBuilder added in v3.3.7

func NewStartAppSkillReqBuilder() *StartAppSkillReqBuilder

func (*StartAppSkillReqBuilder) AppId added in v3.3.7

应用 ID

示例值:spring_xxx__c

func (*StartAppSkillReqBuilder) Body added in v3.3.7

该 API 用于执行飞书智能伙伴应用的技能(Skill)获取输出

func (*StartAppSkillReqBuilder) Build added in v3.3.7

func (builder *StartAppSkillReqBuilder) Build() *StartAppSkillReq

func (*StartAppSkillReqBuilder) SkillId added in v3.3.7

func (builder *StartAppSkillReqBuilder) SkillId(skillId string) *StartAppSkillReqBuilder

技能 ID

示例值:skill_6cc6166178ca

type StartAppSkillResp added in v3.3.7

type StartAppSkillResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *StartAppSkillRespData `json:"data"` // 业务数据
}

func (*StartAppSkillResp) Success added in v3.3.7

func (resp *StartAppSkillResp) Success() bool

type StartAppSkillRespData added in v3.3.7

type StartAppSkillRespData struct {
	Output *string `json:"output,omitempty"` // 技能的输出

	Status *string `json:"status,omitempty"` // 技能的执行状态
}

type Suggestion added in v3.2.9

type Suggestion struct {
	Content *string `json:"content,omitempty"` // 推荐的内容

	SkillId *string `json:"skill_id,omitempty"` // 推荐的技能
}

type SuggestionBuilder added in v3.2.9

type SuggestionBuilder struct {
	// contains filtered or unexported fields
}

func NewSuggestionBuilder added in v3.2.9

func NewSuggestionBuilder() *SuggestionBuilder

func (*SuggestionBuilder) Build added in v3.2.9

func (builder *SuggestionBuilder) Build() *Suggestion

func (*SuggestionBuilder) Content added in v3.2.9

func (builder *SuggestionBuilder) Content(content string) *SuggestionBuilder

推荐的内容

示例值:今天天气如何

func (*SuggestionBuilder) SkillId added in v3.2.9

func (builder *SuggestionBuilder) SkillId(skillId string) *SuggestionBuilder

推荐的技能

示例值:skill_xxx

type Table

type Table struct {
	TableType *string `json:"table_type,omitempty"` // 表类型,分为 "datatable"、"dataset"

	ApiName *string `json:"api_name,omitempty"` // 数据表标识

	Label map[string]string `json:"label,omitempty"` // 数据表名称

	AccessItems []string `json:"access_items,omitempty"` // 数据表读写权限

	AiDescription *string `json:"ai_description,omitempty"` // 数据表描述信息

	Fields []*Field `json:"fields,omitempty"` // 数据表下的字段列表,获取数据表元信息详情时才会返回
}

type TableBuilder

type TableBuilder struct {
	// contains filtered or unexported fields
}

func NewTableBuilder

func NewTableBuilder() *TableBuilder

func (*TableBuilder) AccessItems

func (builder *TableBuilder) AccessItems(accessItems []string) *TableBuilder

数据表读写权限

示例值:

func (*TableBuilder) AiDescription

func (builder *TableBuilder) AiDescription(aiDescription string) *TableBuilder

数据表描述信息

示例值:这是一个商品的数据表

func (*TableBuilder) ApiName

func (builder *TableBuilder) ApiName(apiName string) *TableBuilder

数据表标识

示例值:object_a

func (*TableBuilder) Build

func (builder *TableBuilder) Build() *Table

func (*TableBuilder) Fields

func (builder *TableBuilder) Fields(fields []*Field) *TableBuilder

数据表下的字段列表,获取数据表元信息详情时才会返回

示例值:

func (*TableBuilder) Label

func (builder *TableBuilder) Label(label map[string]string) *TableBuilder

数据表名称

示例值:

func (*TableBuilder) TableType

func (builder *TableBuilder) TableType(tableType string) *TableBuilder

表类型,分为 "datatable"、"dataset"

示例值:datatable

type UpdateAilySessionPathReqBodyBuilder

type UpdateAilySessionPathReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewUpdateAilySessionPathReqBodyBuilder

func NewUpdateAilySessionPathReqBodyBuilder() *UpdateAilySessionPathReqBodyBuilder

func (*UpdateAilySessionPathReqBodyBuilder) Build

func (*UpdateAilySessionPathReqBodyBuilder) ChannelContext

func (builder *UpdateAilySessionPathReqBodyBuilder) ChannelContext(channelContext string) *UpdateAilySessionPathReqBodyBuilder

渠道上下文

示例值:{}

func (*UpdateAilySessionPathReqBodyBuilder) Metadata

其他透传信息

示例值:{}

type UpdateAilySessionReq

type UpdateAilySessionReq struct {
	Body *UpdateAilySessionReqBody `body:""`
	// contains filtered or unexported fields
}

type UpdateAilySessionReqBody

type UpdateAilySessionReqBody struct {
	ChannelContext *string `json:"channel_context,omitempty"` // 渠道上下文

	Metadata *string `json:"metadata,omitempty"` // 其他透传信息
}

type UpdateAilySessionReqBodyBuilder

type UpdateAilySessionReqBodyBuilder struct {
	// contains filtered or unexported fields
}

func NewUpdateAilySessionReqBodyBuilder

func NewUpdateAilySessionReqBodyBuilder() *UpdateAilySessionReqBodyBuilder

func (*UpdateAilySessionReqBodyBuilder) Build

func (*UpdateAilySessionReqBodyBuilder) ChannelContext

func (builder *UpdateAilySessionReqBodyBuilder) ChannelContext(channelContext string) *UpdateAilySessionReqBodyBuilder

渠道上下文

示例值:{}

func (*UpdateAilySessionReqBodyBuilder) Metadata

其他透传信息

示例值:{}

type UpdateAilySessionReqBuilder

type UpdateAilySessionReqBuilder struct {
	// contains filtered or unexported fields
}

func NewUpdateAilySessionReqBuilder

func NewUpdateAilySessionReqBuilder() *UpdateAilySessionReqBuilder

func (*UpdateAilySessionReqBuilder) AilySessionId

func (builder *UpdateAilySessionReqBuilder) AilySessionId(ailySessionId string) *UpdateAilySessionReqBuilder

会话 ID

示例值:session_4dfunz7sp1g8m

func (*UpdateAilySessionReqBuilder) Body

该 API 用于更新与某个飞书智能伙伴应用的一次会话(Session)。

func (*UpdateAilySessionReqBuilder) Build

type UpdateAilySessionResp

type UpdateAilySessionResp struct {
	*larkcore.ApiResp `json:"-"`
	larkcore.CodeError
	Data *UpdateAilySessionRespData `json:"data"` // 业务数据
}

func (*UpdateAilySessionResp) Success

func (resp *UpdateAilySessionResp) Success() bool

type UpdateAilySessionRespData

type UpdateAilySessionRespData struct {
	Session *AilySession `json:"session,omitempty"` // 会话信息
}

type V1

type V1 struct {
	AilySession            *ailySession            // aily_session
	AilySessionAilyMessage *ailySessionAilyMessage // aily_session.aily_message
	AilySessionRun         *ailySessionRun         // aily_session.run
	AppDataAsset           *appDataAsset           // app.data_asset
	AppDataAssetTag        *appDataAssetTag        // app.data_asset_tag
	AppKnowledge           *appKnowledge           // app.knowledge
	AppSkill               *appSkill               // app.skill
}

func New

func New(config *larkcore.Config) *V1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL