v20191115

package
v1.0.935 Latest Latest
Warning

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

 Go to latest Published: Jun 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// 查询用户信息失败。
	FAILEDOPERATION_ACCOUNTINFO = "FailedOperation.AccountInfo"

	// 查询应用信息失败。
	FAILEDOPERATION_APPINFO = "FailedOperation.AppInfo"

	// 搜索接口异常。
	FAILEDOPERATION_SEARCH = "FailedOperation.Search"

	// 数据上传异常。
	FAILEDOPERATION_UPLOADDATAAPIFAIL = "FailedOperation.UploadDataApiFail"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 数据文件无效。
	INVALIDPARAMETER_DATACONTENT = "InvalidParameter.DataContent"

	// 请求的次数超过了频率限制。
	LIMITEXCEEDED_SEARCH = "LimitExceeded.Search"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
)
View Source 
const APIVersion = "2019-11-15"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) DataManipulation 

func (c *Client) DataManipulation(request *DataManipulationRequest) (response *DataManipulationResponse, err error)

DataManipulation 上传云搜数据的API接口。

可能返回的错误码: 

FAILEDOPERATION_ACCOUNTINFO = "FailedOperation.AccountInfo"
FAILEDOPERATION_APPINFO = "FailedOperation.AppInfo"
FAILEDOPERATION_SEARCH = "FailedOperation.Search"
FAILEDOPERATION_UPLOADDATAAPIFAIL = "FailedOperation.UploadDataApiFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATACONTENT = "InvalidParameter.DataContent"
LIMITEXCEEDED_SEARCH = "LimitExceeded.Search"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DataManipulationWithContext added in v1.0.324 

func (c *Client) DataManipulationWithContext(ctx context.Context, request *DataManipulationRequest) (response *DataManipulationResponse, err error)

DataManipulation 上传云搜数据的API接口。

可能返回的错误码: 

FAILEDOPERATION_ACCOUNTINFO = "FailedOperation.AccountInfo"
FAILEDOPERATION_APPINFO = "FailedOperation.AppInfo"
FAILEDOPERATION_SEARCH = "FailedOperation.Search"
FAILEDOPERATION_UPLOADDATAAPIFAIL = "FailedOperation.UploadDataApiFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATACONTENT = "InvalidParameter.DataContent"
LIMITEXCEEDED_SEARCH = "LimitExceeded.Search"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DataSearch 

func (c *Client) DataSearch(request *DataSearchRequest) (response *DataSearchResponse, err error)

DataSearch 用于检索云搜中的数据。

可能返回的错误码: 

FAILEDOPERATION_ACCOUNTINFO = "FailedOperation.AccountInfo"
FAILEDOPERATION_APPINFO = "FailedOperation.AppInfo"
FAILEDOPERATION_SEARCH = "FailedOperation.Search"
FAILEDOPERATION_UPLOADDATAAPIFAIL = "FailedOperation.UploadDataApiFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATACONTENT = "InvalidParameter.DataContent"
LIMITEXCEEDED_SEARCH = "LimitExceeded.Search"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DataSearchWithContext added in v1.0.324 

func (c *Client) DataSearchWithContext(ctx context.Context, request *DataSearchRequest) (response *DataSearchResponse, err error)

DataSearch 用于检索云搜中的数据。

可能返回的错误码: 

FAILEDOPERATION_ACCOUNTINFO = "FailedOperation.AccountInfo"
FAILEDOPERATION_APPINFO = "FailedOperation.AppInfo"
FAILEDOPERATION_SEARCH = "FailedOperation.Search"
FAILEDOPERATION_UPLOADDATAAPIFAIL = "FailedOperation.UploadDataApiFail"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DATACONTENT = "InvalidParameter.DataContent"
LIMITEXCEEDED_SEARCH = "LimitExceeded.Search"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

type DataManipulationRequest 

type DataManipulationRequest struct {
	*tchttp.BaseRequest

	// 操作类型，add或del
	OpType *string `json:"OpType,omitnil,omitempty" name:"OpType"`

	// 数据编码类型
	Encoding *string `json:"Encoding,omitnil,omitempty" name:"Encoding"`

	// 数据
	Contents *string `json:"Contents,omitnil,omitempty" name:"Contents"`

	// 应用Id
	ResourceId *uint64 `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

func NewDataManipulationRequest 

func NewDataManipulationRequest() (request *DataManipulationRequest)

func (*DataManipulationRequest) FromJsonString 

func (r *DataManipulationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DataManipulationRequest) ToJsonString 

func (r *DataManipulationRequest) ToJsonString() string

type DataManipulationRequestParams added in v1.0.426 

type DataManipulationRequestParams struct {
	// 操作类型，add或del
	OpType *string `json:"OpType,omitnil,omitempty" name:"OpType"`

	// 数据编码类型
	Encoding *string `json:"Encoding,omitnil,omitempty" name:"Encoding"`

	// 数据
	Contents *string `json:"Contents,omitnil,omitempty" name:"Contents"`

	// 应用Id
	ResourceId *uint64 `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

Predefined struct for user

type DataManipulationResponse 

type DataManipulationResponse struct {
	*tchttp.BaseResponse
	Response *DataManipulationResponseParams `json:"Response"`
}

func NewDataManipulationResponse 

func NewDataManipulationResponse() (response *DataManipulationResponse)

func (*DataManipulationResponse) FromJsonString 

func (r *DataManipulationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DataManipulationResponse) ToJsonString 

func (r *DataManipulationResponse) ToJsonString() string

type DataManipulationResponseParams added in v1.0.426 

type DataManipulationResponseParams struct {
	// 数据操作结果
	Data *DataManipulationResult `json:"Data,omitnil,omitempty" name:"Data"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DataManipulationResult 

type DataManipulationResult struct {
	// 应用ID
	AppId *uint64 `json:"AppId,omitnil,omitempty" name:"AppId"`

	// 序号
	Seq *int64 `json:"Seq,omitnil,omitempty" name:"Seq"`

	// 结果
	TotalResult *string `json:"TotalResult,omitnil,omitempty" name:"TotalResult"`

	// 操作结果明细
	// 注意：此字段可能返回 null，表示取不到有效值。
	Result []*DataManipulationResultItem `json:"Result,omitnil,omitempty" name:"Result"`

	// 异常信息
	// 注意：此字段可能返回 null，表示取不到有效值。
	ErrorResult *string `json:"ErrorResult,omitnil,omitempty" name:"ErrorResult"`
}

type DataManipulationResultItem 

type DataManipulationResultItem struct {
	// 结果
	Result *string `json:"Result,omitnil,omitempty" name:"Result"`

	// 文档ID
	DocId *string `json:"DocId,omitnil,omitempty" name:"DocId"`

	// 错误码
	Errno *int64 `json:"Errno,omitnil,omitempty" name:"Errno"`
}

type DataSearchRequest 

type DataSearchRequest struct {
	*tchttp.BaseRequest

	// 云搜的业务ID，用以表明当前数据请求的业务
	ResourceId *uint64 `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// 检索串
	SearchQuery *string `json:"SearchQuery,omitnil,omitempty" name:"SearchQuery"`

	// 当前页，从第0页开始计算
	PageId *uint64 `json:"PageId,omitnil,omitempty" name:"PageId"`

	// 每页结果数
	NumPerPage *uint64 `json:"NumPerPage,omitnil,omitempty" name:"NumPerPage"`

	// 当前检索号，用于定位问题，建议指定并且全局唯一
	SearchId *string `json:"SearchId,omitnil,omitempty" name:"SearchId"`

	// 请求编码，0表示utf8，1表示gbk，建议指定
	QueryEncode *uint64 `json:"QueryEncode,omitnil,omitempty" name:"QueryEncode"`

	// 排序类型
	RankType *uint64 `json:"RankType,omitnil,omitempty" name:"RankType"`

	// 数值过滤，结果中按属性过滤
	NumFilter *string `json:"NumFilter,omitnil,omitempty" name:"NumFilter"`

	// 分类过滤，导航类检索请求
	ClFilter *string `json:"ClFilter,omitnil,omitempty" name:"ClFilter"`

	// 检索用户相关字段
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// 检索来源
	SourceId *uint64 `json:"SourceId,omitnil,omitempty" name:"SourceId"`

	// 是否进行二次检索，0关闭，1打开
	SecondSearch *uint64 `json:"SecondSearch,omitnil,omitempty" name:"SecondSearch"`

	// 指定返回最大篇数，无特殊原因不建议指定
	MaxDocReturn *uint64 `json:"MaxDocReturn,omitnil,omitempty" name:"MaxDocReturn"`

	// 是否smartbox检索，0关闭，1打开
	IsSmartbox *uint64 `json:"IsSmartbox,omitnil,omitempty" name:"IsSmartbox"`

	// 是否打开高红标亮，0关闭，1打开
	EnableAbsHighlight *uint64 `json:"EnableAbsHighlight,omitnil,omitempty" name:"EnableAbsHighlight"`

	// 指定访问QC纠错业务ID
	QcBid *uint64 `json:"QcBid,omitnil,omitempty" name:"QcBid"`

	// 按指定字段进行group by，只能对数值字段进行操作
	GroupBy *string `json:"GroupBy,omitnil,omitempty" name:"GroupBy"`

	// 按指定字段进行distinct，只能对数值字段进行操作
	Distinct *string `json:"Distinct,omitnil,omitempty" name:"Distinct"`

	// 高级排序参数，具体参见高级排序说明
	L4RankExpression *string `json:"L4RankExpression,omitnil,omitempty" name:"L4RankExpression"`

	// 高级排序参数，具体参见高级排序说明
	MatchValue *string `json:"MatchValue,omitnil,omitempty" name:"MatchValue"`

	// 经度信息
	Longitude *float64 `json:"Longitude,omitnil,omitempty" name:"Longitude"`

	// 纬度信息
	Latitude *float64 `json:"Latitude,omitnil,omitempty" name:"Latitude"`

	// 分类过滤并集
	MultiFilter []*string `json:"MultiFilter,omitnil,omitempty" name:"MultiFilter"`
}

func NewDataSearchRequest 

func NewDataSearchRequest() (request *DataSearchRequest)

func (*DataSearchRequest) FromJsonString 

func (r *DataSearchRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DataSearchRequest) ToJsonString 

func (r *DataSearchRequest) ToJsonString() string

type DataSearchRequestParams added in v1.0.426 

type DataSearchRequestParams struct {
	// 云搜的业务ID，用以表明当前数据请求的业务
	ResourceId *uint64 `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// 检索串
	SearchQuery *string `json:"SearchQuery,omitnil,omitempty" name:"SearchQuery"`

	// 当前页，从第0页开始计算
	PageId *uint64 `json:"PageId,omitnil,omitempty" name:"PageId"`

	// 每页结果数
	NumPerPage *uint64 `json:"NumPerPage,omitnil,omitempty" name:"NumPerPage"`

	// 当前检索号，用于定位问题，建议指定并且全局唯一
	SearchId *string `json:"SearchId,omitnil,omitempty" name:"SearchId"`

	// 请求编码，0表示utf8，1表示gbk，建议指定
	QueryEncode *uint64 `json:"QueryEncode,omitnil,omitempty" name:"QueryEncode"`

	// 排序类型
	RankType *uint64 `json:"RankType,omitnil,omitempty" name:"RankType"`

	// 数值过滤，结果中按属性过滤
	NumFilter *string `json:"NumFilter,omitnil,omitempty" name:"NumFilter"`

	// 分类过滤，导航类检索请求
	ClFilter *string `json:"ClFilter,omitnil,omitempty" name:"ClFilter"`

	// 检索用户相关字段
	Extra *string `json:"Extra,omitnil,omitempty" name:"Extra"`

	// 检索来源
	SourceId *uint64 `json:"SourceId,omitnil,omitempty" name:"SourceId"`

	// 是否进行二次检索，0关闭，1打开
	SecondSearch *uint64 `json:"SecondSearch,omitnil,omitempty" name:"SecondSearch"`

	// 指定返回最大篇数，无特殊原因不建议指定
	MaxDocReturn *uint64 `json:"MaxDocReturn,omitnil,omitempty" name:"MaxDocReturn"`

	// 是否smartbox检索，0关闭，1打开
	IsSmartbox *uint64 `json:"IsSmartbox,omitnil,omitempty" name:"IsSmartbox"`

	// 是否打开高红标亮，0关闭，1打开
	EnableAbsHighlight *uint64 `json:"EnableAbsHighlight,omitnil,omitempty" name:"EnableAbsHighlight"`

	// 指定访问QC纠错业务ID
	QcBid *uint64 `json:"QcBid,omitnil,omitempty" name:"QcBid"`

	// 按指定字段进行group by，只能对数值字段进行操作
	GroupBy *string `json:"GroupBy,omitnil,omitempty" name:"GroupBy"`

	// 按指定字段进行distinct，只能对数值字段进行操作
	Distinct *string `json:"Distinct,omitnil,omitempty" name:"Distinct"`

	// 高级排序参数，具体参见高级排序说明
	L4RankExpression *string `json:"L4RankExpression,omitnil,omitempty" name:"L4RankExpression"`

	// 高级排序参数，具体参见高级排序说明
	MatchValue *string `json:"MatchValue,omitnil,omitempty" name:"MatchValue"`

	// 经度信息
	Longitude *float64 `json:"Longitude,omitnil,omitempty" name:"Longitude"`

	// 纬度信息
	Latitude *float64 `json:"Latitude,omitnil,omitempty" name:"Latitude"`

	// 分类过滤并集
	MultiFilter []*string `json:"MultiFilter,omitnil,omitempty" name:"MultiFilter"`
}

Predefined struct for user

type DataSearchResponse 

type DataSearchResponse struct {
	*tchttp.BaseResponse
	Response *DataSearchResponseParams `json:"Response"`
}

func NewDataSearchResponse 

func NewDataSearchResponse() (response *DataSearchResponse)

func (*DataSearchResponse) FromJsonString 

func (r *DataSearchResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DataSearchResponse) ToJsonString 

func (r *DataSearchResponse) ToJsonString() string

type DataSearchResponseParams added in v1.0.426 

type DataSearchResponseParams struct {
	// 检索结果
	Data *SearchResult `json:"Data,omitnil,omitempty" name:"Data"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SearchResult 

type SearchResult struct {
	// 检索耗时，单位ms
	CostTime *uint64 `json:"CostTime,omitnil,omitempty" name:"CostTime"`

	// 搜索最多可以展示的结果数，多页
	DisplayNum *uint64 `json:"DisplayNum,omitnil,omitempty" name:"DisplayNum"`

	// 和检索请求中的echo相对应
	Echo *string `json:"Echo,omitnil,omitempty" name:"Echo"`

	// 检索结果的估算篇数，由索引平台估算
	EResultNum *uint64 `json:"EResultNum,omitnil,omitempty" name:"EResultNum"`

	// 检索返回的当前页码结果数
	ResultNum *uint64 `json:"ResultNum,omitnil,omitempty" name:"ResultNum"`

	// 检索结果列表
	// 注意：此字段可能返回 null，表示取不到有效值。
	ResultList []*SearchResultItem `json:"ResultList,omitnil,omitempty" name:"ResultList"`

	// 检索的分词结果，array类型，可包含多个
	// 注意：此字段可能返回 null，表示取不到有效值。
	SegList []*SearchResultSeg `json:"SegList,omitnil,omitempty" name:"SegList"`
}

type SearchResultItem 

type SearchResultItem struct {
	// 动态摘要信息
	DocAbs *string `json:"DocAbs,omitnil,omitempty" name:"DocAbs"`

	// 检索文档id
	DocId *string `json:"DocId,omitnil,omitempty" name:"DocId"`

	// 原始文档信息
	DocMeta *string `json:"DocMeta,omitnil,omitempty" name:"DocMeta"`

	// 精计算得分
	L2Score *float64 `json:"L2Score,omitnil,omitempty" name:"L2Score"`

	// 文档级回传信息
	SearchDebuginfo *string `json:"SearchDebuginfo,omitnil,omitempty" name:"SearchDebuginfo"`
}

type SearchResultSeg 

type SearchResultSeg struct {
	// 分词
	SegStr *string `json:"SegStr,omitnil,omitempty" name:"SegStr"`
}

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.