larksearch

package
v3.2.2 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: MIT Imports: 5 Imported by: 6

Documentation

Index

Constants

View Source 
const (
	UserIdTypeUserId  = "user_id"  // 以 user_id 来识别用户
	UserIdTypeUnionId = "union_id" // 以 union_id 来识别用户
	UserIdTypeOpenId  = "open_id"  // 以 open_id 来识别用户
)
View Source 
const (
	StateOnline  = 0 // 已上线
	StateOffline = 1 // 未上线

)
View Source 
const (
	ConnectTypeDefault  = 0 // 调用搜索请求时，使用的是飞书搜索接口
	ConnectTypeCallback = 1 // 调用搜索请求时，使用的是自定义回调函数的Uri

)
View Source 
const (
	ViewFULL  = 0 // 全量数据
	ViewBASIC = 1 // 摘要数据

)
View Source 
const (
	StatePatchDataSourceOnline  = 0 // 已上线
	StatePatchDataSourceOffline = 1 // 未上线

)
View Source 
const (
	MessageTypeFile  = "file"  // 文件
	MessageTypeImage = "image" // 图片
	MessageTypeMedia = "media" // 视频
)
View Source 
const (
	FromTypeBot  = "bot"  // 机器人
	FromTypeUser = "user" // 用户
)
View Source 
const (
	ChatTypeGroupChat = "group_chat" // 群聊
	ChatTypeP2pChat   = "p2p_chat"   // 单聊
)
View Source 
const (
	UserIdTypeCreateMessageUserId  = "user_id"  // 以 user_id 来识别用户
	UserIdTypeCreateMessageUnionId = "union_id" // 以 union_id 来识别用户
	UserIdTypeCreateMessageOpenId  = "open_id"  // 以 open_id 来识别用户
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Acl 

type Acl struct {
	Access *string `json:"access,omitempty"` // 权限类型，优先级：Deny > Allow。
	Value  *string `json:"value,omitempty"`  // 设置的权限值，例如 userID ，依赖 type 描述。;;**注**：在 type 为 user 且 access 为 allow 时，可填 "everyone" 来表示该数据项对全员可见；
	Type   *string `json:"type,omitempty"`   // 权限值类型
}

type AclBuilder 

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

func NewAclBuilder 

func NewAclBuilder() *AclBuilder

func (*AclBuilder) Access 

func (builder *AclBuilder) Access(access string) *AclBuilder

权限类型，优先级：Deny > Allow。

示例值：allow

func (*AclBuilder) Build 

func (builder *AclBuilder) Build() *Acl

func (*AclBuilder) Type 

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

权限值类型

示例值：user

func (*AclBuilder) Value 

func (builder *AclBuilder) Value(value string) *AclBuilder

设置的权限值，例如 userID ，依赖 type 描述。;;**注**：在 type 为 user 且 access 为 allow 时，可填 "everyone" 来表示该数据项对全员可见；

示例值：d35e3c23

type BatchItemResult 

type BatchItemResult struct {
	ItemId    *string `json:"item_id,omitempty"`    // 数据项ID，对应一条索引数据的ID
	IsSuccess *bool   `json:"is_success,omitempty"` // 判断单条数据是否成功
	Err       *string `json:"err,omitempty"`        // 如果单条数据失败，表示单条数据的错误信息；如果单条数据成功被索引，则err是空字符串
}

type BatchItemResultBuilder 

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

func NewBatchItemResultBuilder 

func NewBatchItemResultBuilder() *BatchItemResultBuilder

func (*BatchItemResultBuilder) Build 

func (builder *BatchItemResultBuilder) Build() *BatchItemResult

func (*BatchItemResultBuilder) Err 

func (builder *BatchItemResultBuilder) Err(err string) *BatchItemResultBuilder

如果单条数据失败，表示单条数据的错误信息；如果单条数据成功被索引，则err是空字符串

示例值：

func (*BatchItemResultBuilder) IsSuccess 

func (builder *BatchItemResultBuilder) IsSuccess(isSuccess bool) *BatchItemResultBuilder

判断单条数据是否成功

示例值：

func (*BatchItemResultBuilder) ItemId 

func (builder *BatchItemResultBuilder) ItemId(itemId string) *BatchItemResultBuilder

数据项ID，对应一条索引数据的ID

示例值：

type Chunk added in v3.0.24 

type Chunk struct {
	ChunkId    *string  `json:"chunk_id,omitempty"`    // 文本块的唯一标识
	DocId      *string  `json:"doc_id,omitempty"`      // 文档的唯一标识
	DatasetId  *string  `json:"dataset_id,omitempty"`  // 该文档对应的数据集id
	UpdateTime *string  `json:"update_time,omitempty"` // 更新时间，精确到秒级
	Content    *string  `json:"content,omitempty"`     // 需要向量化的文本内容
	FilterData *string  `json:"filter_data,omitempty"` // 数据集对应filter_shema的值
	Score      *float64 `json:"score,omitempty"`       // 排序模型返回的分数
	TokenNum   *int     `json:"token_num,omitempty"`   // 文本块的token数
	Overlength *bool    `json:"overlength,omitempty"`  // 文本块的长度是否超过阈值
}

type ChunkBuilder added in v3.0.24 

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

func NewChunkBuilder added in v3.0.24 

func NewChunkBuilder() *ChunkBuilder

func (*ChunkBuilder) Build added in v3.0.24 

func (builder *ChunkBuilder) Build() *Chunk

func (*ChunkBuilder) ChunkId added in v3.0.24 

func (builder *ChunkBuilder) ChunkId(chunkId string) *ChunkBuilder

文本块的唯一标识

示例值：3953903108179099661

func (*ChunkBuilder) Content added in v3.0.24 

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

需要向量化的文本内容

示例值：这是一段纯文本内容

func (*ChunkBuilder) DatasetId added in v3.0.24 

func (builder *ChunkBuilder) DatasetId(datasetId string) *ChunkBuilder

该文档对应的数据集id

示例值：6953903108179099667

func (*ChunkBuilder) DocId added in v3.0.24 

func (builder *ChunkBuilder) DocId(docId string) *ChunkBuilder

文档的唯一标识

示例值：3953903108179099667

func (*ChunkBuilder) FilterData added in v3.0.24 

func (builder *ChunkBuilder) FilterData(filterData string) *ChunkBuilder

数据集对应filter_shema的值

示例值：{\"domains\": [\"domain1\"],\"versions\": [\"v1\"]}

func (*ChunkBuilder) Overlength added in v3.0.24 

func (builder *ChunkBuilder) Overlength(overlength bool) *ChunkBuilder

文本块的长度是否超过阈值

示例值：false

func (*ChunkBuilder) Score added in v3.0.24 

func (builder *ChunkBuilder) Score(score float64) *ChunkBuilder

排序模型返回的分数

示例值：0.9

func (*ChunkBuilder) TokenNum added in v3.0.24 

func (builder *ChunkBuilder) TokenNum(tokenNum int) *ChunkBuilder

文本块的token数

示例值：480

func (*ChunkBuilder) UpdateTime added in v3.0.24 

func (builder *ChunkBuilder) UpdateTime(updateTime string) *ChunkBuilder

更新时间，精确到秒级

示例值：1990-12-31T23:59:60Z

type ConnectDataSource 

type ConnectDataSource struct {
	ServiceUrl         *string `json:"service_url,omitempty"`         // 要托管的服务API地址，例如https://open.feishu.cn/xxxx/xxxx
	ProjectName        *string `json:"project_name,omitempty"`        // 项目地址，只能包含小写字母，如bytedance_test
	DisplayName        *string `json:"display_name,omitempty"`        // datasource名称，会展示在飞书搜索分类按钮（searchTab）中，如：公司wiki
	Description        *string `json:"description,omitempty"`         // 描述datasource
	IconUrl            *string `json:"icon_url,omitempty"`            // 图标
	ProjectDescription *string `json:"project_description,omitempty"` // 托管api的描述
	ContactEmail       *string `json:"contact_email,omitempty"`       // 联系人邮箱，开发人员的邮箱，用于托管API的SLA（Service Level Agreement）问题沟通
	TenantName         *string `json:"tenant_name,omitempty"`         // 创建api的组织名称，对企业开发者来说，建议使用企业名称
}

type ConnectDataSourceBuilder 

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

func NewConnectDataSourceBuilder 

func NewConnectDataSourceBuilder() *ConnectDataSourceBuilder

func (*ConnectDataSourceBuilder) Build 

func (builder *ConnectDataSourceBuilder) Build() *ConnectDataSource

func (*ConnectDataSourceBuilder) ContactEmail 

func (builder *ConnectDataSourceBuilder) ContactEmail(contactEmail string) *ConnectDataSourceBuilder

联系人邮箱，开发人员的邮箱，用于托管API的SLA（Service Level Agreement）问题沟通

示例值：

func (*ConnectDataSourceBuilder) Description 

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

描述datasource

示例值：

func (*ConnectDataSourceBuilder) DisplayName 

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

datasource名称，会展示在飞书搜索分类按钮（searchTab）中，如：公司wiki

示例值：

func (*ConnectDataSourceBuilder) IconUrl 

func (builder *ConnectDataSourceBuilder) IconUrl(iconUrl string) *ConnectDataSourceBuilder

图标

示例值：

func (*ConnectDataSourceBuilder) ProjectDescription 

func (builder *ConnectDataSourceBuilder) ProjectDescription(projectDescription string) *ConnectDataSourceBuilder

托管api的描述

示例值：

func (*ConnectDataSourceBuilder) ProjectName 

func (builder *ConnectDataSourceBuilder) ProjectName(projectName string) *ConnectDataSourceBuilder

项目地址，只能包含小写字母，如bytedance_test

示例值：

func (*ConnectDataSourceBuilder) ServiceUrl 

func (builder *ConnectDataSourceBuilder) ServiceUrl(serviceUrl string) *ConnectDataSourceBuilder

要托管的服务API地址，例如https://open.feishu.cn/xxxx/xxxx

示例值：

func (*ConnectDataSourceBuilder) TenantName 

func (builder *ConnectDataSourceBuilder) TenantName(tenantName string) *ConnectDataSourceBuilder

创建api的组织名称，对企业开发者来说，建议使用企业名称

示例值：

type ConnectorParam added in v3.0.30 

type ConnectorParam struct {
	CallbackUserIdType *int    `json:"callback_user_id_type,omitempty"` // 回调时Request里面的id类型
	CallbackEndpoint   *string `json:"callback_endpoint,omitempty"`     // 回调时的地址，必须为POST地址
}

type ConnectorParamBuilder added in v3.0.30 

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

func NewConnectorParamBuilder added in v3.0.30 

func NewConnectorParamBuilder() *ConnectorParamBuilder

func (*ConnectorParamBuilder) Build added in v3.0.30 

func (builder *ConnectorParamBuilder) Build() *ConnectorParam

func (*ConnectorParamBuilder) CallbackEndpoint added in v3.0.30 

func (builder *ConnectorParamBuilder) CallbackEndpoint(callbackEndpoint string) *ConnectorParamBuilder

回调时的地址，必须为POST地址

示例值：https://open.approval.cn/api/search

func (*ConnectorParamBuilder) CallbackUserIdType added in v3.0.30 

func (builder *ConnectorParamBuilder) CallbackUserIdType(callbackUserIdType int) *ConnectorParamBuilder

回调时Request里面的id类型

示例值：1

type CreateAppPathReqBodyBuilder added in v3.0.20 

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

func NewCreateAppPathReqBodyBuilder added in v3.0.20 

func NewCreateAppPathReqBodyBuilder() *CreateAppPathReqBodyBuilder

func (*CreateAppPathReqBodyBuilder) Build added in v3.0.20 

func (builder *CreateAppPathReqBodyBuilder) Build() (*CreateAppReqBody, error)

func (*CreateAppPathReqBodyBuilder) Query added in v3.0.20 

func (builder *CreateAppPathReqBodyBuilder) Query(query string) *CreateAppPathReqBodyBuilder

搜索关键词

示例值：测试应用

type CreateAppReq added in v3.0.20 

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

type CreateAppReqBody added in v3.0.20 

type CreateAppReqBody struct {
	Query *string `json:"query,omitempty"` // 搜索关键词
}

type CreateAppReqBodyBuilder added in v3.0.20 

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

func NewCreateAppReqBodyBuilder added in v3.0.20 

func NewCreateAppReqBodyBuilder() *CreateAppReqBodyBuilder

func (*CreateAppReqBodyBuilder) Build added in v3.0.20 

func (builder *CreateAppReqBodyBuilder) Build() *CreateAppReqBody

func (*CreateAppReqBodyBuilder) Query added in v3.0.20 

func (builder *CreateAppReqBodyBuilder) Query(query string) *CreateAppReqBodyBuilder

搜索关键词

示例值：测试应用

type CreateAppReqBuilder added in v3.0.20 

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

func NewCreateAppReqBuilder added in v3.0.20 

func NewCreateAppReqBuilder() *CreateAppReqBuilder

func (*CreateAppReqBuilder) Body added in v3.0.20 

func (builder *CreateAppReqBuilder) Body(body *CreateAppReqBody) *CreateAppReqBuilder

func (*CreateAppReqBuilder) Build added in v3.0.20 

func (builder *CreateAppReqBuilder) Build() *CreateAppReq

func (*CreateAppReqBuilder) PageSize added in v3.0.20 

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

分页大小

示例值：

func (*CreateAppReqBuilder) PageToken added in v3.0.20 

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

分页token

示例值：

func (*CreateAppReqBuilder) UserIdType added in v3.0.20 

func (builder *CreateAppReqBuilder) UserIdType(userIdType string) *CreateAppReqBuilder

此次调用中使用的用户ID的类型

示例值：

type CreateAppResp added in v3.0.20 

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

func (*CreateAppResp) Success added in v3.0.20 

func (resp *CreateAppResp) Success() bool

type CreateAppRespData added in v3.0.20 

type CreateAppRespData struct {
	Items     []string `json:"items,omitempty"`      // app_id列表
	PageToken *string  `json:"page_token,omitempty"` // 翻页 token，传入返回下一页，首页不需要传入
	HasMore   *bool    `json:"has_more,omitempty"`   // 是否还有下一页
}

type CreateDataSourceItemReq 

type CreateDataSourceItemReq struct {
	Item *Item `body:""`
	// contains filtered or unexported fields
}

type CreateDataSourceItemReqBuilder 

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

func NewCreateDataSourceItemReqBuilder 

func NewCreateDataSourceItemReqBuilder() *CreateDataSourceItemReqBuilder

func (*CreateDataSourceItemReqBuilder) Build 

func (builder *CreateDataSourceItemReqBuilder) Build() *CreateDataSourceItemReq

func (*CreateDataSourceItemReqBuilder) DataSourceId 

func (builder *CreateDataSourceItemReqBuilder) DataSourceId(dataSourceId string) *CreateDataSourceItemReqBuilder

数据源的ID

示例值：service_ticket

func (*CreateDataSourceItemReqBuilder) Item 

func (builder *CreateDataSourceItemReqBuilder) Item(item *Item) *CreateDataSourceItemReqBuilder

索引一条数据记录

type CreateDataSourceItemResp 

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

func (*CreateDataSourceItemResp) Success 

func (resp *CreateDataSourceItemResp) Success() bool

type CreateDataSourceReq 

type CreateDataSourceReq struct {
	DataSource *DataSource `body:""`
	// contains filtered or unexported fields
}

type CreateDataSourceReqBuilder 

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

func NewCreateDataSourceReqBuilder 

func NewCreateDataSourceReqBuilder() *CreateDataSourceReqBuilder

func (*CreateDataSourceReqBuilder) Build 

func (builder *CreateDataSourceReqBuilder) Build() *CreateDataSourceReq

func (*CreateDataSourceReqBuilder) DataSource 

func (builder *CreateDataSourceReqBuilder) DataSource(dataSource *DataSource) *CreateDataSourceReqBuilder

创建一个数据源

type CreateDataSourceResp 

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

func (*CreateDataSourceResp) Success 

func (resp *CreateDataSourceResp) Success() bool

type CreateDataSourceRespData 

type CreateDataSourceRespData struct {
	DataSource *DataSource `json:"data_source,omitempty"` // 数据源实例
}

type CreateDocParam added in v3.0.24 

type CreateDocParam struct {
	DocId                *string  `json:"doc_id,omitempty"`                 // 文档的唯一标识，只允许英文字母、数字和下划线
	FilterData           *string  `json:"filter_data,omitempty"`            // 文档对应filter_schema的值
	Content              *string  `json:"content,omitempty"`                // 需要向量化的文本内容
	Chunks               []string `json:"chunks,omitempty"`                 // 文本块列表
	OverlengthHandleType *int     `json:"overlength_handle_type,omitempty"` // 如果文本块超过最大长度的话，确定返回错误还是进行截断，默认是返回错误
}

type CreateDocParamBuilder added in v3.0.24 

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

func NewCreateDocParamBuilder added in v3.0.24 

func NewCreateDocParamBuilder() *CreateDocParamBuilder

func (*CreateDocParamBuilder) Build added in v3.0.24 

func (builder *CreateDocParamBuilder) Build() *CreateDocParam

func (*CreateDocParamBuilder) Chunks added in v3.0.24 

func (builder *CreateDocParamBuilder) Chunks(chunks []string) *CreateDocParamBuilder

文本块列表

示例值：

func (*CreateDocParamBuilder) Content added in v3.0.24 

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

需要向量化的文本内容

示例值：这是一段纯文本内容，模型会将这段话变成向量

func (*CreateDocParamBuilder) DocId added in v3.0.24 

func (builder *CreateDocParamBuilder) DocId(docId string) *CreateDocParamBuilder

文档的唯一标识，只允许英文字母、数字和下划线

示例值：3953903108179099667

func (*CreateDocParamBuilder) FilterData added in v3.0.24 

func (builder *CreateDocParamBuilder) FilterData(filterData string) *CreateDocParamBuilder

文档对应filter_schema的值

示例值：{\"domains\": [\"domain1\"],\"versions\": [\"v1\"]}

func (*CreateDocParamBuilder) OverlengthHandleType added in v3.0.24 

func (builder *CreateDocParamBuilder) OverlengthHandleType(overlengthHandleType int) *CreateDocParamBuilder

如果文本块超过最大长度的话，确定返回错误还是进行截断，默认是返回错误

示例值：1

type CreateMessagePathReqBodyBuilder added in v3.0.20 

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

func NewCreateMessagePathReqBodyBuilder added in v3.0.20 

func NewCreateMessagePathReqBodyBuilder() *CreateMessagePathReqBodyBuilder

func (*CreateMessagePathReqBodyBuilder) AtChatterIds added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) AtChatterIds(atChatterIds []string) *CreateMessagePathReqBodyBuilder

at用户user_id列表

示例值：

func (*CreateMessagePathReqBodyBuilder) Build added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) Build() (*CreateMessageReqBody, error)

func (*CreateMessagePathReqBodyBuilder) ChatIds added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) ChatIds(chatIds []string) *CreateMessagePathReqBodyBuilder

消息所在chat_id列表

示例值：

func (*CreateMessagePathReqBodyBuilder) ChatType added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) ChatType(chatType string) *CreateMessagePathReqBodyBuilder

会话类型(group_chat/p2p_chat)

示例值：

func (*CreateMessagePathReqBodyBuilder) EndTime added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) EndTime(endTime string) *CreateMessagePathReqBodyBuilder

消息发送结束时间

示例值：1609296809

func (*CreateMessagePathReqBodyBuilder) FromIds added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) FromIds(fromIds []string) *CreateMessagePathReqBodyBuilder

消息来自user_id列表

示例值：

func (*CreateMessagePathReqBodyBuilder) FromType added in v3.0.20 

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

消息来自类型(bot/user)

示例值：

func (*CreateMessagePathReqBodyBuilder) MessageType added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) MessageType(messageType string) *CreateMessagePathReqBodyBuilder

消息类型(file/image/media)

示例值：

func (*CreateMessagePathReqBodyBuilder) Query added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) Query(query string) *CreateMessagePathReqBodyBuilder

搜索关键词

示例值：测试消息

func (*CreateMessagePathReqBodyBuilder) StartTime added in v3.0.20 

func (builder *CreateMessagePathReqBodyBuilder) StartTime(startTime string) *CreateMessagePathReqBodyBuilder

消息发送起始时间

示例值：1609296809

type CreateMessageReq added in v3.0.20 

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

type CreateMessageReqBody added in v3.0.20 

type CreateMessageReqBody struct {
	Query        *string  `json:"query,omitempty"`          // 搜索关键词
	FromIds      []string `json:"from_ids,omitempty"`       // 消息来自user_id列表
	ChatIds      []string `json:"chat_ids,omitempty"`       // 消息所在chat_id列表
	MessageType  *string  `json:"message_type,omitempty"`   // 消息类型(file/image/media)
	AtChatterIds []string `json:"at_chatter_ids,omitempty"` // at用户user_id列表
	FromType     *string  `json:"from_type,omitempty"`      // 消息来自类型(bot/user)
	ChatType     *string  `json:"chat_type,omitempty"`      // 会话类型(group_chat/p2p_chat)
	StartTime    *string  `json:"start_time,omitempty"`     // 消息发送起始时间
	EndTime      *string  `json:"end_time,omitempty"`       // 消息发送结束时间
}

type CreateMessageReqBodyBuilder added in v3.0.20 

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

func NewCreateMessageReqBodyBuilder added in v3.0.20 

func NewCreateMessageReqBodyBuilder() *CreateMessageReqBodyBuilder

func (*CreateMessageReqBodyBuilder) AtChatterIds added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) AtChatterIds(atChatterIds []string) *CreateMessageReqBodyBuilder

at用户user_id列表

示例值：

func (*CreateMessageReqBodyBuilder) Build added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) Build() *CreateMessageReqBody

func (*CreateMessageReqBodyBuilder) ChatIds added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) ChatIds(chatIds []string) *CreateMessageReqBodyBuilder

消息所在chat_id列表

示例值：

func (*CreateMessageReqBodyBuilder) ChatType added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) ChatType(chatType string) *CreateMessageReqBodyBuilder

会话类型(group_chat/p2p_chat)

示例值：

func (*CreateMessageReqBodyBuilder) EndTime added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) EndTime(endTime string) *CreateMessageReqBodyBuilder

消息发送结束时间

示例值：1609296809

func (*CreateMessageReqBodyBuilder) FromIds added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) FromIds(fromIds []string) *CreateMessageReqBodyBuilder

消息来自user_id列表

示例值：

func (*CreateMessageReqBodyBuilder) FromType added in v3.0.20 

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

消息来自类型(bot/user)

示例值：

func (*CreateMessageReqBodyBuilder) MessageType added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) MessageType(messageType string) *CreateMessageReqBodyBuilder

消息类型(file/image/media)

示例值：

func (*CreateMessageReqBodyBuilder) Query added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) Query(query string) *CreateMessageReqBodyBuilder

搜索关键词

示例值：测试消息

func (*CreateMessageReqBodyBuilder) StartTime added in v3.0.20 

func (builder *CreateMessageReqBodyBuilder) StartTime(startTime string) *CreateMessageReqBodyBuilder

消息发送起始时间

示例值：1609296809

type CreateMessageReqBuilder added in v3.0.20 

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

func NewCreateMessageReqBuilder added in v3.0.20 

func NewCreateMessageReqBuilder() *CreateMessageReqBuilder

func (*CreateMessageReqBuilder) Body added in v3.0.20 

func (builder *CreateMessageReqBuilder) Body(body *CreateMessageReqBody) *CreateMessageReqBuilder

func (*CreateMessageReqBuilder) Build added in v3.0.20 

func (builder *CreateMessageReqBuilder) Build() *CreateMessageReq

func (*CreateMessageReqBuilder) PageSize added in v3.0.20 

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

分页大小

示例值：

func (*CreateMessageReqBuilder) PageToken added in v3.0.20 

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

分页token

示例值：

func (*CreateMessageReqBuilder) UserIdType added in v3.0.20 

func (builder *CreateMessageReqBuilder) UserIdType(userIdType string) *CreateMessageReqBuilder

此次调用中使用的用户ID的类型

示例值：

type CreateMessageResp added in v3.0.20 

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

func (*CreateMessageResp) Success added in v3.0.20 

func (resp *CreateMessageResp) Success() bool

type CreateMessageRespData added in v3.0.20 

type CreateMessageRespData struct {
	Items     []string `json:"items,omitempty"`      // 消息id列表
	PageToken *string  `json:"page_token,omitempty"` // 翻页 token，传入返回下一页，首页不需要传入
	HasMore   *bool    `json:"has_more,omitempty"`   // 是否还有下一页
}

type CreateSchemaReq 

type CreateSchemaReq struct {
	Schema *Schema `body:""`
	// contains filtered or unexported fields
}

type CreateSchemaReqBuilder 

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

func NewCreateSchemaReqBuilder 

func NewCreateSchemaReqBuilder() *CreateSchemaReqBuilder

func (*CreateSchemaReqBuilder) Build 

func (builder *CreateSchemaReqBuilder) Build() *CreateSchemaReq

func (*CreateSchemaReqBuilder) Schema 

func (builder *CreateSchemaReqBuilder) Schema(schema *Schema) *CreateSchemaReqBuilder

创建一个数据范式

func (*CreateSchemaReqBuilder) ValidateOnly 

func (builder *CreateSchemaReqBuilder) ValidateOnly(validateOnly bool) *CreateSchemaReqBuilder

是否只用来校验合法性

示例值：true

type CreateSchemaResp 

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

func (*CreateSchemaResp) Success 

func (resp *CreateSchemaResp) Success() bool

type CreateSchemaRespData 

type CreateSchemaRespData struct {
	Schema *Schema `json:"schema,omitempty"` // 数据范式实例
}

type DataSource 

type DataSource struct {
	Id               *string         `json:"id,omitempty"`                // 数据源的唯一标识
	Name             *string         `json:"name,omitempty"`              // data_source的展示名称
	State            *int            `json:"state,omitempty"`             // 数据源状态，0-已上线，1-未上线。如果未填，默认是未上线状态。
	Description      *string         `json:"description,omitempty"`       // 对于数据源的描述
	CreateTime       *string         `json:"create_time,omitempty"`       // 创建时间，使用Unix时间戳，单位为“秒”
	UpdateTime       *string         `json:"update_time,omitempty"`       // 更新时间，使用Unix时间戳，单位为“秒”
	IsExceedQuota    *bool           `json:"is_exceed_quota,omitempty"`   // 是否超限
	IconUrl          *string         `json:"icon_url,omitempty"`          // 数据源在 search tab 上的展示图标路径
	Template         *string         `json:"template,omitempty"`          // 数据源采用的展示模版名称
	SearchableFields []string        `json:"searchable_fields,omitempty"` // 【已废弃，如有定制需要请使用“数据范式”接口】描述哪些字段可以被搜索
	I18nName         *I18nMeta       `json:"i18n_name,omitempty"`         // 数据源的国际化展示名称
	I18nDescription  *I18nMeta       `json:"i18n_description,omitempty"`  // 数据源的国际化描述
	SchemaId         *string         `json:"schema_id,omitempty"`         // 数据源关联的 schema 标识
	AppId            *string         `json:"app_id,omitempty"`            // datasource对应的开放平台应用id
	ConnectType      *int            `json:"connect_type,omitempty"`      // 搜索请求的接入方式
	ConnectorParam   *ConnectorParam `json:"connector_param,omitempty"`   // 根据连接器类型不同所需要提供的相关参数
	EnableAnswer     *bool           `json:"enable_answer,omitempty"`     // 是否使用问答服务
}

type DataSourceBuilder 

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

func NewDataSourceBuilder 

func NewDataSourceBuilder() *DataSourceBuilder

func (*DataSourceBuilder) AppId added in v3.0.18 

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

datasource对应的开放平台应用id

示例值：cli_a1306bed4738d01b

func (*DataSourceBuilder) Build 

func (builder *DataSourceBuilder) Build() *DataSource

func (*DataSourceBuilder) ConnectType added in v3.0.30 

func (builder *DataSourceBuilder) ConnectType(connectType int) *DataSourceBuilder

搜索请求的接入方式

示例值：1

func (*DataSourceBuilder) ConnectorParam added in v3.0.30 

func (builder *DataSourceBuilder) ConnectorParam(connectorParam *ConnectorParam) *DataSourceBuilder

根据连接器类型不同所需要提供的相关参数

示例值：

func (*DataSourceBuilder) CreateTime 

func (builder *DataSourceBuilder) CreateTime(createTime string) *DataSourceBuilder

创建时间，使用Unix时间戳，单位为“秒”

示例值：1674309260

func (*DataSourceBuilder) Description 

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

对于数据源的描述

示例值：搜索客服工单数据

func (*DataSourceBuilder) EnableAnswer added in v3.0.31 

func (builder *DataSourceBuilder) EnableAnswer(enableAnswer bool) *DataSourceBuilder

是否使用问答服务

示例值：false

func (*DataSourceBuilder) I18nDescription 

func (builder *DataSourceBuilder) I18nDescription(i18nDescription *I18nMeta) *DataSourceBuilder

数据源的国际化描述

示例值：

func (*DataSourceBuilder) I18nName 

func (builder *DataSourceBuilder) I18nName(i18nName *I18nMeta) *DataSourceBuilder

数据源的国际化展示名称

示例值：

func (*DataSourceBuilder) IconUrl 

func (builder *DataSourceBuilder) IconUrl(iconUrl string) *DataSourceBuilder

数据源在 search tab 上的展示图标路径

示例值：https://www.xxx.com/open.jpg

func (*DataSourceBuilder) Id 

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

数据源的唯一标识

示例值：5577006791947779410

func (*DataSourceBuilder) IsExceedQuota 

func (builder *DataSourceBuilder) IsExceedQuota(isExceedQuota bool) *DataSourceBuilder

是否超限

示例值：false

func (*DataSourceBuilder) Name 

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

data_source的展示名称

示例值：客服工单

func (*DataSourceBuilder) SchemaId 

func (builder *DataSourceBuilder) SchemaId(schemaId string) *DataSourceBuilder

数据源关联的 schema 标识

示例值：custom_schema

func (*DataSourceBuilder) SearchableFields 

func (builder *DataSourceBuilder) SearchableFields(searchableFields []string) *DataSourceBuilder

【已废弃，如有定制需要请使用“数据范式”接口】描述哪些字段可以被搜索

示例值：【已废弃，如有定制需要请使用“数据范式”接口】["field1", "field2"]

func (*DataSourceBuilder) State 

func (builder *DataSourceBuilder) State(state int) *DataSourceBuilder

数据源状态，0-已上线，1-未上线。如果未填，默认是未上线状态。

示例值：0

func (*DataSourceBuilder) Template 

func (builder *DataSourceBuilder) Template(template string) *DataSourceBuilder

数据源采用的展示模版名称

示例值：search_common_card

func (*DataSourceBuilder) UpdateTime 

func (builder *DataSourceBuilder) UpdateTime(updateTime string) *DataSourceBuilder

更新时间，使用Unix时间戳，单位为“秒”

示例值：1674309260

type Dataset added in v3.0.24 

type Dataset struct {
	DatasetId     *string         `json:"dataset_id,omitempty"`     // 数据集的唯一标识
	AppId         *string         `json:"app_id,omitempty"`         // 该数据集对应的开放平台应用id
	CreateTime    *string         `json:"create_time,omitempty"`    // 创建时间，精确到秒级
	UpdateTime    *string         `json:"update_time,omitempty"`    // 更新时间
	ChunkNum      *int            `json:"chunk_num,omitempty"`      // 数据集中的索引数据的数量
	DocNum        *int            `json:"doc_num,omitempty"`        // 数据集中的数据项的数量
	Name          *string         `json:"name,omitempty"`           // 数据源的名字，只允许英文字母、数字和下划线，需要保证应用内部的唯一性。
	Description   *string         `json:"description,omitempty"`    // 描述该数据集的具体内容以及相关用途
	FilterSchemas []*FilterSchema `json:"filter_schemas,omitempty"` // 过滤字段，每个数据集支持多个过滤字段
	ModelConfig   *ModelConfig    `json:"model_config,omitempty"`   // 模型配置
	ViewerAppIds  []string        `json:"viewer_app_ids,omitempty"` // 被授权可搜/可见的应用
}

type DatasetBuilder added in v3.0.24 

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

func NewDatasetBuilder added in v3.0.24 

func NewDatasetBuilder() *DatasetBuilder

func (*DatasetBuilder) AppId added in v3.0.24 

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

该数据集对应的开放平台应用id

示例值：cli_a1306bed4738d01b

func (*DatasetBuilder) Build added in v3.0.24 

func (builder *DatasetBuilder) Build() *Dataset

func (*DatasetBuilder) ChunkNum added in v3.0.24 

func (builder *DatasetBuilder) ChunkNum(chunkNum int) *DatasetBuilder

数据集中的索引数据的数量

示例值：1000

func (*DatasetBuilder) CreateTime added in v3.0.24 

func (builder *DatasetBuilder) CreateTime(createTime string) *DatasetBuilder

创建时间，精确到秒级

示例值：1990-12-31T23:59:60Z

func (*DatasetBuilder) DatasetId added in v3.0.24 

func (builder *DatasetBuilder) DatasetId(datasetId string) *DatasetBuilder

数据集的唯一标识

示例值：6953903108179099667

func (*DatasetBuilder) Description added in v3.0.24 

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

描述该数据集的具体内容以及相关用途

示例值：飞书官网等网页上的数据，主要用于搜索问答

func (*DatasetBuilder) DocNum added in v3.0.24 

func (builder *DatasetBuilder) DocNum(docNum int) *DatasetBuilder

数据集中的数据项的数量

示例值：100

func (*DatasetBuilder) FilterSchemas added in v3.0.24 

func (builder *DatasetBuilder) FilterSchemas(filterSchemas []*FilterSchema) *DatasetBuilder

过滤字段，每个数据集支持多个过滤字段

示例值：

func (*DatasetBuilder) ModelConfig added in v3.0.24 

func (builder *DatasetBuilder) ModelConfig(modelConfig *ModelConfig) *DatasetBuilder

模型配置

示例值：

func (*DatasetBuilder) Name added in v3.0.24 

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

数据源的名字，只允许英文字母、数字和下划线，需要保证应用内部的唯一性。

示例值：feishu_web_1

func (*DatasetBuilder) UpdateTime added in v3.0.24 

func (builder *DatasetBuilder) UpdateTime(updateTime string) *DatasetBuilder

更新时间

示例值：1990-12-31T23:59:60Z

func (*DatasetBuilder) ViewerAppIds added in v3.0.24 

func (builder *DatasetBuilder) ViewerAppIds(viewerAppIds []string) *DatasetBuilder

被授权可搜/可见的应用

示例值：

type DeleteDataSourceItemReq 

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

type DeleteDataSourceItemReqBuilder 

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

func NewDeleteDataSourceItemReqBuilder 

func NewDeleteDataSourceItemReqBuilder() *DeleteDataSourceItemReqBuilder

func (*DeleteDataSourceItemReqBuilder) Build 

func (builder *DeleteDataSourceItemReqBuilder) Build() *DeleteDataSourceItemReq

func (*DeleteDataSourceItemReqBuilder) DataSourceId 

func (builder *DeleteDataSourceItemReqBuilder) DataSourceId(dataSourceId string) *DeleteDataSourceItemReqBuilder

数据源的ID

示例值：service_ticket

func (*DeleteDataSourceItemReqBuilder) ItemId 

func (builder *DeleteDataSourceItemReqBuilder) ItemId(itemId string) *DeleteDataSourceItemReqBuilder

数据记录的ID

示例值：01010111

type DeleteDataSourceItemResp 

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

func (*DeleteDataSourceItemResp) Success 

func (resp *DeleteDataSourceItemResp) Success() bool

type DeleteDataSourceReq 

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

type DeleteDataSourceReqBuilder 

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

func NewDeleteDataSourceReqBuilder 

func NewDeleteDataSourceReqBuilder() *DeleteDataSourceReqBuilder

func (*DeleteDataSourceReqBuilder) Build 

func (builder *DeleteDataSourceReqBuilder) Build() *DeleteDataSourceReq

func (*DeleteDataSourceReqBuilder) DataSourceId 

func (builder *DeleteDataSourceReqBuilder) DataSourceId(dataSourceId string) *DeleteDataSourceReqBuilder

数据源的唯一标识

示例值：6953903108179099667

type DeleteDataSourceResp 

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

func (*DeleteDataSourceResp) Success 

func (resp *DeleteDataSourceResp) Success() bool

type DeleteSchemaReq 

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

type DeleteSchemaReqBuilder 

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

func NewDeleteSchemaReqBuilder 

func NewDeleteSchemaReqBuilder() *DeleteSchemaReqBuilder

func (*DeleteSchemaReqBuilder) Build 

func (builder *DeleteSchemaReqBuilder) Build() *DeleteSchemaReq

func (*DeleteSchemaReqBuilder) SchemaId 

func (builder *DeleteSchemaReqBuilder) SchemaId(schemaId string) *DeleteSchemaReqBuilder

用户自定义数据范式的唯一标识

示例值：custom_schema_id

type DeleteSchemaResp 

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

func (*DeleteSchemaResp) Success 

func (resp *DeleteSchemaResp) Success() bool

type DepartmentId added in v3.0.29 

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

type DepartmentIdBuilder added in v3.0.29 

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

func NewDepartmentIdBuilder added in v3.0.29 

func NewDepartmentIdBuilder() *DepartmentIdBuilder

func (*DepartmentIdBuilder) Build added in v3.0.29 

func (builder *DepartmentIdBuilder) Build() *DepartmentId

func (*DepartmentIdBuilder) DepartmentId added in v3.0.29 

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

示例值：

func (*DepartmentIdBuilder) OpenDepartmentId added in v3.0.29 

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

示例值：

type DialogSearchRequest added in v3.1.3 

type DialogSearchRequest struct {
	ToolRawInstruction           *string          `json:"tool_raw_instruction,omitempty"`            // 用户问题
	ScenarioContextSchemaVersion *string          `json:"scenario_context_schema_version,omitempty"` // 场景上下文的schema版本号
	ScenarioContext              *ScenarioContext `json:"scenario_context,omitempty"`                // 场景上下文
}

type DialogSearchRequestBuilder added in v3.1.3 

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

func NewDialogSearchRequestBuilder added in v3.1.3 

func NewDialogSearchRequestBuilder() *DialogSearchRequestBuilder

func (*DialogSearchRequestBuilder) Build added in v3.1.3 

func (builder *DialogSearchRequestBuilder) Build() *DialogSearchRequest

func (*DialogSearchRequestBuilder) ScenarioContext added in v3.1.3 

func (builder *DialogSearchRequestBuilder) ScenarioContext(scenarioContext *ScenarioContext) *DialogSearchRequestBuilder

场景上下文

示例值：

func (*DialogSearchRequestBuilder) ScenarioContextSchemaVersion added in v3.1.3 

func (builder *DialogSearchRequestBuilder) ScenarioContextSchemaVersion(scenarioContextSchemaVersion string) *DialogSearchRequestBuilder

场景上下文的schema版本号

示例值：v1

func (*DialogSearchRequestBuilder) ToolRawInstruction added in v3.1.3 

func (builder *DialogSearchRequestBuilder) ToolRawInstruction(toolRawInstruction string) *DialogSearchRequestBuilder

用户问题

示例值：帮我找一下昨天发的文档

type Doc added in v3.0.24 

type Doc struct {
	DocId      *string  `json:"doc_id,omitempty"`      // 文档的唯一标识，只允许英文字母、数字和下划线
	FilterData *string  `json:"filter_data,omitempty"` // 文档对应filter_schema的值
	Chunks     []*Chunk `json:"chunks,omitempty"`      // 文本块列表
}

type DocBuilder added in v3.0.24 

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

func NewDocBuilder added in v3.0.24 

func NewDocBuilder() *DocBuilder

func (*DocBuilder) Build added in v3.0.24 

func (builder *DocBuilder) Build() *Doc

func (*DocBuilder) Chunks added in v3.0.24 

func (builder *DocBuilder) Chunks(chunks []*Chunk) *DocBuilder

文本块列表

示例值：

func (*DocBuilder) DocId added in v3.0.24 

func (builder *DocBuilder) DocId(docId string) *DocBuilder

文档的唯一标识，只允许英文字母、数字和下划线

示例值：3953903108179099667

func (*DocBuilder) FilterData added in v3.0.24 

func (builder *DocBuilder) FilterData(filterData string) *DocBuilder

文档对应filter_schema的值

示例值：{\"domains\": [\"domain1\"],\"versions\": [\"v1\"]}

type DocPassageParam added in v3.0.24 

type DocPassageParam struct {
	Searchable        *bool    `json:"searchable,omitempty"`          // 是否要搜索doc
	DocTokens         []string `json:"doc_tokens,omitempty"`          // 搜索几篇特定doc
	FolderTokens      []string `json:"folder_tokens,omitempty"`       // 搜索特定的文件夹
	ObjIds            []string `json:"obj_ids,omitempty"`             // 搜索特定doc（仅限内部使用，有需求请用doc_tokens）
	DisableSearchLink *bool    `json:"disable_search_link,omitempty"` // 禁用搜索外链文档功能
}

type DocPassageParamBuilder added in v3.0.24 

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

func NewDocPassageParamBuilder added in v3.0.24 

func NewDocPassageParamBuilder() *DocPassageParamBuilder

func (*DocPassageParamBuilder) Build added in v3.0.24 

func (builder *DocPassageParamBuilder) Build() *DocPassageParam
func (builder *DocPassageParamBuilder) DisableSearchLink(disableSearchLink bool) *DocPassageParamBuilder

禁用搜索外链文档功能

示例值：false

func (*DocPassageParamBuilder) DocTokens added in v3.0.24 

func (builder *DocPassageParamBuilder) DocTokens(docTokens []string) *DocPassageParamBuilder

搜索几篇特定doc

示例值：

func (*DocPassageParamBuilder) FolderTokens added in v3.0.27 

func (builder *DocPassageParamBuilder) FolderTokens(folderTokens []string) *DocPassageParamBuilder

搜索特定的文件夹

示例值：

func (*DocPassageParamBuilder) ObjIds added in v3.0.30 

func (builder *DocPassageParamBuilder) ObjIds(objIds []string) *DocPassageParamBuilder

搜索特定doc（仅限内部使用，有需求请用doc_tokens）

示例值：

func (*DocPassageParamBuilder) Searchable added in v3.0.24 

func (builder *DocPassageParamBuilder) Searchable(searchable bool) *DocPassageParamBuilder

是否要搜索doc

示例值：false

type FilterSchema added in v3.0.24 

type FilterSchema struct {
	Field      *string `json:"field,omitempty"`       // 过滤字段的名字
	Type       *string `json:"type,omitempty"`        // 过滤字段的类型
	DefaultVal *string `json:"default_val,omitempty"` // 过滤字段的默认值
	FieldType  *string `json:"field_type,omitempty"`  // 用于构建dsl过滤的类型，默认是enum
}

type FilterSchemaBuilder added in v3.0.24 

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

func NewFilterSchemaBuilder added in v3.0.24 

func NewFilterSchemaBuilder() *FilterSchemaBuilder

func (*FilterSchemaBuilder) Build added in v3.0.24 

func (builder *FilterSchemaBuilder) Build() *FilterSchema

func (*FilterSchemaBuilder) DefaultVal added in v3.0.24 

func (builder *FilterSchemaBuilder) DefaultVal(defaultVal string) *FilterSchemaBuilder

过滤字段的默认值

示例值：-1

func (*FilterSchemaBuilder) Field added in v3.0.24 

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

过滤字段的名字

示例值：domain

func (*FilterSchemaBuilder) FieldType added in v3.0.27 

func (builder *FilterSchemaBuilder) FieldType(fieldType string) *FilterSchemaBuilder

用于构建dsl过滤的类型，默认是enum

示例值：enum

func (*FilterSchemaBuilder) Type added in v3.0.24 

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

过滤字段的类型

示例值：list<string>

type GetDataSourceItemReq 

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

type GetDataSourceItemReqBuilder 

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

func NewGetDataSourceItemReqBuilder 

func NewGetDataSourceItemReqBuilder() *GetDataSourceItemReqBuilder

func (*GetDataSourceItemReqBuilder) Build 

func (builder *GetDataSourceItemReqBuilder) Build() *GetDataSourceItemReq

func (*GetDataSourceItemReqBuilder) DataSourceId 

func (builder *GetDataSourceItemReqBuilder) DataSourceId(dataSourceId string) *GetDataSourceItemReqBuilder

数据源的id

示例值：service_ticket

func (*GetDataSourceItemReqBuilder) ItemId 

func (builder *GetDataSourceItemReqBuilder) ItemId(itemId string) *GetDataSourceItemReqBuilder

数据记录的唯一标识

示例值：01010111

type GetDataSourceItemResp 

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

func (*GetDataSourceItemResp) Success 

func (resp *GetDataSourceItemResp) Success() bool

type GetDataSourceItemRespData 

type GetDataSourceItemRespData struct {
	Item *Item `json:"item,omitempty"` // 数据项实例
}

type GetDataSourceReq 

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

type GetDataSourceReqBuilder 

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

func NewGetDataSourceReqBuilder 

func NewGetDataSourceReqBuilder() *GetDataSourceReqBuilder

func (*GetDataSourceReqBuilder) Build 

func (builder *GetDataSourceReqBuilder) Build() *GetDataSourceReq

func (*GetDataSourceReqBuilder) DataSourceId 

func (builder *GetDataSourceReqBuilder) DataSourceId(dataSourceId string) *GetDataSourceReqBuilder

数据源的唯一标识

示例值：service_ticket

type GetDataSourceResp 

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

func (*GetDataSourceResp) Success 

func (resp *GetDataSourceResp) Success() bool

type GetDataSourceRespData 

type GetDataSourceRespData struct {
	DataSource *DataSource `json:"data_source,omitempty"` // 数据源实例
}

type GetSchemaReq 

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

type GetSchemaReqBuilder 

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

func NewGetSchemaReqBuilder 

func NewGetSchemaReqBuilder() *GetSchemaReqBuilder

func (*GetSchemaReqBuilder) Build 

func (builder *GetSchemaReqBuilder) Build() *GetSchemaReq

func (*GetSchemaReqBuilder) SchemaId 

func (builder *GetSchemaReqBuilder) SchemaId(schemaId string) *GetSchemaReqBuilder

用户自定义数据范式的唯一标识

示例值：custom_schema_id

type GetSchemaResp 

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

func (*GetSchemaResp) Success 

func (resp *GetSchemaResp) Success() bool

type GetSchemaRespData 

type GetSchemaRespData struct {
	Schema *Schema `json:"schema,omitempty"` // 数据范式
}

type HelpdeskPassageParam added in v3.0.24 

type HelpdeskPassageParam struct {
	Searchable  *bool    `json:"searchable,omitempty"`   // 是否要搜索服务台
	HelpdeskIds []string `json:"helpdesk_ids,omitempty"` // 搜索特定的服务台
}

type HelpdeskPassageParamBuilder added in v3.0.24 

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

func NewHelpdeskPassageParamBuilder added in v3.0.24 

func NewHelpdeskPassageParamBuilder() *HelpdeskPassageParamBuilder

func (*HelpdeskPassageParamBuilder) Build added in v3.0.24 

func (builder *HelpdeskPassageParamBuilder) Build() *HelpdeskPassageParam

func (*HelpdeskPassageParamBuilder) HelpdeskIds added in v3.0.24 

func (builder *HelpdeskPassageParamBuilder) HelpdeskIds(helpdeskIds []string) *HelpdeskPassageParamBuilder

搜索特定的服务台

示例值：

func (*HelpdeskPassageParamBuilder) Searchable added in v3.0.24 

func (builder *HelpdeskPassageParamBuilder) Searchable(searchable bool) *HelpdeskPassageParamBuilder

是否要搜索服务台

示例值：false

type I18nMeta 

type I18nMeta struct {
	ZhCn *string `json:"zh_cn,omitempty"` // 国际化字段：中文
	EnUs *string `json:"en_us,omitempty"` // 国际化字段：英文
	JaJp *string `json:"ja_jp,omitempty"` // 国际化字段：日文
}

type I18nMetaBuilder 

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

func NewI18nMetaBuilder 

func NewI18nMetaBuilder() *I18nMetaBuilder

func (*I18nMetaBuilder) Build 

func (builder *I18nMetaBuilder) Build() *I18nMeta

func (*I18nMetaBuilder) EnUs 

func (builder *I18nMetaBuilder) EnUs(enUs string) *I18nMetaBuilder

国际化字段：英文

示例值：TODO

func (*I18nMetaBuilder) JaJp 

func (builder *I18nMetaBuilder) JaJp(jaJp string) *I18nMetaBuilder

国际化字段：日文

示例值：タスク

func (*I18nMetaBuilder) ZhCn 

func (builder *I18nMetaBuilder) ZhCn(zhCn string) *I18nMetaBuilder

国际化字段：中文

示例值：任务

type Item 

type Item struct {
	Id             *string       `json:"id,omitempty"`              // item 在 datasource 中的唯一标识
	Acl            []*Acl        `json:"acl,omitempty"`             // item 的访问权限控制。 acl 字段为空数组，则默认数据不可见。如果数据是全员可见，需要设置 access="allow"; type="user"; value="everyone"
	Metadata       *ItemMetadata `json:"metadata,omitempty"`        // item 的元信息
	StructuredData *string       `json:"structured_data,omitempty"` // 结构化数据（以 json 字符串传递），这些字段是搜索结果的展示字段(特殊字段无须在此另外指定);具体格式可参参考 [通用模块接入指南](/uAjLw4CM/ukTMukTMukTM/search-v2/common-template-intergration-handbook) **请求创建数据项**部分
	Content        *ItemContent  `json:"content,omitempty"`         // 非结构化数据，如文档文本，飞书搜索会用来做召回
}

type ItemBuilder 

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

func NewItemBuilder 

func NewItemBuilder() *ItemBuilder

func (*ItemBuilder) Acl 

func (builder *ItemBuilder) Acl(acl []*Acl) *ItemBuilder

item 的访问权限控制。 acl 字段为空数组，则默认数据不可见。如果数据是全员可见，需要设置 access="allow"; type="user"; value="everyone"

示例值：

func (*ItemBuilder) Build 

func (builder *ItemBuilder) Build() *Item

func (*ItemBuilder) Content 

func (builder *ItemBuilder) Content(content *ItemContent) *ItemBuilder

非结构化数据，如文档文本，飞书搜索会用来做召回

示例值：

func (*ItemBuilder) Id 

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

item 在 datasource 中的唯一标识

示例值：01010111

func (*ItemBuilder) Metadata 

func (builder *ItemBuilder) Metadata(metadata *ItemMetadata) *ItemBuilder

item 的元信息

示例值：

func (*ItemBuilder) StructuredData 

func (builder *ItemBuilder) StructuredData(structuredData string) *ItemBuilder

结构化数据（以 json 字符串传递），这些字段是搜索结果的展示字段(特殊字段无须在此另外指定);具体格式可参参考 [通用模块接入指南](/uAjLw4CM/ukTMukTMukTM/search-v2/common-template-intergration-handbook) **请求创建数据项**部分

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

type ItemContent 

type ItemContent struct {
	Format      *string `json:"format,omitempty"`       // 内容的格式
	ContentData *string `json:"content_data,omitempty"` // 全文数据
}

type ItemContentBuilder 

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

func NewItemContentBuilder 

func NewItemContentBuilder() *ItemContentBuilder

func (*ItemContentBuilder) Build 

func (builder *ItemContentBuilder) Build() *ItemContent

func (*ItemContentBuilder) ContentData 

func (builder *ItemContentBuilder) ContentData(contentData string) *ItemContentBuilder

全文数据

示例值：这是一个很长的文本

func (*ItemContentBuilder) Format 

func (builder *ItemContentBuilder) Format(format string) *ItemContentBuilder

内容的格式

示例值：html

type ItemMetadata 

type ItemMetadata struct {
	Title           *string `json:"title,omitempty"`             // 该条数据记录对应的标题
	SourceUrl       *string `json:"source_url,omitempty"`        // 该条数据记录对应的跳转url
	CreateTime      *int    `json:"create_time,omitempty"`       // 数据项的创建时间。Unix 时间，单位为秒
	UpdateTime      *int    `json:"update_time,omitempty"`       // 数据项的更新时间。Unix 时间，单位为秒
	SourceUrlMobile *string `json:"source_url_mobile,omitempty"` // 移动端搜索命中的跳转地址。如果您PC端和移动端有不同的跳转地址，可以在这里写入移动端专用的url，我们会在搜索时为您选择合适的地址
}

type ItemMetadataBuilder 

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

func NewItemMetadataBuilder 

func NewItemMetadataBuilder() *ItemMetadataBuilder

func (*ItemMetadataBuilder) Build 

func (builder *ItemMetadataBuilder) Build() *ItemMetadata

func (*ItemMetadataBuilder) CreateTime 

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

数据项的创建时间。Unix 时间，单位为秒

示例值：1618831236

func (*ItemMetadataBuilder) SourceUrl 

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

该条数据记录对应的跳转url

示例值：http://www.abc.com.cn

func (*ItemMetadataBuilder) SourceUrlMobile 

func (builder *ItemMetadataBuilder) SourceUrlMobile(sourceUrlMobile string) *ItemMetadataBuilder

移动端搜索命中的跳转地址。如果您PC端和移动端有不同的跳转地址，可以在这里写入移动端专用的url，我们会在搜索时为您选择合适的地址

示例值：https://www.feishu.cn

func (*ItemMetadataBuilder) Title 

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

该条数据记录对应的标题

示例值：工单：无法创建文章

func (*ItemMetadataBuilder) UpdateTime 

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

数据项的更新时间。Unix 时间，单位为秒

示例值：1618831236

type ItemRecord 

type ItemRecord struct {
	ItemId       *string `json:"item_id,omitempty"`        // 冗余当前item的ID
	DataSourceId *string `json:"data_source_id,omitempty"` // 数据源id
	Version      *string `json:"version,omitempty"`        // 当前数据的最新版本号，其值等于上一次item/create接口传入的时间戳
	CreatedAt    *string `json:"created_at,omitempty"`     // 第一次投递时间
	UpdatedAt    *string `json:"updated_at,omitempty"`     // 上一次更新落库时间
}

type ItemRecordBuilder 

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

func NewItemRecordBuilder 

func NewItemRecordBuilder() *ItemRecordBuilder

func (*ItemRecordBuilder) Build 

func (builder *ItemRecordBuilder) Build() *ItemRecord

func (*ItemRecordBuilder) CreatedAt 

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

第一次投递时间

示例值：

func (*ItemRecordBuilder) DataSourceId 

func (builder *ItemRecordBuilder) DataSourceId(dataSourceId string) *ItemRecordBuilder

数据源id

示例值：

func (*ItemRecordBuilder) ItemId 

func (builder *ItemRecordBuilder) ItemId(itemId string) *ItemRecordBuilder

冗余当前item的ID

示例值：

func (*ItemRecordBuilder) UpdatedAt 

func (builder *ItemRecordBuilder) UpdatedAt(updatedAt string) *ItemRecordBuilder

上一次更新落库时间

示例值：

func (*ItemRecordBuilder) Version 

func (builder *ItemRecordBuilder) Version(version string) *ItemRecordBuilder

当前数据的最新版本号，其值等于上一次item/create接口传入的时间戳

示例值：

type ListDataSourceIterator 

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

func (*ListDataSourceIterator) Next 

func (iterator *ListDataSourceIterator) Next() (bool, *DataSource, error)

func (*ListDataSourceIterator) NextPageToken 

func (iterator *ListDataSourceIterator) NextPageToken() *string

type ListDataSourceReq 

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

type ListDataSourceReqBuilder 

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

func NewListDataSourceReqBuilder 

func NewListDataSourceReqBuilder() *ListDataSourceReqBuilder

func (*ListDataSourceReqBuilder) Build 

func (builder *ListDataSourceReqBuilder) Build() *ListDataSourceReq

func (*ListDataSourceReqBuilder) Limit 

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

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

func (*ListDataSourceReqBuilder) PageSize 

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

分页大小

示例值：10

func (*ListDataSourceReqBuilder) PageToken 

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

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值：PxZFma9OIRhdBlT/dOYNiu2Ro8F2WAhcby7OhOijfljZ

func (*ListDataSourceReqBuilder) View 

func (builder *ListDataSourceReqBuilder) View(view int) *ListDataSourceReqBuilder

回包数据格式，0-全量数据；1-摘要数据。;;**注**：摘要数据仅包含"id"，"name"，"state"。

示例值：0

type ListDataSourceResp 

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

func (*ListDataSourceResp) Success 

func (resp *ListDataSourceResp) Success() bool

type ListDataSourceRespData 

type ListDataSourceRespData struct {
	HasMore   *bool         `json:"has_more,omitempty"`   // 是否有更多数据
	PageToken *string       `json:"page_token,omitempty"` // 取数据的凭证
	Items     []*DataSource `json:"items,omitempty"`      // 数据源中的数据记录
}

type LlmModelConfig added in v3.0.24 

type LlmModelConfig struct {
	ModelName   *string  `json:"model_name,omitempty"`  // 模型名称
	Prompt      *string  `json:"prompt,omitempty"`      // 自定义的问答prompt，占位符格式和go标准库-text/template保持一致
	MaxToken    *int     `json:"max_token,omitempty"`   // 模型接收的最大token数
	Temperature *float64 `json:"temperature,omitempty"` // 模型生成的温度系数
}

type LlmModelConfigBuilder added in v3.0.24 

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

func NewLlmModelConfigBuilder added in v3.0.24 

func NewLlmModelConfigBuilder() *LlmModelConfigBuilder

func (*LlmModelConfigBuilder) Build added in v3.0.24 

func (builder *LlmModelConfigBuilder) Build() *LlmModelConfig

func (*LlmModelConfigBuilder) MaxToken added in v3.0.24 

func (builder *LlmModelConfigBuilder) MaxToken(maxToken int) *LlmModelConfigBuilder

模型接收的最大token数

示例值：4096

func (*LlmModelConfigBuilder) ModelName added in v3.0.24 

func (builder *LlmModelConfigBuilder) ModelName(modelName string) *LlmModelConfigBuilder

模型名称

示例值：gpt-3.5-turbo

func (*LlmModelConfigBuilder) Prompt added in v3.0.24 

func (builder *LlmModelConfigBuilder) Prompt(prompt string) *LlmModelConfigBuilder

自定义的问答prompt，占位符格式和go标准库-text/template保持一致

示例值：请根据以下文档回答问题，请仅依靠提供的文档段落回答问题。\n{{ range $index, $p := .Passages }}\n段落{{ $index }}：\n{{ $p }}\n{{ end }}\n请回答：\n{{ .Query }}

func (*LlmModelConfigBuilder) Temperature added in v3.0.24 

func (builder *LlmModelConfigBuilder) Temperature(temperature float64) *LlmModelConfigBuilder

模型生成的温度系数

示例值：0.3

type MemoryMessage added in v3.1.3 

type MemoryMessage struct {
	Role    *string `json:"role,omitempty"`    // 发送消息的角色
	Content *string `json:"content,omitempty"` // 消息内容
}

type MemoryMessageBuilder added in v3.1.3 

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

func NewMemoryMessageBuilder added in v3.1.3 

func NewMemoryMessageBuilder() *MemoryMessageBuilder

func (*MemoryMessageBuilder) Build added in v3.1.3 

func (builder *MemoryMessageBuilder) Build() *MemoryMessage

func (*MemoryMessageBuilder) Content added in v3.1.3 

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

消息内容

示例值：番茄炒蛋怎么做？

func (*MemoryMessageBuilder) Role added in v3.1.3 

func (builder *MemoryMessageBuilder) Role(role string) *MemoryMessageBuilder

发送消息的角色

示例值：human

type ModelConfig added in v3.0.24 

type ModelConfig struct {
	ModelName *string `json:"model_name,omitempty"` // 模型名称
}

type ModelConfigBuilder added in v3.0.24 

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

func NewModelConfigBuilder added in v3.0.24 

func NewModelConfigBuilder() *ModelConfigBuilder

func (*ModelConfigBuilder) Build added in v3.0.24 

func (builder *ModelConfigBuilder) Build() *ModelConfig

func (*ModelConfigBuilder) ModelName added in v3.0.24 

func (builder *ModelConfigBuilder) ModelName(modelName string) *ModelConfigBuilder

模型名称

示例值：mrc-passage-encoder

type ModelParam added in v3.0.31 

type ModelParam struct {
	EncoderName     *string `json:"encoder_name,omitempty"`     // embedding模型名字
	RankerName      *string `json:"ranker_name,omitempty"`      // 排序模型名字
	FilterName      *string `json:"filter_name,omitempty"`      // 过滤模型名字
	BoosterName     *string `json:"booster_name,omitempty"`     // 时效权威互动模型名字
	PassageLanguage *string `json:"passage_language,omitempty"` // 选择返回的语种，可选{zh,en,ja,auto,all}，auto自动检测query的语种并过滤，all保留所有语种不做过滤，默认auto
}

type ModelParamBuilder added in v3.0.31 

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

func NewModelParamBuilder added in v3.0.31 

func NewModelParamBuilder() *ModelParamBuilder

func (*ModelParamBuilder) BoosterName added in v3.0.31 

func (builder *ModelParamBuilder) BoosterName(boosterName string) *ModelParamBuilder

时效权威互动模型名字

示例值：lark-booster

func (*ModelParamBuilder) Build added in v3.0.31 

func (builder *ModelParamBuilder) Build() *ModelParam

func (*ModelParamBuilder) EncoderName added in v3.0.31 

func (builder *ModelParamBuilder) EncoderName(encoderName string) *ModelParamBuilder

embedding模型名字

示例值：lark-encoder

func (*ModelParamBuilder) FilterName added in v3.0.31 

func (builder *ModelParamBuilder) FilterName(filterName string) *ModelParamBuilder

过滤模型名字

示例值：lark-filter

func (*ModelParamBuilder) PassageLanguage added in v3.0.31 

func (builder *ModelParamBuilder) PassageLanguage(passageLanguage string) *ModelParamBuilder

选择返回的语种，可选{zh,en,ja,auto,all}，auto自动检测query的语种并过滤，all保留所有语种不做过滤，默认auto

示例值：zh

func (*ModelParamBuilder) RankerName added in v3.0.31 

func (builder *ModelParamBuilder) RankerName(rankerName string) *ModelParamBuilder

排序模型名字

示例值：lark-ranker

type NlsModelConfig added in v3.0.25 

type NlsModelConfig struct {
	ModelName *string `json:"model_name,omitempty"` // 模型名称
}

type NlsModelConfigBuilder added in v3.0.25 

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

func NewNlsModelConfigBuilder added in v3.0.25 

func NewNlsModelConfigBuilder() *NlsModelConfigBuilder

func (*NlsModelConfigBuilder) Build added in v3.0.25 

func (builder *NlsModelConfigBuilder) Build() *NlsModelConfig

func (*NlsModelConfigBuilder) ModelName added in v3.0.25 

func (builder *NlsModelConfigBuilder) ModelName(modelName string) *NlsModelConfigBuilder

模型名称

示例值：lark-online

type ParaphraseResult added in v3.0.31 

type ParaphraseResult struct {
	Text  *string `json:"text,omitempty"`  // 改写后的结果
	Extra *string `json:"extra,omitempty"` // 补充字段（json序列化）
}

type ParaphraseResultBuilder added in v3.0.31 

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

func NewParaphraseResultBuilder added in v3.0.31 

func NewParaphraseResultBuilder() *ParaphraseResultBuilder

func (*ParaphraseResultBuilder) Build added in v3.0.31 

func (builder *ParaphraseResultBuilder) Build() *ParaphraseResult

func (*ParaphraseResultBuilder) Extra added in v3.0.31 

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

补充字段（json序列化）

示例值：{"language": "en", "score": 0.85}

func (*ParaphraseResultBuilder) Text added in v3.0.31 

func (builder *ParaphraseResultBuilder) Text(text string) *ParaphraseResultBuilder

改写后的结果

示例值：改写后的结果

type Passage added in v3.0.24 

type Passage struct {
	PassageId     *string  `json:"passage_id,omitempty"`     // passage的唯一标识
	PassageSource *int     `json:"passage_source,omitempty"` // passage所属的数据源
	Content       *string  `json:"content,omitempty"`        // 和query相关的文本段落
	Title         *string  `json:"title,omitempty"`          // wiki或doc的题目
	Url           *string  `json:"url,omitempty"`            // 跳转链接
	Score         *float64 `json:"score,omitempty"`          // 文本段落和query的相关性分数
	Extra         *string  `json:"extra,omitempty"`          // 其他source相关的字段
}

type PassageBuilder added in v3.0.24 

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

func NewPassageBuilder added in v3.0.24 

func NewPassageBuilder() *PassageBuilder

func (*PassageBuilder) Build added in v3.0.24 

func (builder *PassageBuilder) Build() *Passage

func (*PassageBuilder) Content added in v3.0.24 

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

和query相关的文本段落

示例值：流程如下：xxxxxxx。可以在飞书官方官网上找到更详细内容。

func (*PassageBuilder) Extra added in v3.0.27 

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

其他source相关的字段

示例值：{\"obj_id\":7263345601809530881}

func (*PassageBuilder) PassageId added in v3.0.24 

func (builder *PassageBuilder) PassageId(passageId string) *PassageBuilder

passage的唯一标识

示例值：7045980712687697921

func (*PassageBuilder) PassageSource added in v3.0.24 

func (builder *PassageBuilder) PassageSource(passageSource int) *PassageBuilder

passage所属的数据源

示例值：1

func (*PassageBuilder) Score added in v3.0.24 

func (builder *PassageBuilder) Score(score float64) *PassageBuilder

文本段落和query的相关性分数

示例值：0.94

func (*PassageBuilder) Title added in v3.0.24 

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

wiki或doc的题目

示例值：文档的题目

func (*PassageBuilder) Url added in v3.0.24 

func (builder *PassageBuilder) Url(url string) *PassageBuilder

跳转链接

示例值：https://www.feishu.cn/hc/zh-CN/

type PassageParam added in v3.0.24 

type PassageParam struct {
	DocParam      *DocPassageParam      `json:"doc_param,omitempty"`      // 搜doc的相关参数
	WikiParam     *WikiPassageParam     `json:"wiki_param,omitempty"`     // 搜wiki的相关参数
	WebParam      *WebPassageParam      `json:"web_param,omitempty"`      // 搜web的相关参数
	HelpdeskParam *HelpdeskPassageParam `json:"helpdesk_param,omitempty"` // 搜helpdesk的相关参数
}

type PassageParamBuilder added in v3.0.24 

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

func NewPassageParamBuilder added in v3.0.24 

func NewPassageParamBuilder() *PassageParamBuilder

func (*PassageParamBuilder) Build added in v3.0.24 

func (builder *PassageParamBuilder) Build() *PassageParam

func (*PassageParamBuilder) DocParam added in v3.0.24 

func (builder *PassageParamBuilder) DocParam(docParam *DocPassageParam) *PassageParamBuilder

搜doc的相关参数

示例值：

func (*PassageParamBuilder) HelpdeskParam added in v3.0.24 

func (builder *PassageParamBuilder) HelpdeskParam(helpdeskParam *HelpdeskPassageParam) *PassageParamBuilder

搜helpdesk的相关参数

示例值：

func (*PassageParamBuilder) WebParam added in v3.0.24 

func (builder *PassageParamBuilder) WebParam(webParam *WebPassageParam) *PassageParamBuilder

搜web的相关参数

示例值：

func (*PassageParamBuilder) WikiParam added in v3.0.24 

func (builder *PassageParamBuilder) WikiParam(wikiParam *WikiPassageParam) *PassageParamBuilder

搜wiki的相关参数

示例值：

type PatchDataSourcePathReqBodyBuilder 

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

func NewPatchDataSourcePathReqBodyBuilder 

func NewPatchDataSourcePathReqBodyBuilder() *PatchDataSourcePathReqBodyBuilder

func (*PatchDataSourcePathReqBodyBuilder) Build 

func (builder *PatchDataSourcePathReqBodyBuilder) Build() (*PatchDataSourceReqBody, error)

func (*PatchDataSourcePathReqBodyBuilder) ConnectorParam added in v3.0.30 

func (builder *PatchDataSourcePathReqBodyBuilder) ConnectorParam(connectorParam *ConnectorParam) *PatchDataSourcePathReqBodyBuilder

修改connector的相关配置

示例值：

func (*PatchDataSourcePathReqBodyBuilder) Description 

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

对于数据源的描述

示例值：搜索客服工单

func (*PatchDataSourcePathReqBodyBuilder) EnableAnswer added in v3.0.31 

func (builder *PatchDataSourcePathReqBodyBuilder) EnableAnswer(enableAnswer bool) *PatchDataSourcePathReqBodyBuilder

是否使用问答服务

示例值：false

func (*PatchDataSourcePathReqBodyBuilder) I18nDescription 

func (builder *PatchDataSourcePathReqBodyBuilder) I18nDescription(i18nDescription *I18nMeta) *PatchDataSourcePathReqBodyBuilder

数据源描述多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"搜索测试数据源相关数据", "en_us":"Search data from Test DataSource"}

示例值：

func (*PatchDataSourcePathReqBodyBuilder) I18nName 

func (builder *PatchDataSourcePathReqBodyBuilder) I18nName(i18nName *I18nMeta) *PatchDataSourcePathReqBodyBuilder

数据源名称多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"测试数据源", "en_us":"Test DataSource"}

示例值：

func (*PatchDataSourcePathReqBodyBuilder) IconUrl 

func (builder *PatchDataSourcePathReqBodyBuilder) IconUrl(iconUrl string) *PatchDataSourcePathReqBodyBuilder

数据源在 search tab 上的展示图标路径

示例值：https://www.xxx.com/open.jpg

func (*PatchDataSourcePathReqBodyBuilder) Name 

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

数据源的展示名称

示例值：客服工单

func (*PatchDataSourcePathReqBodyBuilder) State 

func (builder *PatchDataSourcePathReqBodyBuilder) State(state int) *PatchDataSourcePathReqBodyBuilder

数据源状态，0-已上线，1-未上线

示例值：0

type PatchDataSourceReq 

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

type PatchDataSourceReqBody 

type PatchDataSourceReqBody struct {
	Name            *string         `json:"name,omitempty"`             // 数据源的展示名称
	State           *int            `json:"state,omitempty"`            // 数据源状态，0-已上线，1-未上线
	Description     *string         `json:"description,omitempty"`      // 对于数据源的描述
	IconUrl         *string         `json:"icon_url,omitempty"`         // 数据源在 search tab 上的展示图标路径
	I18nName        *I18nMeta       `json:"i18n_name,omitempty"`        // 数据源名称多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"测试数据源", "en_us":"Test DataSource"}
	I18nDescription *I18nMeta       `json:"i18n_description,omitempty"` // 数据源描述多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"搜索测试数据源相关数据", "en_us":"Search data from Test DataSource"}
	ConnectorParam  *ConnectorParam `json:"connector_param,omitempty"`  // 修改connector的相关配置
	EnableAnswer    *bool           `json:"enable_answer,omitempty"`    // 是否使用问答服务
}

type PatchDataSourceReqBodyBuilder 

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

func NewPatchDataSourceReqBodyBuilder 

func NewPatchDataSourceReqBodyBuilder() *PatchDataSourceReqBodyBuilder

func (*PatchDataSourceReqBodyBuilder) Build 

func (builder *PatchDataSourceReqBodyBuilder) Build() *PatchDataSourceReqBody

func (*PatchDataSourceReqBodyBuilder) ConnectorParam added in v3.0.30 

func (builder *PatchDataSourceReqBodyBuilder) ConnectorParam(connectorParam *ConnectorParam) *PatchDataSourceReqBodyBuilder

修改connector的相关配置

示例值：

func (*PatchDataSourceReqBodyBuilder) Description 

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

对于数据源的描述

示例值：搜索客服工单

func (*PatchDataSourceReqBodyBuilder) EnableAnswer added in v3.0.31 

func (builder *PatchDataSourceReqBodyBuilder) EnableAnswer(enableAnswer bool) *PatchDataSourceReqBodyBuilder

是否使用问答服务

示例值：false

func (*PatchDataSourceReqBodyBuilder) I18nDescription 

func (builder *PatchDataSourceReqBodyBuilder) I18nDescription(i18nDescription *I18nMeta) *PatchDataSourceReqBodyBuilder

数据源描述多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"搜索测试数据源相关数据", "en_us":"Search data from Test DataSource"}

示例值：

func (*PatchDataSourceReqBodyBuilder) I18nName 

func (builder *PatchDataSourceReqBodyBuilder) I18nName(i18nName *I18nMeta) *PatchDataSourceReqBodyBuilder

数据源名称多语言配置，json格式，key为语言locale，value为对应文案，例如{"zh_cn":"测试数据源", "en_us":"Test DataSource"}

示例值：

func (*PatchDataSourceReqBodyBuilder) IconUrl 

func (builder *PatchDataSourceReqBodyBuilder) IconUrl(iconUrl string) *PatchDataSourceReqBodyBuilder

数据源在 search tab 上的展示图标路径

示例值：https://www.xxx.com/open.jpg

func (*PatchDataSourceReqBodyBuilder) Name 

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

数据源的展示名称

示例值：客服工单

func (*PatchDataSourceReqBodyBuilder) State 

func (builder *PatchDataSourceReqBodyBuilder) State(state int) *PatchDataSourceReqBodyBuilder

数据源状态，0-已上线，1-未上线

示例值：0

type PatchDataSourceReqBuilder 

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

func NewPatchDataSourceReqBuilder 

func NewPatchDataSourceReqBuilder() *PatchDataSourceReqBuilder

func (*PatchDataSourceReqBuilder) Body 

func (builder *PatchDataSourceReqBuilder) Body(body *PatchDataSourceReqBody) *PatchDataSourceReqBuilder

更新一个已经存在的数据源

func (*PatchDataSourceReqBuilder) Build 

func (builder *PatchDataSourceReqBuilder) Build() *PatchDataSourceReq

func (*PatchDataSourceReqBuilder) DataSourceId 

func (builder *PatchDataSourceReqBuilder) DataSourceId(dataSourceId string) *PatchDataSourceReqBuilder

数据源的唯一标识

示例值：service_ticket

type PatchDataSourceResp 

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

func (*PatchDataSourceResp) Success 

func (resp *PatchDataSourceResp) Success() bool

type PatchDataSourceRespData 

type PatchDataSourceRespData struct {
	DataSource *DataSource `json:"data_source,omitempty"` // 数据源
}

type PatchSchemaPathReqBodyBuilder 

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

func NewPatchSchemaPathReqBodyBuilder 

func NewPatchSchemaPathReqBodyBuilder() *PatchSchemaPathReqBodyBuilder

func (*PatchSchemaPathReqBodyBuilder) Build 

func (builder *PatchSchemaPathReqBodyBuilder) Build() (*PatchSchemaReqBody, error)

func (*PatchSchemaPathReqBodyBuilder) Display 

func (builder *PatchSchemaPathReqBodyBuilder) Display(display *SchemaDisplay) *PatchSchemaPathReqBodyBuilder

数据展示相关配置

示例值：

func (*PatchSchemaPathReqBodyBuilder) Properties added in v3.0.31 

func (builder *PatchSchemaPathReqBodyBuilder) Properties(properties []*PatchSchemaProperty) *PatchSchemaPathReqBodyBuilder

数据范式的属性定义

示例值：

type PatchSchemaProperty added in v3.0.31 

type PatchSchemaProperty struct {
	Name         *string                  `json:"name,omitempty"`          // 属性名
	Desc         *string                  `json:"desc,omitempty"`          // 属性描述
	AnswerOption *SchemaFieldAnswerOption `json:"answer_option,omitempty"` // 问答产品设置，仅在datasource中use_answer为true时生效
}

type PatchSchemaPropertyBuilder added in v3.0.31 

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

func NewPatchSchemaPropertyBuilder added in v3.0.31 

func NewPatchSchemaPropertyBuilder() *PatchSchemaPropertyBuilder

func (*PatchSchemaPropertyBuilder) AnswerOption added in v3.0.31 

func (builder *PatchSchemaPropertyBuilder) AnswerOption(answerOption *SchemaFieldAnswerOption) *PatchSchemaPropertyBuilder

问答产品设置，仅在datasource中use_answer为true时生效

示例值：

func (*PatchSchemaPropertyBuilder) Build added in v3.0.31 

func (builder *PatchSchemaPropertyBuilder) Build() *PatchSchemaProperty

func (*PatchSchemaPropertyBuilder) Desc added in v3.0.31 

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

属性描述

示例值：desc

func (*PatchSchemaPropertyBuilder) Name added in v3.0.31 

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

属性名

示例值：title

type PatchSchemaReq 

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

type PatchSchemaReqBody 

type PatchSchemaReqBody struct {
	Display    *SchemaDisplay         `json:"display,omitempty"`    // 数据展示相关配置
	Properties []*PatchSchemaProperty `json:"properties,omitempty"` // 数据范式的属性定义
}

type PatchSchemaReqBodyBuilder 

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

func NewPatchSchemaReqBodyBuilder 

func NewPatchSchemaReqBodyBuilder() *PatchSchemaReqBodyBuilder

func (*PatchSchemaReqBodyBuilder) Build 

func (builder *PatchSchemaReqBodyBuilder) Build() *PatchSchemaReqBody

func (*PatchSchemaReqBodyBuilder) Display 

func (builder *PatchSchemaReqBodyBuilder) Display(display *SchemaDisplay) *PatchSchemaReqBodyBuilder

数据展示相关配置

示例值：

func (*PatchSchemaReqBodyBuilder) Properties added in v3.0.31 

func (builder *PatchSchemaReqBodyBuilder) Properties(properties []*PatchSchemaProperty) *PatchSchemaReqBodyBuilder

数据范式的属性定义

示例值：

type PatchSchemaReqBuilder 

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

func NewPatchSchemaReqBuilder 

func NewPatchSchemaReqBuilder() *PatchSchemaReqBuilder

func (*PatchSchemaReqBuilder) Body 

func (builder *PatchSchemaReqBuilder) Body(body *PatchSchemaReqBody) *PatchSchemaReqBuilder

修改数据范式

func (*PatchSchemaReqBuilder) Build 

func (builder *PatchSchemaReqBuilder) Build() *PatchSchemaReq

func (*PatchSchemaReqBuilder) SchemaId 

func (builder *PatchSchemaReqBuilder) SchemaId(schemaId string) *PatchSchemaReqBuilder

用户自定义数据范式的唯一标识

示例值：custom_schema_id

type PatchSchemaResp 

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

func (*PatchSchemaResp) Success 

func (resp *PatchSchemaResp) Success() bool

type PatchSchemaRespData 

type PatchSchemaRespData struct {
	Schema *Schema `json:"schema,omitempty"` // 数据范式实例
}

type Present added in v3.1.3 

type Present struct {
	Type           *string                `json:"type,omitempty"`             // 透传数据类型
	Body           *string                `json:"body,omitempty"`             // 透传消息体
	OperationType  *string                `json:"operation_type,omitempty"`   // 在交互卡片的场景下，如果用户完成交互，根据交互行为 Tool 对该交互行为做出的响应
	Interactable   *bool                  `json:"interactable,omitempty"`     // 用来定义工具输出的卡片是否为交互卡片
	OperationUrl   *string                `json:"operation_url,omitempty"`    // 卡片后续链路交互的请求地址
	CallbackUrl    *string                `json:"callback_url,omitempty"`     // 透传数据上屏后，回调业务方的 url；支持 Open API 与 RPC 两种方式
	CallbackInfo   *string                `json:"callback_info,omitempty"`    // 透传数据上屏后，回调给业务方的数据，仅在 type = card 时会回调
	CardTemplateId *string                `json:"card_template_id,omitempty"` // 仅 type = template_card 时使用，代表模版卡片的模版信息
	CardVariables  *TemplateCardVariables `json:"card_variables,omitempty"`   // 仅 type = template_card 使用，对应到模版卡片中模版里的变量信息，类型应该是map<string, string>
}

type PresentBuilder added in v3.1.3 

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

func NewPresentBuilder added in v3.1.3 

func NewPresentBuilder() *PresentBuilder

func (*PresentBuilder) Body added in v3.1.3 

func (builder *PresentBuilder) Body(body string) *PresentBuilder

透传消息体

示例值：raw

func (*PresentBuilder) Build added in v3.1.3 

func (builder *PresentBuilder) Build() *Present

func (*PresentBuilder) CallbackInfo added in v3.1.3 

func (builder *PresentBuilder) CallbackInfo(callbackInfo string) *PresentBuilder

透传数据上屏后，回调给业务方的数据，仅在 type = card 时会回调

示例值：可以是纯文本:"callback raw data"；也可以是 json string:"{\"biz_id":\"search_context_id\"}"

func (*PresentBuilder) CallbackUrl added in v3.1.3 

func (builder *PresentBuilder) CallbackUrl(callbackUrl string) *PresentBuilder

透传数据上屏后，回调业务方的 url；支持 Open API 与 RPC 两种方式

示例值：Open API - https://open.feishu-boe.cn/open-apis/lark_ai/callback；RPC - sd://p.s.m

func (*PresentBuilder) CardTemplateId added in v3.1.3 

func (builder *PresentBuilder) CardTemplateId(cardTemplateId string) *PresentBuilder

仅 type = template_card 时使用，代表模版卡片的模版信息

示例值：default

func (*PresentBuilder) CardVariables added in v3.1.3 

func (builder *PresentBuilder) CardVariables(cardVariables *TemplateCardVariables) *PresentBuilder

仅 type = template_card 使用，对应到模版卡片中模版里的变量信息，类型应该是map<string, string>

示例值：

func (*PresentBuilder) Interactable added in v3.1.3 

func (builder *PresentBuilder) Interactable(interactable bool) *PresentBuilder

用来定义工具输出的卡片是否为交互卡片

示例值：true

func (*PresentBuilder) OperationType added in v3.1.3 

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

在交互卡片的场景下，如果用户完成交互，根据交互行为 Tool 对该交互行为做出的响应

示例值：UPDATE

func (*PresentBuilder) OperationUrl added in v3.1.3 

func (builder *PresentBuilder) OperationUrl(operationUrl string) *PresentBuilder

卡片后续链路交互的请求地址

示例值：https://open.feishu-boe.cn/open-apis/lark_ai/operation

func (*PresentBuilder) Type added in v3.1.3 

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

透传数据类型

示例值：card

type ScenarioContext added in v3.1.3 

type ScenarioContext struct {
	Extra              *ScenarioContextExtra `json:"extra,omitempty"`                // 拓展信息
	SystemInfo         *SystemInfo           `json:"system_info,omitempty"`          // AI Engine填充的系统信息
	Memory             []*MemoryMessage      `json:"memory,omitempty"`               // 会话的历史对话
	Scenario           *string               `json:"scenario,omitempty"`             // 会话所处的业务场景
	WorkMode           *int                  `json:"work_mode,omitempty"`            // 会话所处的业务模式
	ToolRawInstruction *string               `json:"tool_raw_instruction,omitempty"` // 用户原始的问题描述
}

type ScenarioContextBuilder added in v3.1.3 

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

func NewScenarioContextBuilder added in v3.1.3 

func NewScenarioContextBuilder() *ScenarioContextBuilder

func (*ScenarioContextBuilder) Build added in v3.1.3 

func (builder *ScenarioContextBuilder) Build() *ScenarioContext

func (*ScenarioContextBuilder) Extra added in v3.1.3 

func (builder *ScenarioContextBuilder) Extra(extra *ScenarioContextExtra) *ScenarioContextBuilder

拓展信息

示例值：v1

func (*ScenarioContextBuilder) Memory added in v3.1.3 

func (builder *ScenarioContextBuilder) Memory(memory []*MemoryMessage) *ScenarioContextBuilder

会话的历史对话

示例值：

func (*ScenarioContextBuilder) Scenario added in v3.1.3 

func (builder *ScenarioContextBuilder) Scenario(scenario string) *ScenarioContextBuilder

会话所处的业务场景

示例值：IM

func (*ScenarioContextBuilder) SystemInfo added in v3.1.3 

func (builder *ScenarioContextBuilder) SystemInfo(systemInfo *SystemInfo) *ScenarioContextBuilder

AI Engine填充的系统信息

示例值：aa

func (*ScenarioContextBuilder) ToolRawInstruction added in v3.1.3 

func (builder *ScenarioContextBuilder) ToolRawInstruction(toolRawInstruction string) *ScenarioContextBuilder

用户原始的问题描述

示例值：我想问xxx问题

func (*ScenarioContextBuilder) WorkMode added in v3.1.3 

func (builder *ScenarioContextBuilder) WorkMode(workMode int) *ScenarioContextBuilder

会话所处的业务模式

示例值：1

type ScenarioContextExtra added in v3.1.3 

type ScenarioContextExtra struct {
	GroundingId *string `json:"grounding_id,omitempty"` // Grounding ID
	ModelKey    *string `json:"model_key,omitempty"`    // 模型 key
}

type ScenarioContextExtraBuilder added in v3.1.3 

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

func NewScenarioContextExtraBuilder added in v3.1.3 

func NewScenarioContextExtraBuilder() *ScenarioContextExtraBuilder

func (*ScenarioContextExtraBuilder) Build added in v3.1.3 

func (builder *ScenarioContextExtraBuilder) Build() *ScenarioContextExtra

func (*ScenarioContextExtraBuilder) GroundingId added in v3.1.3 

func (builder *ScenarioContextExtraBuilder) GroundingId(groundingId string) *ScenarioContextExtraBuilder

Grounding ID

示例值：123

func (*ScenarioContextExtraBuilder) ModelKey added in v3.1.3 

func (builder *ScenarioContextExtraBuilder) ModelKey(modelKey string) *ScenarioContextExtraBuilder

模型 key

示例值：lark-online

type Schema 

type Schema struct {
	Properties []*SchemaProperty `json:"properties,omitempty"` // 数据范式的属性定义
	Display    *SchemaDisplay    `json:"display,omitempty"`    // 数据展示相关配置
	SchemaId   *string           `json:"schema_id,omitempty"`  // 用户自定义数据范式的唯一标识
}

type SchemaBuilder 

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

func NewSchemaBuilder 

func NewSchemaBuilder() *SchemaBuilder

func (*SchemaBuilder) Build 

func (builder *SchemaBuilder) Build() *Schema

func (*SchemaBuilder) Display 

func (builder *SchemaBuilder) Display(display *SchemaDisplay) *SchemaBuilder

数据展示相关配置

示例值：

func (*SchemaBuilder) Properties 

func (builder *SchemaBuilder) Properties(properties []*SchemaProperty) *SchemaBuilder

数据范式的属性定义

示例值：

func (*SchemaBuilder) SchemaId 

func (builder *SchemaBuilder) SchemaId(schemaId string) *SchemaBuilder

用户自定义数据范式的唯一标识

示例值：jira_schema

type SchemaDisplay 

type SchemaDisplay struct {
	CardKey       *string                      `json:"card_key,omitempty"`       // 搜索数据的展示卡片;;;卡片详细信息请参考 [通用模块接入指南](/uAjLw4CM/ukTMukTMukTM/search-v2/common-template-intergration-handbook)  "请求创建数据范式"部分
	FieldsMapping []*SchemaDisplayFieldMapping `json:"fields_mapping,omitempty"` // 数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段
}

type SchemaDisplayBuilder 

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

func NewSchemaDisplayBuilder 

func NewSchemaDisplayBuilder() *SchemaDisplayBuilder

func (*SchemaDisplayBuilder) Build 

func (builder *SchemaDisplayBuilder) Build() *SchemaDisplay

func (*SchemaDisplayBuilder) CardKey 

func (builder *SchemaDisplayBuilder) CardKey(cardKey string) *SchemaDisplayBuilder

搜索数据的展示卡片;;;卡片详细信息请参考 [通用模块接入指南](/uAjLw4CM/ukTMukTMukTM/search-v2/common-template-intergration-handbook) "请求创建数据范式"部分

示例值：search_common_card

func (*SchemaDisplayBuilder) FieldsMapping 

func (builder *SchemaDisplayBuilder) FieldsMapping(fieldsMapping []*SchemaDisplayFieldMapping) *SchemaDisplayBuilder

数据字段名称和展示字段名称的映射关系。如果没有设置，则只会展示 与展示字段名称同名的 数据字段

示例值：

type SchemaDisplayFieldMapping 

type SchemaDisplayFieldMapping struct {
	DisplayField *string `json:"display_field,omitempty"` // 展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复
	DataField    *string `json:"data_field,omitempty"`    // 数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述
}

type SchemaDisplayFieldMappingBuilder 

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

func NewSchemaDisplayFieldMappingBuilder 

func NewSchemaDisplayFieldMappingBuilder() *SchemaDisplayFieldMappingBuilder

func (*SchemaDisplayFieldMappingBuilder) Build 

func (builder *SchemaDisplayFieldMappingBuilder) Build() *SchemaDisplayFieldMapping

func (*SchemaDisplayFieldMappingBuilder) DataField 

func (builder *SchemaDisplayFieldMappingBuilder) DataField(dataField string) *SchemaDisplayFieldMappingBuilder

数据字段的名称。需要确保该字段对应在 schema 属性定义中的 is_returnable 为 true，否则无法展示。需要使用 ${xxx} 的规则来描述

示例值：${description}

func (*SchemaDisplayFieldMappingBuilder) DisplayField 

func (builder *SchemaDisplayFieldMappingBuilder) DisplayField(displayField string) *SchemaDisplayFieldMappingBuilder

展示字段名称，与 card_key 有关，每个模版能展示的字段不同。该字段不能重复

示例值：summary

type SchemaEnumOptions added in v3.0.13 

type SchemaEnumOptions struct {
	PossibleValues []string `json:"possible_values,omitempty"` // 用户自定filter 枚举值数组，最大长度为50
}

type SchemaEnumOptionsBuilder added in v3.0.13 

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

func NewSchemaEnumOptionsBuilder added in v3.0.13 

func NewSchemaEnumOptionsBuilder() *SchemaEnumOptionsBuilder

func (*SchemaEnumOptionsBuilder) Build added in v3.0.13 

func (builder *SchemaEnumOptionsBuilder) Build() *SchemaEnumOptions

func (*SchemaEnumOptionsBuilder) PossibleValues added in v3.0.13 

func (builder *SchemaEnumOptionsBuilder) PossibleValues(possibleValues []string) *SchemaEnumOptionsBuilder

用户自定filter 枚举值数组，最大长度为50

示例值：v1

type SchemaFieldAnswerOption added in v3.0.31 

type SchemaFieldAnswerOption struct {
	IsSearchable *bool `json:"is_searchable,omitempty"` // 是否用于搜索
	IsReturnable *bool `json:"is_returnable,omitempty"` // 是否用于返回
}

type SchemaFieldAnswerOptionBuilder added in v3.0.31 

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

func NewSchemaFieldAnswerOptionBuilder added in v3.0.31 

func NewSchemaFieldAnswerOptionBuilder() *SchemaFieldAnswerOptionBuilder

func (*SchemaFieldAnswerOptionBuilder) Build added in v3.0.31 

func (builder *SchemaFieldAnswerOptionBuilder) Build() *SchemaFieldAnswerOption

func (*SchemaFieldAnswerOptionBuilder) IsReturnable added in v3.0.31 

func (builder *SchemaFieldAnswerOptionBuilder) IsReturnable(isReturnable bool) *SchemaFieldAnswerOptionBuilder

是否用于返回

示例值：false

func (*SchemaFieldAnswerOptionBuilder) IsSearchable added in v3.0.31 

func (builder *SchemaFieldAnswerOptionBuilder) IsSearchable(isSearchable bool) *SchemaFieldAnswerOptionBuilder

是否用于搜索

示例值：false

type SchemaFilterOptions added in v3.0.27 

type SchemaFilterOptions struct {
	DisplayName           *string                      `json:"display_name,omitempty"`            // 筛选器展示名称
	I18nDisplayName       *I18nMeta                    `json:"i18n_display_name,omitempty"`       // 筛选器展示名称国际化字段
	OptionMode            *string                      `json:"option_mode,omitempty"`             // 指明该筛选器支持单选或多选，默认单选
	AssociatedSmartFilter *string                      `json:"associated_smart_filter,omitempty"` // 关联的综合筛选器。只有 filter_type 为"user"和"time"时可以关联。"user" -> "from"；"time" -> "date"。
	FilterType            *string                      `json:"filter_type,omitempty"`             // 筛选器类型
	PredefineEnumValues   []*SchemaPredefineEnumStruct `json:"predefine_enum_values,omitempty"`   // 预定义的展示枚举值。在 filter_type 为 "predefine_enum" 时必须填写
	EnableClientFilter    *bool                        `json:"enable_client_filter,omitempty"`    // 是否开启客户端筛选器
	ReferenceDatasourceId *string                      `json:"reference_datasource_id,omitempty"` // 可搜筛选器关联的数据源标识
}

type SchemaFilterOptionsBuilder added in v3.0.27 

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

func NewSchemaFilterOptionsBuilder added in v3.0.27 

func NewSchemaFilterOptionsBuilder() *SchemaFilterOptionsBuilder

func (*SchemaFilterOptionsBuilder) AssociatedSmartFilter added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) AssociatedSmartFilter(associatedSmartFilter string) *SchemaFilterOptionsBuilder

关联的综合筛选器。只有 filter_type 为"user"和"time"时可以关联。"user" -> "from"；"time" -> "date"。

示例值：From

func (*SchemaFilterOptionsBuilder) Build added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) Build() *SchemaFilterOptions

func (*SchemaFilterOptionsBuilder) DisplayName added in v3.0.27 

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

筛选器展示名称

示例值：创建人

func (*SchemaFilterOptionsBuilder) EnableClientFilter added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) EnableClientFilter(enableClientFilter bool) *SchemaFilterOptionsBuilder

是否开启客户端筛选器

示例值：true

func (*SchemaFilterOptionsBuilder) FilterType added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) FilterType(filterType string) *SchemaFilterOptionsBuilder

筛选器类型

示例值：user

func (*SchemaFilterOptionsBuilder) I18nDisplayName added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) I18nDisplayName(i18nDisplayName *I18nMeta) *SchemaFilterOptionsBuilder

筛选器展示名称国际化字段

示例值：

func (*SchemaFilterOptionsBuilder) OptionMode added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) OptionMode(optionMode string) *SchemaFilterOptionsBuilder

指明该筛选器支持单选或多选，默认单选

示例值：single

func (*SchemaFilterOptionsBuilder) PredefineEnumValues added in v3.0.27 

func (builder *SchemaFilterOptionsBuilder) PredefineEnumValues(predefineEnumValues []*SchemaPredefineEnumStruct) *SchemaFilterOptionsBuilder

预定义的展示枚举值。在 filter_type 为 "predefine_enum" 时必须填写

示例值：

func (*SchemaFilterOptionsBuilder) ReferenceDatasourceId added in v3.0.30 

func (builder *SchemaFilterOptionsBuilder) ReferenceDatasourceId(referenceDatasourceId string) *SchemaFilterOptionsBuilder

可搜筛选器关联的数据源标识

示例值：7264565154409461234

type SchemaPredefineEnumStruct added in v3.0.27 

type SchemaPredefineEnumStruct struct {
	Name *string `json:"name,omitempty"` // 枚举值的标识。在多枚举值定义中保持唯一
	Text *string `json:"text,omitempty"` // 枚举值展示文案
}

type SchemaPredefineEnumStructBuilder added in v3.0.27 

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

func NewSchemaPredefineEnumStructBuilder added in v3.0.27 

func NewSchemaPredefineEnumStructBuilder() *SchemaPredefineEnumStructBuilder

func (*SchemaPredefineEnumStructBuilder) Build added in v3.0.27 

func (builder *SchemaPredefineEnumStructBuilder) Build() *SchemaPredefineEnumStruct

func (*SchemaPredefineEnumStructBuilder) Name added in v3.0.27 

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

枚举值的标识。在多枚举值定义中保持唯一

示例值：p0

func (*SchemaPredefineEnumStructBuilder) Text added in v3.0.27 

func (builder *SchemaPredefineEnumStructBuilder) Text(text string) *SchemaPredefineEnumStructBuilder

枚举值展示文案

示例值：最高优先级

type SchemaProperty 

type SchemaProperty struct {
	Name            *string                  `json:"name,omitempty"`             // 属性名
	Type            *string                  `json:"type,omitempty"`             // 属性类型
	IsSearchable    *bool                    `json:"is_searchable,omitempty"`    // 该属性是否可用作搜索，默认为 false
	IsSortable      *bool                    `json:"is_sortable,omitempty"`      // 该属性是否可用作搜索结果排序，默认为 false。如果为 true，需要再配置 sortOptions
	IsReturnable    *bool                    `json:"is_returnable,omitempty"`    // 该属性是否可用作返回字段，为 false 时，该字段不会被召回和展示。默认为 false
	SortOptions     *SchemaSortOptions       `json:"sort_options,omitempty"`     // 属性排序的可选配置，当 is_sortable 为 true 时，该字段为必填字段
	TypeDefinitions *SchemaTypeDefinitions   `json:"type_definitions,omitempty"` // 相关类型数据的定义和约束
	SearchOptions   *SchemaSearchOptions     `json:"search_options,omitempty"`   // 属性搜索的可选配置，当 is_searchable 为 true 时，该字段为必填参数
	IsFilterable    *bool                    `json:"is_filterable,omitempty"`    // 该属性是否可用作返回字段，为 false 时，该字段不会被筛选。默认为 false
	FilterOptions   *SchemaFilterOptions     `json:"filter_options,omitempty"`   // 属性筛选的可选配置，当 is_searchable 为 true 时，该字段为必填参数
	AnswerOption    *SchemaFieldAnswerOption `json:"answer_option,omitempty"`    // 问答产品设置，仅在datasource中enable_answer为true时生效
	Desc            *string                  `json:"desc,omitempty"`             // 字段描述
}

type SchemaPropertyBuilder 

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

func NewSchemaPropertyBuilder 

func NewSchemaPropertyBuilder() *SchemaPropertyBuilder

func (*SchemaPropertyBuilder) AnswerOption added in v3.0.31 

func (builder *SchemaPropertyBuilder) AnswerOption(answerOption *SchemaFieldAnswerOption) *SchemaPropertyBuilder

问答产品设置，仅在datasource中enable_answer为true时生效

示例值：

func (*SchemaPropertyBuilder) Build 

func (builder *SchemaPropertyBuilder) Build() *SchemaProperty

func (*SchemaPropertyBuilder) Desc added in v3.0.31 

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

字段描述

示例值：desc

func (*SchemaPropertyBuilder) FilterOptions added in v3.0.27 

func (builder *SchemaPropertyBuilder) FilterOptions(filterOptions *SchemaFilterOptions) *SchemaPropertyBuilder

属性筛选的可选配置，当 is_searchable 为 true 时，该字段为必填参数

示例值：

func (*SchemaPropertyBuilder) IsFilterable added in v3.0.27 

func (builder *SchemaPropertyBuilder) IsFilterable(isFilterable bool) *SchemaPropertyBuilder

该属性是否可用作返回字段，为 false 时，该字段不会被筛选。默认为 false

示例值：false

func (*SchemaPropertyBuilder) IsReturnable 

func (builder *SchemaPropertyBuilder) IsReturnable(isReturnable bool) *SchemaPropertyBuilder

该属性是否可用作返回字段，为 false 时，该字段不会被召回和展示。默认为 false

示例值：true

func (*SchemaPropertyBuilder) IsSearchable 

func (builder *SchemaPropertyBuilder) IsSearchable(isSearchable bool) *SchemaPropertyBuilder

该属性是否可用作搜索，默认为 false

示例值：true

func (*SchemaPropertyBuilder) IsSortable 

func (builder *SchemaPropertyBuilder) IsSortable(isSortable bool) *SchemaPropertyBuilder

该属性是否可用作搜索结果排序，默认为 false。如果为 true，需要再配置 sortOptions

示例值：false

func (*SchemaPropertyBuilder) Name 

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

属性名

示例值：summary

func (*SchemaPropertyBuilder) SearchOptions 

func (builder *SchemaPropertyBuilder) SearchOptions(searchOptions *SchemaSearchOptions) *SchemaPropertyBuilder

属性搜索的可选配置，当 is_searchable 为 true 时，该字段为必填参数

示例值：

func (*SchemaPropertyBuilder) SortOptions 

func (builder *SchemaPropertyBuilder) SortOptions(sortOptions *SchemaSortOptions) *SchemaPropertyBuilder

属性排序的可选配置，当 is_sortable 为 true 时，该字段为必填字段

示例值：

func (*SchemaPropertyBuilder) Type 

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

属性类型

示例值：text

func (*SchemaPropertyBuilder) TypeDefinitions 

func (builder *SchemaPropertyBuilder) TypeDefinitions(typeDefinitions *SchemaTypeDefinitions) *SchemaPropertyBuilder

相关类型数据的定义和约束

示例值：

type SchemaSearchOptions 

type SchemaSearchOptions struct {
	EnableSemanticMatch     *bool `json:"enable_semantic_match,omitempty"`      // 是否支持语义切词召回。默认不支持（推荐使用在长文本的场景）
	EnableExactMatch        *bool `json:"enable_exact_match,omitempty"`         // 是否支持精确匹配。默认不支持（推荐使用在短文本、需要精确查找的场景）
	EnablePrefixMatch       *bool `json:"enable_prefix_match,omitempty"`        // 是否支持前缀匹配（短文本的默认的分词/召回策略。前缀长度为 1-12）
	EnableNumberSuffixMatch *bool `json:"enable_number_suffix_match,omitempty"` // 是否支持数据后缀匹配。默认不支持（推荐使用在短文本、有数字后缀查找的场景。后缀长度为3-12）
	EnableCamelMatch        *bool `json:"enable_camel_match,omitempty"`         // 是否支持驼峰英文匹配。默认不支持（推荐使用在短文本，且包含驼峰形式英文的查找场景）
}

type SchemaSearchOptionsBuilder 

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

func NewSchemaSearchOptionsBuilder 

func NewSchemaSearchOptionsBuilder() *SchemaSearchOptionsBuilder

func (*SchemaSearchOptionsBuilder) Build 

func (builder *SchemaSearchOptionsBuilder) Build() *SchemaSearchOptions

func (*SchemaSearchOptionsBuilder) EnableCamelMatch 

func (builder *SchemaSearchOptionsBuilder) EnableCamelMatch(enableCamelMatch bool) *SchemaSearchOptionsBuilder

是否支持驼峰英文匹配。默认不支持（推荐使用在短文本，且包含驼峰形式英文的查找场景）

示例值：false

func (*SchemaSearchOptionsBuilder) EnableExactMatch 

func (builder *SchemaSearchOptionsBuilder) EnableExactMatch(enableExactMatch bool) *SchemaSearchOptionsBuilder

是否支持精确匹配。默认不支持（推荐使用在短文本、需要精确查找的场景）

示例值：false

func (*SchemaSearchOptionsBuilder) EnableNumberSuffixMatch 

func (builder *SchemaSearchOptionsBuilder) EnableNumberSuffixMatch(enableNumberSuffixMatch bool) *SchemaSearchOptionsBuilder

是否支持数据后缀匹配。默认不支持（推荐使用在短文本、有数字后缀查找的场景。后缀长度为3-12）

示例值：false

func (*SchemaSearchOptionsBuilder) EnablePrefixMatch 

func (builder *SchemaSearchOptionsBuilder) EnablePrefixMatch(enablePrefixMatch bool) *SchemaSearchOptionsBuilder

是否支持前缀匹配（短文本的默认的分词/召回策略。前缀长度为 1-12）

示例值：false

func (*SchemaSearchOptionsBuilder) EnableSemanticMatch 

func (builder *SchemaSearchOptionsBuilder) EnableSemanticMatch(enableSemanticMatch bool) *SchemaSearchOptionsBuilder

是否支持语义切词召回。默认不支持（推荐使用在长文本的场景）

示例值：true

type SchemaSortOptions 

type SchemaSortOptions struct {
	Priority *int    `json:"priority,omitempty"` // 排序的优先级，可选范围为 0~4，0为最高优先级。如果优先级相同，则随机进行排序。默认为0
	Order    *string `json:"order,omitempty"`    // 排序的顺序。默认为 desc
}

type SchemaSortOptionsBuilder 

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

func NewSchemaSortOptionsBuilder 

func NewSchemaSortOptionsBuilder() *SchemaSortOptionsBuilder

func (*SchemaSortOptionsBuilder) Build 

func (builder *SchemaSortOptionsBuilder) Build() *SchemaSortOptions

func (*SchemaSortOptionsBuilder) Order 

func (builder *SchemaSortOptionsBuilder) Order(order string) *SchemaSortOptionsBuilder

排序的顺序。默认为 desc

示例值：asc

func (*SchemaSortOptionsBuilder) Priority 

func (builder *SchemaSortOptionsBuilder) Priority(priority int) *SchemaSortOptionsBuilder

排序的优先级，可选范围为 0~4，0为最高优先级。如果优先级相同，则随机进行排序。默认为0

示例值：0

type SchemaTagOptions 

type SchemaTagOptions struct {
	Name  *string `json:"name,omitempty"`  // tag 对应的枚举值名称
	Color *string `json:"color,omitempty"` // 标签对应的颜色
	Text  *string `json:"text,omitempty"`  // 标签中展示的文本
}

type SchemaTagOptionsBuilder 

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

func NewSchemaTagOptionsBuilder 

func NewSchemaTagOptionsBuilder() *SchemaTagOptionsBuilder

func (*SchemaTagOptionsBuilder) Build 

func (builder *SchemaTagOptionsBuilder) Build() *SchemaTagOptions

func (*SchemaTagOptionsBuilder) Color 

func (builder *SchemaTagOptionsBuilder) Color(color string) *SchemaTagOptionsBuilder

标签对应的颜色

示例值：blue

func (*SchemaTagOptionsBuilder) Name 

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

tag 对应的枚举值名称

示例值：status

func (*SchemaTagOptionsBuilder) Text 

func (builder *SchemaTagOptionsBuilder) Text(text string) *SchemaTagOptionsBuilder

标签中展示的文本

示例值：PASS

type SchemaTypeDefinitions 

type SchemaTypeDefinitions struct {
	Tag     []*SchemaTagOptions  `json:"tag,omitempty"`      // 标签类型的定义
	UserIds *SchemaUserIdsOption `json:"user_ids,omitempty"` // 用户身份标识
}

type SchemaTypeDefinitionsBuilder 

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

func NewSchemaTypeDefinitionsBuilder 

func NewSchemaTypeDefinitionsBuilder() *SchemaTypeDefinitionsBuilder

func (*SchemaTypeDefinitionsBuilder) Build 

func (builder *SchemaTypeDefinitionsBuilder) Build() *SchemaTypeDefinitions

func (*SchemaTypeDefinitionsBuilder) Tag 

func (builder *SchemaTypeDefinitionsBuilder) Tag(tag []*SchemaTagOptions) *SchemaTypeDefinitionsBuilder

标签类型的定义

示例值：

func (*SchemaTypeDefinitionsBuilder) UserIds added in v3.0.27 

func (builder *SchemaTypeDefinitionsBuilder) UserIds(userIds *SchemaUserIdsOption) *SchemaTypeDefinitionsBuilder

用户身份标识

示例值：

type SchemaUserIdsOption added in v3.0.27 

type SchemaUserIdsOption struct {
	IdType *string `json:"id_type,omitempty"` // 用户身份类型
}

type SchemaUserIdsOptionBuilder added in v3.0.27 

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

func NewSchemaUserIdsOptionBuilder added in v3.0.27 

func NewSchemaUserIdsOptionBuilder() *SchemaUserIdsOptionBuilder

func (*SchemaUserIdsOptionBuilder) Build added in v3.0.27 

func (builder *SchemaUserIdsOptionBuilder) Build() *SchemaUserIdsOption

func (*SchemaUserIdsOptionBuilder) IdType added in v3.0.27 

func (builder *SchemaUserIdsOptionBuilder) IdType(idType string) *SchemaUserIdsOptionBuilder

用户身份类型

示例值：user_id

type SeperatePassage added in v3.0.34 

type SeperatePassage struct {
	PassageId *string `json:"passage_id,omitempty"` // passage_id
	ObjId     *string `json:"obj_id,omitempty"`     // obj_id
	Content   *string `json:"content,omitempty"`    // 内容
	NumTokens *int    `json:"num_tokens,omitempty"` // passage的token数量
}

type SeperatePassageBuilder added in v3.0.34 

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

func NewSeperatePassageBuilder added in v3.0.34 

func NewSeperatePassageBuilder() *SeperatePassageBuilder

func (*SeperatePassageBuilder) Build added in v3.0.34 

func (builder *SeperatePassageBuilder) Build() *SeperatePassage

func (*SeperatePassageBuilder) Content added in v3.0.34 

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

内容

示例值：这是一段passage

func (*SeperatePassageBuilder) NumTokens added in v3.0.34 

func (builder *SeperatePassageBuilder) NumTokens(numTokens int) *SeperatePassageBuilder

passage的token数量

示例值：12

func (*SeperatePassageBuilder) ObjId added in v3.0.34 

func (builder *SeperatePassageBuilder) ObjId(objId string) *SeperatePassageBuilder

obj_id

示例值：6953165194634772508

func (*SeperatePassageBuilder) PassageId added in v3.0.34 

func (builder *SeperatePassageBuilder) PassageId(passageId string) *SeperatePassageBuilder

passage_id

示例值：6953165194634772508

type SystemInfo added in v3.1.3 

type SystemInfo struct {
	Time       *string `json:"time,omitempty"`        // 用户时间
	TimeZone   *string `json:"time_zone,omitempty"`   // 用户时区
	Lang       *string `json:"lang,omitempty"`        // 用户问题的语种
	Brand      *string `json:"brand,omitempty"`       // 客户端品牌
	Weekday    *string `json:"weekday,omitempty"`     // 星期信息
	SessionId  *string `json:"session_id,omitempty"`  // 一次话题的唯一标识
	ShadowName *string `json:"shadow_name,omitempty"` // 用户赋予飞飞的名字
	MsgId      *string `json:"msg_id,omitempty"`      // 消息 ID
	AgentId    *string `json:"agent_id,omitempty"`    // 场景 ID
}

type SystemInfoBuilder added in v3.1.3 

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

func NewSystemInfoBuilder added in v3.1.3 

func NewSystemInfoBuilder() *SystemInfoBuilder

func (*SystemInfoBuilder) AgentId added in v3.1.3 

func (builder *SystemInfoBuilder) AgentId(agentId string) *SystemInfoBuilder

场景 ID

示例值：7302361858671902739

func (*SystemInfoBuilder) Brand added in v3.1.3 

func (builder *SystemInfoBuilder) Brand(brand string) *SystemInfoBuilder

客户端品牌

示例值：feishu

func (*SystemInfoBuilder) Build added in v3.1.3 

func (builder *SystemInfoBuilder) Build() *SystemInfo

func (*SystemInfoBuilder) Lang added in v3.1.3 

func (builder *SystemInfoBuilder) Lang(lang string) *SystemInfoBuilder

用户问题的语种

示例值：en

func (*SystemInfoBuilder) MsgId added in v3.1.3 

func (builder *SystemInfoBuilder) MsgId(msgId string) *SystemInfoBuilder

消息 ID

示例值：om_0c1e199622cec22ffcc490392b12cdac

func (*SystemInfoBuilder) SessionId added in v3.1.3 

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

一次话题的唯一标识

示例值：123456

func (*SystemInfoBuilder) ShadowName added in v3.1.3 

func (builder *SystemInfoBuilder) ShadowName(shadowName string) *SystemInfoBuilder

用户赋予飞飞的名字

示例值：Bob

func (*SystemInfoBuilder) Time added in v3.1.3 

func (builder *SystemInfoBuilder) Time(time string) *SystemInfoBuilder

用户时间

示例值：2006-01-02 15:04:05

func (*SystemInfoBuilder) TimeZone added in v3.1.3 

func (builder *SystemInfoBuilder) TimeZone(timeZone string) *SystemInfoBuilder

用户时区

示例值：Asia/Shanghai

func (*SystemInfoBuilder) Weekday added in v3.1.3 

func (builder *SystemInfoBuilder) Weekday(weekday string) *SystemInfoBuilder

星期信息

示例值：Monday

type TemplateCardVariables added in v3.1.3 

type TemplateCardVariables struct {
}

type UserInfo added in v3.0.27 

type UserInfo struct {
	UserLanguage *string `json:"user_language,omitempty"` // 用户使用语言类型
	Timezone     *string `json:"timezone,omitempty"`      // 用户时区
	UserId       *string `json:"user_id,omitempty"`       // 用户id
	UserOpenId   *string `json:"user_open_id,omitempty"`  // 用户open id
	TenantId     *string `json:"tenant_id,omitempty"`     // 租户id
	Locale       *string `json:"locale,omitempty"`        // 地区
}

type UserInfoBuilder added in v3.0.27 

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

func NewUserInfoBuilder added in v3.0.27 

func NewUserInfoBuilder() *UserInfoBuilder

func (*UserInfoBuilder) Build added in v3.0.27 

func (builder *UserInfoBuilder) Build() *UserInfo

func (*UserInfoBuilder) Locale added in v3.0.32 

func (builder *UserInfoBuilder) Locale(locale string) *UserInfoBuilder

地区

示例值：zh-cn

func (*UserInfoBuilder) TenantId added in v3.0.32 

func (builder *UserInfoBuilder) TenantId(tenantId string) *UserInfoBuilder

租户id

示例值：22

func (*UserInfoBuilder) Timezone added in v3.0.31 

func (builder *UserInfoBuilder) Timezone(timezone string) *UserInfoBuilder

用户时区

示例值：zh

func (*UserInfoBuilder) UserId added in v3.0.32 

func (builder *UserInfoBuilder) UserId(userId string) *UserInfoBuilder

用户id

示例值：22

func (*UserInfoBuilder) UserLanguage added in v3.0.27 

func (builder *UserInfoBuilder) UserLanguage(userLanguage string) *UserInfoBuilder

用户使用语言类型

示例值：English

func (*UserInfoBuilder) UserOpenId added in v3.0.32 

func (builder *UserInfoBuilder) UserOpenId(userOpenId string) *UserInfoBuilder

用户open id

示例值：ou_abc

type V2 added in v3.1.0 

type V2 struct {
	App            *app            // app
	DataSource     *dataSource     // 数据源
	DataSourceItem *dataSourceItem // 数据项
	Message        *message        // message
	Schema         *schema         // 数据范式
}

func New added in v3.1.0 

func New(config *larkcore.Config) *V2

type WebPassageParam added in v3.0.24 

type WebPassageParam struct {
	Searchable *bool    `json:"searchable,omitempty"` // 是否要搜索网页
	Domains    []string `json:"domains,omitempty"`    // 搜索特定网页
}

type WebPassageParamBuilder added in v3.0.24 

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

func NewWebPassageParamBuilder added in v3.0.24 

func NewWebPassageParamBuilder() *WebPassageParamBuilder

func (*WebPassageParamBuilder) Build added in v3.0.24 

func (builder *WebPassageParamBuilder) Build() *WebPassageParam

func (*WebPassageParamBuilder) Domains added in v3.0.24 

func (builder *WebPassageParamBuilder) Domains(domains []string) *WebPassageParamBuilder

搜索特定网页

示例值：

func (*WebPassageParamBuilder) Searchable added in v3.0.24 

func (builder *WebPassageParamBuilder) Searchable(searchable bool) *WebPassageParamBuilder

是否要搜索网页

示例值：false

type WikiPassageParam added in v3.0.24 

type WikiPassageParam struct {
	Searchable        *bool    `json:"searchable,omitempty"`          // 是否要搜索wiki
	SpaceIds          []string `json:"space_ids,omitempty"`           // 搜索特定空间的wiki
	ObjIds            []string `json:"obj_ids,omitempty"`             // 在特定的wiki内搜索（仅限内部使用，有需求请用wiki_tokens）
	WikiTokens        []string `json:"wiki_tokens,omitempty"`         // 在特定的wiki内搜索
	NodeTokens        []string `json:"node_tokens,omitempty"`         // 在特定的wiki节点范围内搜索
	DisableSearchLink *bool    `json:"disable_search_link,omitempty"` // 禁用搜索外链文档功能
}

type WikiPassageParamBuilder added in v3.0.24 

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

func NewWikiPassageParamBuilder added in v3.0.24 

func NewWikiPassageParamBuilder() *WikiPassageParamBuilder

func (*WikiPassageParamBuilder) Build added in v3.0.24 

func (builder *WikiPassageParamBuilder) Build() *WikiPassageParam
func (builder *WikiPassageParamBuilder) DisableSearchLink(disableSearchLink bool) *WikiPassageParamBuilder

禁用搜索外链文档功能

示例值：false

func (*WikiPassageParamBuilder) NodeTokens added in v3.0.30 

func (builder *WikiPassageParamBuilder) NodeTokens(nodeTokens []string) *WikiPassageParamBuilder

在特定的wiki节点范围内搜索

示例值：

func (*WikiPassageParamBuilder) ObjIds added in v3.0.30 

func (builder *WikiPassageParamBuilder) ObjIds(objIds []string) *WikiPassageParamBuilder

在特定的wiki内搜索（仅限内部使用，有需求请用wiki_tokens）

示例值：

func (*WikiPassageParamBuilder) Searchable added in v3.0.24 

func (builder *WikiPassageParamBuilder) Searchable(searchable bool) *WikiPassageParamBuilder

是否要搜索wiki

示例值：false

func (*WikiPassageParamBuilder) SpaceIds added in v3.0.24 

func (builder *WikiPassageParamBuilder) SpaceIds(spaceIds []string) *WikiPassageParamBuilder

搜索特定空间的wiki

示例值：

func (*WikiPassageParamBuilder) WikiTokens added in v3.0.30 

func (builder *WikiPassageParamBuilder) WikiTokens(wikiTokens []string) *WikiPassageParamBuilder

在特定的wiki内搜索

示例值：

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.