client

package
v4.1.0 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2025 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Overview

This file is auto-generated, don't edit it. Thanks.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddImageAdvanceRequest

type AddImageAdvanceRequest struct {
	// The category of the image. For more information, see [Category reference](https://help.aliyun.com/document_detail/179184.html).
	//
	// > 	- For product image search, if you specify a category for an image, the specified category prevails. If you do not specify a category for an image, the system predicts the category, and returns the prediction result in the response.
	//
	// >	- For generic image search, only 88888888 may be returned for this parameter in the response regardless of whether a category is specified.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// Specifies whether to identify the subject in the image and search for images based on the subject identification result. Default value: true. Valid values:
	//
	// 	- true: The system identifies the subject in the image, and searches for images based on the subject identification result. The subject identification result is included in the response.
	//
	// 	- false: The system does not identify the subject in the image, and searches for images based on the entire image.
	//
	// example:
	//
	// true
	Crop *bool `json:"Crop,omitempty" xml:"Crop,omitempty"`
	// The user-defined content. The value can be up to 4,096 characters in length.
	//
	// > If you specify this parameter, the response includes this parameter and its value. You can add text such as an image description.
	//
	// example:
	//
	// zidingyi
	CustomContent *string `json:"CustomContent,omitempty" xml:"CustomContent,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length. If an Image Search instance is purchased, you can log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance. If no Image Search instance is purchased, you must purchase an instance. For more information, see [Activate Image Search](https://help.aliyun.com/document_detail/179178.html) and [Create an instance](https://help.aliyun.com/document_detail/66569.html).
	//
	// > The instance name is not the instance ID.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// 22
	IntAttr *int32 `json:"IntAttr,omitempty" xml:"IntAttr,omitempty"`
	// The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// 22
	IntAttr2 *int32 `json:"IntAttr2,omitempty" xml:"IntAttr2,omitempty"`
	IntAttr3 *int32 `json:"IntAttr3,omitempty" xml:"IntAttr3,omitempty"`
	IntAttr4 *int32 `json:"IntAttr4,omitempty" xml:"IntAttr4,omitempty"`
	// The image file. The image file is encoded in Base64.
	//
	// 	- The file size of the image cannot exceed 4 MB.
	//
	// 	- The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.
	//
	// 	- The transmission timeout period cannot exceed 5 seconds.
	//
	// 	- For product and generic image searches, the length and width of the image must range from 100 pixels to 4,096 pixels.
	//
	// 	- The image cannot contain rotation settings.
	//
	// > 	- If you use SDKs to call this operation, you do not need to specify **PicContent**. The SDKs encapsulate this parameter and automatically encode its value in Base64. For more information about how to use Image Search SDK for Java, see [Java SDK](https://help.aliyun.com/document_detail/179188.html).
	//
	// >	- If you use OpenAPI Explorer to call this operation, you can select only the **2019-03-25*	- version. If you call this operation of other versions, the value of **PicContent*	- cannot be encoded in Base64.
	//
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PicContentObject io.Reader `json:"PicContent,omitempty" xml:"PicContent,omitempty"`
	// The name of the image. The name can be up to 512 characters in length.
	//
	// > 	- An image is uniquely identified by the values of ProductId and PicName.
	//
	// >	- If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product. The ID can be up to 512 characters in length.
	//
	// > A product may have multiple images.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The subject area of the image, in the format of `x1,x2,y1,y2`. `x1 and y1` represent the position in the upper-left corner, in pixels. `x2 and y2` represent the position in the lower-right corner, in pixels.
	//
	// > 	- If you specify Region, the system searches for images based on the value of Region regardless of the value of Crop.
	//
	// >	- The value of Region does not have a unit. The value is generated based on the length and width of the image. If the length and width of the image are scaled, the value of Region must be proportionally adjusted.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
	// The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// > The value cannot contain the following special characters: \\ ¥ $ & %
	//
	// example:
	//
	// ss
	StrAttr *string `json:"StrAttr,omitempty" xml:"StrAttr,omitempty"`
	// The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// > The value cannot contain the following special characters: \\ ¥ $ & %
	//
	// example:
	//
	// ss
	StrAttr2 *string `json:"StrAttr2,omitempty" xml:"StrAttr2,omitempty"`
	StrAttr3 *string `json:"StrAttr3,omitempty" xml:"StrAttr3,omitempty"`
	StrAttr4 *string `json:"StrAttr4,omitempty" xml:"StrAttr4,omitempty"`
}

func (AddImageAdvanceRequest) GoString

func (s AddImageAdvanceRequest) GoString() string

func (*AddImageAdvanceRequest) SetCategoryId

func (*AddImageAdvanceRequest) SetCrop

func (*AddImageAdvanceRequest) SetCustomContent

func (s *AddImageAdvanceRequest) SetCustomContent(v string) *AddImageAdvanceRequest

func (*AddImageAdvanceRequest) SetInstanceName

func (s *AddImageAdvanceRequest) SetInstanceName(v string) *AddImageAdvanceRequest

func (*AddImageAdvanceRequest) SetIntAttr

func (*AddImageAdvanceRequest) SetIntAttr2 added in v4.0.2

func (*AddImageAdvanceRequest) SetIntAttr3 added in v4.1.0

func (*AddImageAdvanceRequest) SetIntAttr4 added in v4.1.0

func (*AddImageAdvanceRequest) SetPicContentObject

func (s *AddImageAdvanceRequest) SetPicContentObject(v io.Reader) *AddImageAdvanceRequest

func (*AddImageAdvanceRequest) SetPicName

func (*AddImageAdvanceRequest) SetProductId

func (*AddImageAdvanceRequest) SetRegion

func (*AddImageAdvanceRequest) SetStrAttr

func (*AddImageAdvanceRequest) SetStrAttr2 added in v4.0.2

func (*AddImageAdvanceRequest) SetStrAttr3 added in v4.1.0

func (*AddImageAdvanceRequest) SetStrAttr4 added in v4.1.0

func (AddImageAdvanceRequest) String

func (s AddImageAdvanceRequest) String() string

type AddImageRequest

type AddImageRequest struct {
	// The category of the image. For more information, see [Category reference](https://help.aliyun.com/document_detail/179184.html).
	//
	// > 	- For product image search, if you specify a category for an image, the specified category prevails. If you do not specify a category for an image, the system predicts the category, and returns the prediction result in the response.
	//
	// >	- For generic image search, only 88888888 may be returned for this parameter in the response regardless of whether a category is specified.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// Specifies whether to identify the subject in the image and search for images based on the subject identification result. Default value: true. Valid values:
	//
	// 	- true: The system identifies the subject in the image, and searches for images based on the subject identification result. The subject identification result is included in the response.
	//
	// 	- false: The system does not identify the subject in the image, and searches for images based on the entire image.
	//
	// example:
	//
	// true
	Crop *bool `json:"Crop,omitempty" xml:"Crop,omitempty"`
	// The user-defined content. The value can be up to 4,096 characters in length.
	//
	// > If you specify this parameter, the response includes this parameter and its value. You can add text such as an image description.
	//
	// example:
	//
	// zidingyi
	CustomContent *string `json:"CustomContent,omitempty" xml:"CustomContent,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length. If an Image Search instance is purchased, you can log on to the [Image Search console](https://imagesearch.console.aliyun.com/) to view the instance. If no Image Search instance is purchased, you must purchase an instance. For more information, see [Activate Image Search](https://help.aliyun.com/document_detail/179178.html) and [Create an instance](https://help.aliyun.com/document_detail/66569.html).
	//
	// > The instance name is not the instance ID.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// 22
	IntAttr *int32 `json:"IntAttr,omitempty" xml:"IntAttr,omitempty"`
	// The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// 22
	IntAttr2 *int32 `json:"IntAttr2,omitempty" xml:"IntAttr2,omitempty"`
	IntAttr3 *int32 `json:"IntAttr3,omitempty" xml:"IntAttr3,omitempty"`
	IntAttr4 *int32 `json:"IntAttr4,omitempty" xml:"IntAttr4,omitempty"`
	// The image file. The image file is encoded in Base64.
	//
	// 	- The file size of the image cannot exceed 4 MB.
	//
	// 	- The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.
	//
	// 	- The transmission timeout period cannot exceed 5 seconds.
	//
	// 	- For product and generic image searches, the length and width of the image must range from 100 pixels to 4,096 pixels.
	//
	// 	- The image cannot contain rotation settings.
	//
	// > 	- If you use SDKs to call this operation, you do not need to specify **PicContent**. The SDKs encapsulate this parameter and automatically encode its value in Base64. For more information about how to use Image Search SDK for Java, see [Java SDK](https://help.aliyun.com/document_detail/179188.html).
	//
	// >	- If you use OpenAPI Explorer to call this operation, you can select only the **2019-03-25*	- version. If you call this operation of other versions, the value of **PicContent*	- cannot be encoded in Base64.
	//
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PicContent *string `json:"PicContent,omitempty" xml:"PicContent,omitempty"`
	// The name of the image. The name can be up to 512 characters in length.
	//
	// > 	- An image is uniquely identified by the values of ProductId and PicName.
	//
	// >	- If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product. The ID can be up to 512 characters in length.
	//
	// > A product may have multiple images.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The subject area of the image, in the format of `x1,x2,y1,y2`. `x1 and y1` represent the position in the upper-left corner, in pixels. `x2 and y2` represent the position in the lower-right corner, in pixels.
	//
	// > 	- If you specify Region, the system searches for images based on the value of Region regardless of the value of Crop.
	//
	// >	- The value of Region does not have a unit. The value is generated based on the length and width of the image. If the length and width of the image are scaled, the value of Region must be proportionally adjusted.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
	// The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// > The value cannot contain the following special characters: \\ ¥ $ & %
	//
	// example:
	//
	// ss
	StrAttr *string `json:"StrAttr,omitempty" xml:"StrAttr,omitempty"`
	// The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images when you search for images. If you specify this parameter, the response includes this parameter and its value.
	//
	// > The value cannot contain the following special characters: \\ ¥ $ & %
	//
	// example:
	//
	// ss
	StrAttr2 *string `json:"StrAttr2,omitempty" xml:"StrAttr2,omitempty"`
	StrAttr3 *string `json:"StrAttr3,omitempty" xml:"StrAttr3,omitempty"`
	StrAttr4 *string `json:"StrAttr4,omitempty" xml:"StrAttr4,omitempty"`
}

func (AddImageRequest) GoString

func (s AddImageRequest) GoString() string

func (*AddImageRequest) SetCategoryId

func (s *AddImageRequest) SetCategoryId(v int32) *AddImageRequest

func (*AddImageRequest) SetCrop

func (s *AddImageRequest) SetCrop(v bool) *AddImageRequest

func (*AddImageRequest) SetCustomContent

func (s *AddImageRequest) SetCustomContent(v string) *AddImageRequest

func (*AddImageRequest) SetInstanceName

func (s *AddImageRequest) SetInstanceName(v string) *AddImageRequest

func (*AddImageRequest) SetIntAttr

func (s *AddImageRequest) SetIntAttr(v int32) *AddImageRequest

func (*AddImageRequest) SetIntAttr2 added in v4.0.2

func (s *AddImageRequest) SetIntAttr2(v int32) *AddImageRequest

func (*AddImageRequest) SetIntAttr3 added in v4.1.0

func (s *AddImageRequest) SetIntAttr3(v int32) *AddImageRequest

func (*AddImageRequest) SetIntAttr4 added in v4.1.0

func (s *AddImageRequest) SetIntAttr4(v int32) *AddImageRequest

func (*AddImageRequest) SetPicContent

func (s *AddImageRequest) SetPicContent(v string) *AddImageRequest

func (*AddImageRequest) SetPicName

func (s *AddImageRequest) SetPicName(v string) *AddImageRequest

func (*AddImageRequest) SetProductId

func (s *AddImageRequest) SetProductId(v string) *AddImageRequest

func (*AddImageRequest) SetRegion

func (s *AddImageRequest) SetRegion(v string) *AddImageRequest

func (*AddImageRequest) SetStrAttr

func (s *AddImageRequest) SetStrAttr(v string) *AddImageRequest

func (*AddImageRequest) SetStrAttr2 added in v4.0.2

func (s *AddImageRequest) SetStrAttr2(v string) *AddImageRequest

func (*AddImageRequest) SetStrAttr3 added in v4.1.0

func (s *AddImageRequest) SetStrAttr3(v string) *AddImageRequest

func (*AddImageRequest) SetStrAttr4 added in v4.1.0

func (s *AddImageRequest) SetStrAttr4(v string) *AddImageRequest

func (AddImageRequest) String

func (s AddImageRequest) String() string

type AddImageResponse

type AddImageResponse struct {
	Headers    map[string]*string    `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *AddImageResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (AddImageResponse) GoString

func (s AddImageResponse) GoString() string

func (*AddImageResponse) SetBody

func (*AddImageResponse) SetHeaders

func (s *AddImageResponse) SetHeaders(v map[string]*string) *AddImageResponse

func (*AddImageResponse) SetStatusCode

func (s *AddImageResponse) SetStatusCode(v int32) *AddImageResponse

func (AddImageResponse) String

func (s AddImageResponse) String() string

type AddImageResponseBody

type AddImageResponseBody struct {
	// The code returned.
	//
	// 	- A value of 0 indicates that the request was successful.
	//
	// 	- Values other than 0 indicate that the request failed.
	//
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// The error message returned if the request failed.
	//
	// > No value is returned if the request was successful, and an error message is returned if the request failed.
	//
	// example:
	//
	// success
	Message *string `json:"Message,omitempty" xml:"Message,omitempty"`
	// The results of category prediction and subject identification.
	PicInfo *AddImageResponseBodyPicInfo `json:"PicInfo,omitempty" xml:"PicInfo,omitempty" type:"Struct"`
	// The request ID.
	//
	// example:
	//
	// E0845DE6-52AF-4B50-9F15-51ED4044E6AB
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request was successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (AddImageResponseBody) GoString

func (s AddImageResponseBody) GoString() string

func (*AddImageResponseBody) SetCode

func (*AddImageResponseBody) SetMessage

func (*AddImageResponseBody) SetPicInfo

func (*AddImageResponseBody) SetRequestId

func (s *AddImageResponseBody) SetRequestId(v string) *AddImageResponseBody

func (*AddImageResponseBody) SetSuccess

func (AddImageResponseBody) String

func (s AddImageResponseBody) String() string

type AddImageResponseBodyPicInfo

type AddImageResponseBodyPicInfo struct {
	// The result of category prediction. If a category is specified in the request, the specified category prevails.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// The result of subject identification. The subject area of the image is in the format of `x1,x2,y1,y2`. `x1 and y1` represent the position in the upper-left corner, in pixels. `x2 and y2` represent the position in the lower-right corner, in pixels. If a subject area is specified in the request, the specified subject area prevails.
	//
	// example:
	//
	// 94,691,206,650
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
}

func (AddImageResponseBodyPicInfo) GoString

func (s AddImageResponseBodyPicInfo) GoString() string

func (*AddImageResponseBodyPicInfo) SetCategoryId

func (*AddImageResponseBodyPicInfo) SetRegion

func (AddImageResponseBodyPicInfo) String

type Client

type Client struct {
	openapi.Client
}

func NewClient

func NewClient(config *openapi.Config) (*Client, error)

func (*Client) AddImage

func (client *Client) AddImage(request *AddImageRequest) (_result *AddImageResponse, _err error)

Summary:

Adds an image to an Image Search instance.

Description:

You can call this operation to add an image to an Image Search instance.

> If you want to obtain more information about the service and technical support, click [Online Consulting](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or join the DingTalk group (ID 35035130).

## QPS limits

By default, the concurrency limit for adding an image to instances whose image capacity specifications are 0.1 million images is 1. This means that the system can process up to one request of adding an image every second. By default, the concurrency limit for adding an image to instances of other image capacity specifications is 5. This means that the system can process up to five requests of adding an image every second.

@param request - AddImageRequest

@return AddImageResponse

func (*Client) AddImageAdvance

func (client *Client) AddImageAdvance(request *AddImageAdvanceRequest, runtime *util.RuntimeOptions) (_result *AddImageResponse, _err error)

func (*Client) AddImageWithOptions

func (client *Client) AddImageWithOptions(request *AddImageRequest, runtime *util.RuntimeOptions) (_result *AddImageResponse, _err error)

Summary:

Adds an image to an Image Search instance.

Description:

You can call this operation to add an image to an Image Search instance.

> If you want to obtain more information about the service and technical support, click [Online Consulting](https://www.aliyun.com/core/online-consult?from=aZgW6LJHr2) or join the DingTalk group (ID 35035130).

## QPS limits

By default, the concurrency limit for adding an image to instances whose image capacity specifications are 0.1 million images is 1. This means that the system can process up to one request of adding an image every second. By default, the concurrency limit for adding an image to instances of other image capacity specifications is 5. This means that the system can process up to five requests of adding an image every second.

@param request - AddImageRequest

@param runtime - runtime options for this request RuntimeOptions

@return AddImageResponse

func (*Client) CompareSimilarByImage added in v4.1.0

func (client *Client) CompareSimilarByImage(request *CompareSimilarByImageRequest) (_result *CompareSimilarByImageResponse, _err error)

Summary:

对比图片相似值

@param request - CompareSimilarByImageRequest

@return CompareSimilarByImageResponse

func (*Client) CompareSimilarByImageAdvance added in v4.1.0

func (client *Client) CompareSimilarByImageAdvance(request *CompareSimilarByImageAdvanceRequest, runtime *util.RuntimeOptions) (_result *CompareSimilarByImageResponse, _err error)

func (*Client) CompareSimilarByImageWithOptions added in v4.1.0

func (client *Client) CompareSimilarByImageWithOptions(request *CompareSimilarByImageRequest, runtime *util.RuntimeOptions) (_result *CompareSimilarByImageResponse, _err error)

Summary:

对比图片相似值

@param request - CompareSimilarByImageRequest

@param runtime - runtime options for this request RuntimeOptions

@return CompareSimilarByImageResponse

func (*Client) DeleteImage

func (client *Client) DeleteImage(request *DeleteImageRequest) (_result *DeleteImageResponse, _err error)

Summary:

This topic describes the syntax of the DeleteImage operation and provides examples of this operation. You can call this operation to delete images from an Image Search instance.

Description:

This operation deletes images from an Image Search instance.

> A success response is returned even if the specified image does not exist on the instance. Therefore, you cannot determine whether the image exists on the instance based on the response.

## QPS limits

By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.

@param request - DeleteImageRequest

@return DeleteImageResponse

func (*Client) DeleteImageWithOptions

func (client *Client) DeleteImageWithOptions(request *DeleteImageRequest, runtime *util.RuntimeOptions) (_result *DeleteImageResponse, _err error)

Summary:

This topic describes the syntax of the DeleteImage operation and provides examples of this operation. You can call this operation to delete images from an Image Search instance.

Description:

This operation deletes images from an Image Search instance.

> A success response is returned even if the specified image does not exist on the instance. Therefore, you cannot determine whether the image exists on the instance based on the response.

## QPS limits

By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.

@param request - DeleteImageRequest

@param runtime - runtime options for this request RuntimeOptions

@return DeleteImageResponse

func (*Client) Detail

func (client *Client) Detail(request *DetailRequest) (_result *DetailResponse, _err error)

Summary:

This topic describes the syntax of the Detail operation and provides examples of this operation. You can call this operation to query instance details.

Description:

This operation queries instance details.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process only 1 request every second.

@param request - DetailRequest

@return DetailResponse

func (*Client) DetailWithOptions

func (client *Client) DetailWithOptions(request *DetailRequest, runtime *util.RuntimeOptions) (_result *DetailResponse, _err error)

Summary:

This topic describes the syntax of the Detail operation and provides examples of this operation. You can call this operation to query instance details.

Description:

This operation queries instance details.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process only 1 request every second.

@param request - DetailRequest

@param runtime - runtime options for this request RuntimeOptions

@return DetailResponse

func (*Client) DumpMeta

func (client *Client) DumpMeta(request *DumpMetaRequest) (_result *DumpMetaResponse, _err error)

Summary:

This topic describes the syntax of the DumpMeta operation and provides examples of this operation. You can call this operation to create a task for exporting metadata from an Image Search instance.

Description:

This operation creates a task for exporting metadata from an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - DumpMetaRequest

@return DumpMetaResponse

func (*Client) DumpMetaList

func (client *Client) DumpMetaList(request *DumpMetaListRequest) (_result *DumpMetaListResponse, _err error)

Summary:

This topic describes the syntax of the DumpMetaList operation and provides examples of this operation. You can call this operation to query tasks that are used for exporting metadata from an Image Search instance.

Description:

This operation queries tasks that are used for exporting metadata from an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - DumpMetaListRequest

@return DumpMetaListResponse

func (*Client) DumpMetaListWithOptions

func (client *Client) DumpMetaListWithOptions(request *DumpMetaListRequest, runtime *util.RuntimeOptions) (_result *DumpMetaListResponse, _err error)

Summary:

This topic describes the syntax of the DumpMetaList operation and provides examples of this operation. You can call this operation to query tasks that are used for exporting metadata from an Image Search instance.

Description:

This operation queries tasks that are used for exporting metadata from an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - DumpMetaListRequest

@param runtime - runtime options for this request RuntimeOptions

@return DumpMetaListResponse

func (*Client) DumpMetaWithOptions

func (client *Client) DumpMetaWithOptions(request *DumpMetaRequest, runtime *util.RuntimeOptions) (_result *DumpMetaResponse, _err error)

Summary:

This topic describes the syntax of the DumpMeta operation and provides examples of this operation. You can call this operation to create a task for exporting metadata from an Image Search instance.

Description:

This operation creates a task for exporting metadata from an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - DumpMetaRequest

@param runtime - runtime options for this request RuntimeOptions

@return DumpMetaResponse

func (*Client) GetEndpoint

func (client *Client) GetEndpoint(productId *string, regionId *string, endpointRule *string, network *string, suffix *string, endpointMap map[string]*string, endpoint *string) (_result *string, _err error)

func (*Client) IncreaseInstance

func (client *Client) IncreaseInstance(request *IncreaseInstanceRequest) (_result *IncreaseInstanceResponse, _err error)

Summary:

This topic describes the syntax of the IncreaseInstance operation and provides examples of this operation. You can call this operation to create a batch task on an Image Search instance.

Description:

This operation creates a batch task on an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - IncreaseInstanceRequest

@return IncreaseInstanceResponse

func (*Client) IncreaseInstanceWithOptions

func (client *Client) IncreaseInstanceWithOptions(request *IncreaseInstanceRequest, runtime *util.RuntimeOptions) (_result *IncreaseInstanceResponse, _err error)

Summary:

This topic describes the syntax of the IncreaseInstance operation and provides examples of this operation. You can call this operation to create a batch task on an Image Search instance.

Description:

This operation creates a batch task on an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - IncreaseInstanceRequest

@param runtime - runtime options for this request RuntimeOptions

@return IncreaseInstanceResponse

func (*Client) IncreaseList

func (client *Client) IncreaseList(request *IncreaseListRequest) (_result *IncreaseListResponse, _err error)

Summary:

This topic describes the syntax of the IncreaseList operation and provides examples of this operation. You can call this operation to query batch tasks on an Image Search instance.

Description:

This operation queries batch tasks on an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - IncreaseListRequest

@return IncreaseListResponse

func (*Client) IncreaseListWithOptions

func (client *Client) IncreaseListWithOptions(request *IncreaseListRequest, runtime *util.RuntimeOptions) (_result *IncreaseListResponse, _err error)

Summary:

This topic describes the syntax of the IncreaseList operation and provides examples of this operation. You can call this operation to query batch tasks on an Image Search instance.

Description:

This operation queries batch tasks on an Image Search instance.

## QPS limits

By default, the maximum number of queries supported by this operation is 1. In this case, the system can process at most 1 request every second.

@param request - IncreaseListRequest

@param runtime - runtime options for this request RuntimeOptions

@return IncreaseListResponse

func (*Client) Init

func (client *Client) Init(config *openapi.Config) (_err error)

func (*Client) SearchImageByName

func (client *Client) SearchImageByName(request *SearchImageByNameRequest) (_result *SearchImageByNameResponse, _err error)

Summary:

This topic describes the syntax of the SearchByName operation and provides examples of this operation. You can call this operation to search for images by image name on an Image Search instance.

Description:

This operation searches for images by image name on an Image Search instance.

## QPS limits

The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS.

@param request - SearchImageByNameRequest

@return SearchImageByNameResponse

func (*Client) SearchImageByNameWithOptions

func (client *Client) SearchImageByNameWithOptions(request *SearchImageByNameRequest, runtime *util.RuntimeOptions) (_result *SearchImageByNameResponse, _err error)

Summary:

This topic describes the syntax of the SearchByName operation and provides examples of this operation. You can call this operation to search for images by image name on an Image Search instance.

Description:

This operation searches for images by image name on an Image Search instance.

## QPS limits

The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS.

@param request - SearchImageByNameRequest

@param runtime - runtime options for this request RuntimeOptions

@return SearchImageByNameResponse

func (*Client) SearchImageByPic

func (client *Client) SearchImageByPic(request *SearchImageByPicRequest) (_result *SearchImageByPicResponse, _err error)

Summary:

This topic describes the syntax of the SearchByPic operation and provides examples of this operation. You can call this operation to search for images by image on an Image Search Instance.

Description:

This operation searches for images by image name on an Image Search instance.

## QPS limits

The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS.

## SDK release notes

The Image Search SDK has been upgraded to version 3.1.1, which supports multi-subject recognition and similarity scores. For more information, see [Image Search SDK for Java](/help/en/image-search/latest/version-v3-java-sdk).

@param request - SearchImageByPicRequest

@return SearchImageByPicResponse

func (*Client) SearchImageByPicAdvance

func (client *Client) SearchImageByPicAdvance(request *SearchImageByPicAdvanceRequest, runtime *util.RuntimeOptions) (_result *SearchImageByPicResponse, _err error)

func (*Client) SearchImageByPicWithOptions

func (client *Client) SearchImageByPicWithOptions(request *SearchImageByPicRequest, runtime *util.RuntimeOptions) (_result *SearchImageByPicResponse, _err error)

Summary:

This topic describes the syntax of the SearchByPic operation and provides examples of this operation. You can call this operation to search for images by image on an Image Search Instance.

Description:

This operation searches for images by image name on an Image Search instance.

## QPS limits

The maximum number of queries per second is displayed in the Image Search console. The upper limit is specified when you purchase the instance. You can set the upper limit to 5 QPS or 10 QPS.

## SDK release notes

The Image Search SDK has been upgraded to version 3.1.1, which supports multi-subject recognition and similarity scores. For more information, see [Image Search SDK for Java](/help/en/image-search/latest/version-v3-java-sdk).

@param request - SearchImageByPicRequest

@param runtime - runtime options for this request RuntimeOptions

@return SearchImageByPicResponse

func (*Client) UpdateImage

func (client *Client) UpdateImage(request *UpdateImageRequest) (_result *UpdateImageResponse, _err error)

Summary:

This topic describes the syntax of the UpdateImage operation and provides examples of this operation. You can call this operation to update image information on an Image Search instance.

Description:

This operation updates image information on an Image Search instance.

> - Limits are imposed on the instance creation time.

> - This operation is supported by instances that are created in the Singapore (Singapore) region after December 2021. This operation is not supported in other regions.

## QPS limits

By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.

@param request - UpdateImageRequest

@return UpdateImageResponse

func (*Client) UpdateImageWithOptions

func (client *Client) UpdateImageWithOptions(request *UpdateImageRequest, runtime *util.RuntimeOptions) (_result *UpdateImageResponse, _err error)

Summary:

This topic describes the syntax of the UpdateImage operation and provides examples of this operation. You can call this operation to update image information on an Image Search instance.

Description:

This operation updates image information on an Image Search instance.

> - Limits are imposed on the instance creation time.

> - This operation is supported by instances that are created in the Singapore (Singapore) region after December 2021. This operation is not supported in other regions.

## QPS limits

By default, the maximum number of queries supported by this operation is 20. In this case, the system can process at most 20 requests every second.

@param request - UpdateImageRequest

@param runtime - runtime options for this request RuntimeOptions

@return UpdateImageResponse

type CompareSimilarByImageAdvanceRequest added in v4.1.0

type CompareSimilarByImageAdvanceRequest struct {
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PrimaryPicContentObject io.Reader `json:"PrimaryPicContent,omitempty" xml:"PrimaryPicContent,omitempty"`
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	SecondaryPicContentObject io.Reader `json:"SecondaryPicContent,omitempty" xml:"SecondaryPicContent,omitempty"`
}

func (CompareSimilarByImageAdvanceRequest) GoString added in v4.1.0

func (*CompareSimilarByImageAdvanceRequest) SetInstanceName added in v4.1.0

func (*CompareSimilarByImageAdvanceRequest) SetPrimaryPicContentObject added in v4.1.0

func (*CompareSimilarByImageAdvanceRequest) SetSecondaryPicContentObject added in v4.1.0

func (CompareSimilarByImageAdvanceRequest) String added in v4.1.0

type CompareSimilarByImageRequest added in v4.1.0

type CompareSimilarByImageRequest struct {
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PrimaryPicContent *string `json:"PrimaryPicContent,omitempty" xml:"PrimaryPicContent,omitempty"`
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	SecondaryPicContent *string `json:"SecondaryPicContent,omitempty" xml:"SecondaryPicContent,omitempty"`
}

func (CompareSimilarByImageRequest) GoString added in v4.1.0

func (s CompareSimilarByImageRequest) GoString() string

func (*CompareSimilarByImageRequest) SetInstanceName added in v4.1.0

func (*CompareSimilarByImageRequest) SetPrimaryPicContent added in v4.1.0

func (*CompareSimilarByImageRequest) SetSecondaryPicContent added in v4.1.0

func (CompareSimilarByImageRequest) String added in v4.1.0

type CompareSimilarByImageResponse added in v4.1.0

type CompareSimilarByImageResponse struct {
	Headers    map[string]*string                 `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                             `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *CompareSimilarByImageResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (CompareSimilarByImageResponse) GoString added in v4.1.0

func (*CompareSimilarByImageResponse) SetBody added in v4.1.0

func (*CompareSimilarByImageResponse) SetHeaders added in v4.1.0

func (*CompareSimilarByImageResponse) SetStatusCode added in v4.1.0

func (CompareSimilarByImageResponse) String added in v4.1.0

type CompareSimilarByImageResponseBody added in v4.1.0

type CompareSimilarByImageResponseBody struct {
	AccessDeniedDetail *CompareSimilarByImageResponseBodyAccessDeniedDetail `json:"AccessDeniedDetail,omitempty" xml:"AccessDeniedDetail,omitempty" type:"Struct"`
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// example:
	//
	// success
	Msg *string `json:"Msg,omitempty" xml:"Msg,omitempty"`
	// example:
	//
	// B3137727-7D6E-488C-BA21-0E034C38A879
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// example:
	//
	// 0.85
	Score *float64 `json:"Score,omitempty" xml:"Score,omitempty"`
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (CompareSimilarByImageResponseBody) GoString added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetAccessDeniedDetail added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetCode added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetMsg added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetRequestId added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetScore added in v4.1.0

func (*CompareSimilarByImageResponseBody) SetSuccess added in v4.1.0

func (CompareSimilarByImageResponseBody) String added in v4.1.0

type CompareSimilarByImageResponseBodyAccessDeniedDetail added in v4.1.0

type CompareSimilarByImageResponseBodyAccessDeniedDetail struct {
	AuthAction               *string `json:"AuthAction,omitempty" xml:"AuthAction,omitempty"`
	AuthPrincipalDisplayName *string `json:"AuthPrincipalDisplayName,omitempty" xml:"AuthPrincipalDisplayName,omitempty"`
	AuthPrincipalOwnerId     *string `json:"AuthPrincipalOwnerId,omitempty" xml:"AuthPrincipalOwnerId,omitempty"`
	AuthPrincipalType        *string `json:"AuthPrincipalType,omitempty" xml:"AuthPrincipalType,omitempty"`
	EncodedDiagnosticMessage *string `json:"EncodedDiagnosticMessage,omitempty" xml:"EncodedDiagnosticMessage,omitempty"`
	NoPermissionType         *string `json:"NoPermissionType,omitempty" xml:"NoPermissionType,omitempty"`
	PolicyType               *string `json:"PolicyType,omitempty" xml:"PolicyType,omitempty"`
}

func (CompareSimilarByImageResponseBodyAccessDeniedDetail) GoString added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetAuthAction added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetAuthPrincipalDisplayName added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetAuthPrincipalOwnerId added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetAuthPrincipalType added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetEncodedDiagnosticMessage added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetNoPermissionType added in v4.1.0

func (*CompareSimilarByImageResponseBodyAccessDeniedDetail) SetPolicyType added in v4.1.0

func (CompareSimilarByImageResponseBodyAccessDeniedDetail) String added in v4.1.0

type DeleteImageRequest

type DeleteImageRequest struct {
	Filter *string `json:"Filter,omitempty" xml:"Filter,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName     *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	IsDeleteByFilter *bool   `json:"IsDeleteByFilter,omitempty" xml:"IsDeleteByFilter,omitempty"`
	// The name of the image.
	//
	// 	- If this parameter is not set, the system deletes all the images that correspond to the specified ProductId parameter.
	//
	// 	- If this parameter is set, the system deletes only the image that is specified by the ProductId and PicName parameters.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the commodity.
	//
	// >  A commodity may have multiple images.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
}

func (DeleteImageRequest) GoString

func (s DeleteImageRequest) GoString() string

func (*DeleteImageRequest) SetFilter added in v4.1.0

func (s *DeleteImageRequest) SetFilter(v string) *DeleteImageRequest

func (*DeleteImageRequest) SetInstanceName

func (s *DeleteImageRequest) SetInstanceName(v string) *DeleteImageRequest

func (*DeleteImageRequest) SetIsDeleteByFilter added in v4.1.0

func (s *DeleteImageRequest) SetIsDeleteByFilter(v bool) *DeleteImageRequest

func (*DeleteImageRequest) SetPicName

func (s *DeleteImageRequest) SetPicName(v string) *DeleteImageRequest

func (*DeleteImageRequest) SetProductId

func (s *DeleteImageRequest) SetProductId(v string) *DeleteImageRequest

func (DeleteImageRequest) String

func (s DeleteImageRequest) String() string

type DeleteImageResponse

type DeleteImageResponse struct {
	Headers    map[string]*string       `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                   `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *DeleteImageResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (DeleteImageResponse) GoString

func (s DeleteImageResponse) GoString() string

func (*DeleteImageResponse) SetBody

func (*DeleteImageResponse) SetHeaders

func (s *DeleteImageResponse) SetHeaders(v map[string]*string) *DeleteImageResponse

func (*DeleteImageResponse) SetStatusCode

func (s *DeleteImageResponse) SetStatusCode(v int32) *DeleteImageResponse

func (DeleteImageResponse) String

func (s DeleteImageResponse) String() string

type DeleteImageResponseBody

type DeleteImageResponseBody struct {
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// The information about the deleted images.
	Data *DeleteImageResponseBodyData `json:"Data,omitempty" xml:"Data,omitempty" type:"Struct"`
	// The error message returned.
	//
	// example:
	//
	// success
	Message *string `json:"Message,omitempty" xml:"Message,omitempty"`
	// The ID of the request.
	//
	// example:
	//
	// 0703956F-9BCC-48FA-99F7-96C0BF449C69
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (DeleteImageResponseBody) GoString

func (s DeleteImageResponseBody) GoString() string

func (*DeleteImageResponseBody) SetCode

func (*DeleteImageResponseBody) SetData

func (*DeleteImageResponseBody) SetMessage

func (*DeleteImageResponseBody) SetRequestId

func (*DeleteImageResponseBody) SetSuccess

func (DeleteImageResponseBody) String

func (s DeleteImageResponseBody) String() string

type DeleteImageResponseBodyData

type DeleteImageResponseBodyData struct {
	// The name (PicName) of the deleted image.
	//
	// example:
	//
	// 5555.jpg
	PicNames []*string `json:"PicNames,omitempty" xml:"PicNames,omitempty" type:"Repeated"`
}

func (DeleteImageResponseBodyData) GoString

func (s DeleteImageResponseBodyData) GoString() string

func (*DeleteImageResponseBodyData) SetPicNames

func (DeleteImageResponseBodyData) String

type DetailRequest

type DetailRequest struct {
	// The name of the instance.
	//
	// This parameter is required.
	//
	// example:
	//
	// imagesearchName
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
}

func (DetailRequest) GoString

func (s DetailRequest) GoString() string

func (*DetailRequest) SetInstanceName

func (s *DetailRequest) SetInstanceName(v string) *DetailRequest

func (DetailRequest) String

func (s DetailRequest) String() string

type DetailResponse

type DetailResponse struct {
	Headers    map[string]*string  `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32              `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *DetailResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (DetailResponse) GoString

func (s DetailResponse) GoString() string

func (*DetailResponse) SetBody

func (*DetailResponse) SetHeaders

func (s *DetailResponse) SetHeaders(v map[string]*string) *DetailResponse

func (*DetailResponse) SetStatusCode

func (s *DetailResponse) SetStatusCode(v int32) *DetailResponse

func (DetailResponse) String

func (s DetailResponse) String() string

type DetailResponseBody

type DetailResponseBody struct {
	// The details about the instance.
	Instance *DetailResponseBodyInstance `json:"Instance,omitempty" xml:"Instance,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (DetailResponseBody) GoString

func (s DetailResponseBody) GoString() string

func (*DetailResponseBody) SetInstance

func (*DetailResponseBody) SetRequestId

func (s *DetailResponseBody) SetRequestId(v string) *DetailResponseBody

func (*DetailResponseBody) SetSuccess

func (s *DetailResponseBody) SetSuccess(v bool) *DetailResponseBody

func (DetailResponseBody) String

func (s DetailResponseBody) String() string

type DetailResponseBodyInstance

type DetailResponseBodyInstance struct {
	// The capacity of the plan. Unit: × 10,000 images.
	//
	// example:
	//
	// 10
	Capacity *int32 `json:"Capacity,omitempty" xml:"Capacity,omitempty"`
	// The name of the instance.
	//
	// example:
	//
	// imagesearchName
	Name *string `json:"Name,omitempty" xml:"Name,omitempty"`
	// The number of queries per second supported by the plan.
	//
	// example:
	//
	// 1
	Qps *int32 `json:"Qps,omitempty" xml:"Qps,omitempty"`
	// The information about the region.
	//
	// example:
	//
	// cn-shanghai
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
	// The Image Search model.
	//
	// 0: commodity search. 1: generic image search.
	//
	// example:
	//
	// 0
	ServiceType *int32 `json:"ServiceType,omitempty" xml:"ServiceType,omitempty"`
	// The number of images.
	//
	// example:
	//
	// 10063
	TotalCount *int64 `json:"TotalCount,omitempty" xml:"TotalCount,omitempty"`
	// The time when the instance was created. Unit: milliseconds.
	//
	// example:
	//
	// 1620382716000
	UtcCreate *string `json:"UtcCreate,omitempty" xml:"UtcCreate,omitempty"`
	// The time when the instance expires. Unit: milliseconds.
	//
	// example:
	//
	// 1623081600000
	UtcExpireTime *string `json:"UtcExpireTime,omitempty" xml:"UtcExpireTime,omitempty"`
}

func (DetailResponseBodyInstance) GoString

func (s DetailResponseBodyInstance) GoString() string

func (*DetailResponseBodyInstance) SetCapacity

func (*DetailResponseBodyInstance) SetName

func (*DetailResponseBodyInstance) SetQps

func (*DetailResponseBodyInstance) SetRegion

func (*DetailResponseBodyInstance) SetServiceType

func (*DetailResponseBodyInstance) SetTotalCount

func (*DetailResponseBodyInstance) SetUtcCreate

func (*DetailResponseBodyInstance) SetUtcExpireTime

func (DetailResponseBodyInstance) String

type DumpMetaListRequest

type DumpMetaListRequest struct {
	// The ID of the export task.
	//
	// example:
	//
	// 500
	Id *int64 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The number of the page to return. Default value: 1.
	//
	// example:
	//
	// 1
	PageNumber *int32 `json:"PageNumber,omitempty" xml:"PageNumber,omitempty"`
	// The number of images to return on each page. Default value: 10.
	//
	// example:
	//
	// 10
	PageSize *int32 `json:"PageSize,omitempty" xml:"PageSize,omitempty"`
}

func (DumpMetaListRequest) GoString

func (s DumpMetaListRequest) GoString() string

func (*DumpMetaListRequest) SetId

func (*DumpMetaListRequest) SetInstanceName

func (s *DumpMetaListRequest) SetInstanceName(v string) *DumpMetaListRequest

func (*DumpMetaListRequest) SetPageNumber

func (s *DumpMetaListRequest) SetPageNumber(v int32) *DumpMetaListRequest

func (*DumpMetaListRequest) SetPageSize

func (s *DumpMetaListRequest) SetPageSize(v int32) *DumpMetaListRequest

func (DumpMetaListRequest) String

func (s DumpMetaListRequest) String() string

type DumpMetaListResponse

type DumpMetaListResponse struct {
	Headers    map[string]*string        `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                    `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *DumpMetaListResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (DumpMetaListResponse) GoString

func (s DumpMetaListResponse) GoString() string

func (*DumpMetaListResponse) SetBody

func (*DumpMetaListResponse) SetHeaders

func (s *DumpMetaListResponse) SetHeaders(v map[string]*string) *DumpMetaListResponse

func (*DumpMetaListResponse) SetStatusCode

func (s *DumpMetaListResponse) SetStatusCode(v int32) *DumpMetaListResponse

func (DumpMetaListResponse) String

func (s DumpMetaListResponse) String() string

type DumpMetaListResponseBody

type DumpMetaListResponseBody struct {
	// The information about the task that is used to export metadata.
	Data *DumpMetaListResponseBodyData `json:"Data,omitempty" xml:"Data,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// B3137727-7D6E-488C-BA21-0E034C38A879
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
}

func (DumpMetaListResponseBody) GoString

func (s DumpMetaListResponseBody) GoString() string

func (*DumpMetaListResponseBody) SetData

func (*DumpMetaListResponseBody) SetRequestId

func (DumpMetaListResponseBody) String

func (s DumpMetaListResponseBody) String() string

type DumpMetaListResponseBodyData

type DumpMetaListResponseBodyData struct {
	// A list of tasks that are used to export metadata.
	DumpMetaList []*DumpMetaListResponseBodyDataDumpMetaList `json:"DumpMetaList,omitempty" xml:"DumpMetaList,omitempty" type:"Repeated"`
	// The number of the page to return.
	//
	// example:
	//
	// 1
	PageNumber *int32 `json:"PageNumber,omitempty" xml:"PageNumber,omitempty"`
	// The number of entries to return on each page.
	//
	// example:
	//
	// 10
	PageSize *int32 `json:"PageSize,omitempty" xml:"PageSize,omitempty"`
	// The total number of tasks.
	//
	// example:
	//
	// 15
	TotalCount *int64 `json:"TotalCount,omitempty" xml:"TotalCount,omitempty"`
}

func (DumpMetaListResponseBodyData) GoString

func (s DumpMetaListResponseBodyData) GoString() string

func (*DumpMetaListResponseBodyData) SetDumpMetaList

func (*DumpMetaListResponseBodyData) SetPageNumber

func (*DumpMetaListResponseBodyData) SetPageSize

func (*DumpMetaListResponseBodyData) SetTotalCount

func (DumpMetaListResponseBodyData) String

type DumpMetaListResponseBodyDataDumpMetaList

type DumpMetaListResponseBodyDataDumpMetaList struct {
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *string `json:"Code,omitempty" xml:"Code,omitempty"`
	// The ID of the task.
	//
	// example:
	//
	// 500
	Id *int64 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The address where you can download the metadata. The address is valid for 2 hours.
	//
	// example:
	//
	// https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx
	MetaUrl *string `json:"MetaUrl,omitempty" xml:"MetaUrl,omitempty"`
	// The error message returned.
	//
	// example:
	//
	// success
	Msg *string `json:"Msg,omitempty" xml:"Msg,omitempty"`
	// The status of the export task.
	//
	// 	- PROCESSING: in progress
	//
	// 	- FAIL: failed
	//
	// 	- SUCCESS: successful
	//
	// example:
	//
	// SUCCESS
	Status *string `json:"Status,omitempty" xml:"Status,omitempty"`
	// The time when the task was created. Unit: milliseconds.
	//
	// example:
	//
	// 1629095713000
	UtcCreate *string `json:"UtcCreate,omitempty" xml:"UtcCreate,omitempty"`
	// The time when the task was updated. Unit: milliseconds.
	//
	// example:
	//
	// 1629095760000
	UtcModified *int64 `json:"UtcModified,omitempty" xml:"UtcModified,omitempty"`
}

func (DumpMetaListResponseBodyDataDumpMetaList) GoString

func (*DumpMetaListResponseBodyDataDumpMetaList) SetCode

func (*DumpMetaListResponseBodyDataDumpMetaList) SetId

func (*DumpMetaListResponseBodyDataDumpMetaList) SetMetaUrl

func (*DumpMetaListResponseBodyDataDumpMetaList) SetMsg

func (*DumpMetaListResponseBodyDataDumpMetaList) SetStatus

func (*DumpMetaListResponseBodyDataDumpMetaList) SetUtcCreate

func (*DumpMetaListResponseBodyDataDumpMetaList) SetUtcModified

func (DumpMetaListResponseBodyDataDumpMetaList) String

type DumpMetaRequest

type DumpMetaRequest struct {
	// The name of the instance.
	//
	// This parameter is required.
	//
	// example:
	//
	// imagesearchName
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
}

func (DumpMetaRequest) GoString

func (s DumpMetaRequest) GoString() string

func (*DumpMetaRequest) SetInstanceName

func (s *DumpMetaRequest) SetInstanceName(v string) *DumpMetaRequest

func (DumpMetaRequest) String

func (s DumpMetaRequest) String() string

type DumpMetaResponse

type DumpMetaResponse struct {
	Headers    map[string]*string    `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *DumpMetaResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (DumpMetaResponse) GoString

func (s DumpMetaResponse) GoString() string

func (*DumpMetaResponse) SetBody

func (*DumpMetaResponse) SetHeaders

func (s *DumpMetaResponse) SetHeaders(v map[string]*string) *DumpMetaResponse

func (*DumpMetaResponse) SetStatusCode

func (s *DumpMetaResponse) SetStatusCode(v int32) *DumpMetaResponse

func (DumpMetaResponse) String

func (s DumpMetaResponse) String() string

type DumpMetaResponseBody

type DumpMetaResponseBody struct {
	// The information about the export task.
	Data *DumpMetaResponseBodyData `json:"Data,omitempty" xml:"Data,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (DumpMetaResponseBody) GoString

func (s DumpMetaResponseBody) GoString() string

func (*DumpMetaResponseBody) SetData

func (*DumpMetaResponseBody) SetRequestId

func (s *DumpMetaResponseBody) SetRequestId(v string) *DumpMetaResponseBody

func (*DumpMetaResponseBody) SetSuccess

func (DumpMetaResponseBody) String

func (s DumpMetaResponseBody) String() string

type DumpMetaResponseBodyData

type DumpMetaResponseBodyData struct {
	// The status of the export task.
	//
	// 	- PROCESSING: in progress
	//
	// 	- FAIL: failed
	//
	// 	- SUCCESS: successful
	//
	// example:
	//
	// PROCESSING
	DumpMetaStatus *string `json:"DumpMetaStatus,omitempty" xml:"DumpMetaStatus,omitempty"`
	// The ID of the export task.
	//
	// example:
	//
	// 500
	Id *string `json:"Id,omitempty" xml:"Id,omitempty"`
}

func (DumpMetaResponseBodyData) GoString

func (s DumpMetaResponseBodyData) GoString() string

func (*DumpMetaResponseBodyData) SetDumpMetaStatus

func (s *DumpMetaResponseBodyData) SetDumpMetaStatus(v string) *DumpMetaResponseBodyData

func (*DumpMetaResponseBodyData) SetId

func (DumpMetaResponseBodyData) String

func (s DumpMetaResponseBodyData) String() string

type IncreaseInstanceRequest

type IncreaseInstanceRequest struct {
	// The name of the Object Storage Service (OSS) bucket.
	//
	// >  The bucket must be in the same region as the Image Search instance.
	//
	// This parameter is required.
	//
	// example:
	//
	// bucketName
	BucketName *string `json:"BucketName,omitempty" xml:"BucketName,omitempty"`
	// The callback address.
	//
	// example:
	//
	// http://xxxxx
	CallbackAddress *string `json:"CallbackAddress,omitempty" xml:"CallbackAddress,omitempty"`
	// The name of the instance.
	//
	// This parameter is required.
	//
	// example:
	//
	// imagesearchName
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).
	//
	// This parameter is required.
	//
	// example:
	//
	// /xxx/xxx
	Path *string `json:"Path,omitempty" xml:"Path,omitempty"`
}

func (IncreaseInstanceRequest) GoString

func (s IncreaseInstanceRequest) GoString() string

func (*IncreaseInstanceRequest) SetBucketName

func (*IncreaseInstanceRequest) SetCallbackAddress

func (s *IncreaseInstanceRequest) SetCallbackAddress(v string) *IncreaseInstanceRequest

func (*IncreaseInstanceRequest) SetInstanceName

func (*IncreaseInstanceRequest) SetPath

func (IncreaseInstanceRequest) String

func (s IncreaseInstanceRequest) String() string

type IncreaseInstanceResponse

type IncreaseInstanceResponse struct {
	Headers    map[string]*string            `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                        `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *IncreaseInstanceResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (IncreaseInstanceResponse) GoString

func (s IncreaseInstanceResponse) GoString() string

func (*IncreaseInstanceResponse) SetBody

func (*IncreaseInstanceResponse) SetHeaders

func (*IncreaseInstanceResponse) SetStatusCode

func (IncreaseInstanceResponse) String

func (s IncreaseInstanceResponse) String() string

type IncreaseInstanceResponseBody

type IncreaseInstanceResponseBody struct {
	// The information about the task.
	Data *IncreaseInstanceResponseBodyData `json:"Data,omitempty" xml:"Data,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (IncreaseInstanceResponseBody) GoString

func (s IncreaseInstanceResponseBody) GoString() string

func (*IncreaseInstanceResponseBody) SetData

func (*IncreaseInstanceResponseBody) SetRequestId

func (*IncreaseInstanceResponseBody) SetSuccess

func (IncreaseInstanceResponseBody) String

type IncreaseInstanceResponseBodyData

type IncreaseInstanceResponseBodyData struct {
	// The ID of the task.
	//
	// example:
	//
	// 500
	Id *string `json:"Id,omitempty" xml:"Id,omitempty"`
	// The status of the task.
	//
	// 	- PROCESSING: in progress
	//
	// 	- FAIL: failed
	//
	// 	- SUCCESS: successful
	//
	// example:
	//
	// PROCESSING
	IncrementStatus *string `json:"IncrementStatus,omitempty" xml:"IncrementStatus,omitempty"`
}

func (IncreaseInstanceResponseBodyData) GoString

func (*IncreaseInstanceResponseBodyData) SetId

func (*IncreaseInstanceResponseBodyData) SetIncrementStatus

func (IncreaseInstanceResponseBodyData) String

type IncreaseListRequest

type IncreaseListRequest struct {
	// The name of the Object Storage Service (OSS) bucket.
	//
	// example:
	//
	// bucketName
	BucketName *string `json:"BucketName,omitempty" xml:"BucketName,omitempty"`
	// The ID of the batch task.
	//
	// example:
	//
	// 500
	Id *int64 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The number of the page to return. Default value: 1.
	//
	// example:
	//
	// 1
	PageNumber *int32 `json:"PageNumber,omitempty" xml:"PageNumber,omitempty"`
	// The number of images to return on each page. Default value: 10.
	//
	// example:
	//
	// 10
	PageSize *int32 `json:"PageSize,omitempty" xml:"PageSize,omitempty"`
	// The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).
	//
	// example:
	//
	// /xxx/xxx
	Path *string `json:"Path,omitempty" xml:"Path,omitempty"`
}

func (IncreaseListRequest) GoString

func (s IncreaseListRequest) GoString() string

func (*IncreaseListRequest) SetBucketName

func (s *IncreaseListRequest) SetBucketName(v string) *IncreaseListRequest

func (*IncreaseListRequest) SetId

func (*IncreaseListRequest) SetInstanceName

func (s *IncreaseListRequest) SetInstanceName(v string) *IncreaseListRequest

func (*IncreaseListRequest) SetPageNumber

func (s *IncreaseListRequest) SetPageNumber(v int32) *IncreaseListRequest

func (*IncreaseListRequest) SetPageSize

func (s *IncreaseListRequest) SetPageSize(v int32) *IncreaseListRequest

func (*IncreaseListRequest) SetPath

func (IncreaseListRequest) String

func (s IncreaseListRequest) String() string

type IncreaseListResponse

type IncreaseListResponse struct {
	Headers    map[string]*string        `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                    `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *IncreaseListResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (IncreaseListResponse) GoString

func (s IncreaseListResponse) GoString() string

func (*IncreaseListResponse) SetBody

func (*IncreaseListResponse) SetHeaders

func (s *IncreaseListResponse) SetHeaders(v map[string]*string) *IncreaseListResponse

func (*IncreaseListResponse) SetStatusCode

func (s *IncreaseListResponse) SetStatusCode(v int32) *IncreaseListResponse

func (IncreaseListResponse) String

func (s IncreaseListResponse) String() string

type IncreaseListResponseBody

type IncreaseListResponseBody struct {
	// The information about the batch task.
	Data *IncreaseListResponseBodyData `json:"Data,omitempty" xml:"Data,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// B3137727-7D6E-488C-BA21-0E034C38A879
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
}

func (IncreaseListResponseBody) GoString

func (s IncreaseListResponseBody) GoString() string

func (*IncreaseListResponseBody) SetData

func (*IncreaseListResponseBody) SetRequestId

func (IncreaseListResponseBody) String

func (s IncreaseListResponseBody) String() string

type IncreaseListResponseBodyData

type IncreaseListResponseBodyData struct {
	// A list of batch tasks.
	Increments *IncreaseListResponseBodyDataIncrements `json:"Increments,omitempty" xml:"Increments,omitempty" type:"Struct"`
	// The number of the page to return.
	//
	// example:
	//
	// 1
	PageNumber *int32 `json:"PageNumber,omitempty" xml:"PageNumber,omitempty"`
	// The number of entries to return on each page.
	//
	// example:
	//
	// 10
	PageSize *int32 `json:"PageSize,omitempty" xml:"PageSize,omitempty"`
	// The total number of tasks.
	//
	// example:
	//
	// 15
	TotalCount *int64 `json:"TotalCount,omitempty" xml:"TotalCount,omitempty"`
}

func (IncreaseListResponseBodyData) GoString

func (s IncreaseListResponseBodyData) GoString() string

func (*IncreaseListResponseBodyData) SetPageNumber

func (*IncreaseListResponseBodyData) SetPageSize

func (*IncreaseListResponseBodyData) SetTotalCount

func (IncreaseListResponseBodyData) String

type IncreaseListResponseBodyDataIncrements

type IncreaseListResponseBodyDataIncrements struct {
	Instance []*IncreaseListResponseBodyDataIncrementsInstance `json:"Instance,omitempty" xml:"Instance,omitempty" type:"Repeated"`
}

func (IncreaseListResponseBodyDataIncrements) GoString

func (IncreaseListResponseBodyDataIncrements) String

type IncreaseListResponseBodyDataIncrementsInstance

type IncreaseListResponseBodyDataIncrementsInstance struct {
	// The name of the Object Storage Service (OSS) bucket.
	//
	// example:
	//
	// bucketName
	BucketName *string `json:"BucketName,omitempty" xml:"BucketName,omitempty"`
	// The callback address.
	//
	// example:
	//
	// http://xxxxx
	CallbackAddress *string `json:"CallbackAddress,omitempty" xml:"CallbackAddress,omitempty"`
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *string `json:"Code,omitempty" xml:"Code,omitempty"`
	// The address where you can download the result. The address is valid for 2 hours.
	//
	// example:
	//
	// https://imagesearchname.oss-cn-shanghai.aliyuncs.com/xxx
	ErrorUrl *string `json:"ErrorUrl,omitempty" xml:"ErrorUrl,omitempty"`
	// The ID of the task.
	//
	// example:
	//
	// 500
	Id *int64 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The error message returned.
	//
	// example:
	//
	// sucess
	Msg *string `json:"Msg,omitempty" xml:"Msg,omitempty"`
	// The absolute path to the increment.meta file in the bucket. The path must start with a forward slash (/) and cannot end with a forward slash (/).
	//
	// example:
	//
	// /xx/xx
	Path *string `json:"Path,omitempty" xml:"Path,omitempty"`
	// The status of the batch task.
	//
	// 	- PROCESSING: in progress
	//
	// 	- FAIL: failed
	//
	// 	- SUCCESS: successful
	//
	// example:
	//
	// SUCCESS
	Status *string `json:"Status,omitempty" xml:"Status,omitempty"`
	// The time when the task was created. Unit: milliseconds.
	//
	// example:
	//
	// 1629095713000
	UtcCreate *string `json:"UtcCreate,omitempty" xml:"UtcCreate,omitempty"`
	// The time when the task was updated. Unit: milliseconds.
	//
	// example:
	//
	// 1629095760000
	UtcModified *int64 `json:"UtcModified,omitempty" xml:"UtcModified,omitempty"`
}

func (IncreaseListResponseBodyDataIncrementsInstance) GoString

func (*IncreaseListResponseBodyDataIncrementsInstance) SetBucketName

func (*IncreaseListResponseBodyDataIncrementsInstance) SetCallbackAddress

func (*IncreaseListResponseBodyDataIncrementsInstance) SetCode

func (*IncreaseListResponseBodyDataIncrementsInstance) SetErrorUrl

func (*IncreaseListResponseBodyDataIncrementsInstance) SetId

func (*IncreaseListResponseBodyDataIncrementsInstance) SetMsg

func (*IncreaseListResponseBodyDataIncrementsInstance) SetPath

func (*IncreaseListResponseBodyDataIncrementsInstance) SetStatus

func (*IncreaseListResponseBodyDataIncrementsInstance) SetUtcCreate

func (*IncreaseListResponseBodyDataIncrementsInstance) SetUtcModified

func (IncreaseListResponseBodyDataIncrementsInstance) String

type SearchImageByNameRequest

type SearchImageByNameRequest struct {
	// The category of the product. For more information, see [Category references](https://help.aliyun.com/document_detail/179184.html).
	//
	// 	- For product search: If a category is specified, the specified category prevails. If no category is specified, the system estimates and selects a category. The category selected by the system is included in the response.
	//
	// 	- For generic search: The parameter value is set to 88888888 regardless of whether a category is specified.
	//
	// example:
	//
	// 88888888
	CategoryId        *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	DistinctProductId *bool  `json:"DistinctProductId,omitempty" xml:"DistinctProductId,omitempty"`
	// The filter conditions. int_attr supports the following operators: >, >=, <, <=, and =. str_attr supports the following operators: = and !=. You can set the logical operator between conditions to AND or OR.
	//
	// Examples:
	//
	// 	- int_attr>=100
	//
	// 	- str_attr!="value1"
	//
	// 	- int_attr=1000 AND str_attr="value1"
	//
	// example:
	//
	// int_attr>=100
	Filter *string `json:"Filter,omitempty" xml:"Filter,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The number of images to return on each page. Valid values: 1 to 100. Default value: 10.
	//
	// example:
	//
	// 10
	Num *int32 `json:"Num,omitempty" xml:"Num,omitempty"`
	// The name of the image.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The number of the image to return. Valid values: 0 to 499. Default value: 0.
	//
	// example:
	//
	// 0
	Start *int32 `json:"Start,omitempty" xml:"Start,omitempty"`
}

func (SearchImageByNameRequest) GoString

func (s SearchImageByNameRequest) GoString() string

func (*SearchImageByNameRequest) SetCategoryId

func (*SearchImageByNameRequest) SetDistinctProductId added in v4.1.0

func (s *SearchImageByNameRequest) SetDistinctProductId(v bool) *SearchImageByNameRequest

func (*SearchImageByNameRequest) SetFilter

func (*SearchImageByNameRequest) SetInstanceName

func (*SearchImageByNameRequest) SetNum

func (*SearchImageByNameRequest) SetPicName

func (*SearchImageByNameRequest) SetProductId

func (*SearchImageByNameRequest) SetStart

func (SearchImageByNameRequest) String

func (s SearchImageByNameRequest) String() string

type SearchImageByNameResponse

type SearchImageByNameResponse struct {
	Headers    map[string]*string             `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                         `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *SearchImageByNameResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (SearchImageByNameResponse) GoString

func (s SearchImageByNameResponse) GoString() string

func (*SearchImageByNameResponse) SetBody

func (*SearchImageByNameResponse) SetHeaders

func (*SearchImageByNameResponse) SetStatusCode

func (SearchImageByNameResponse) String

func (s SearchImageByNameResponse) String() string

type SearchImageByNameResponseBody

type SearchImageByNameResponseBody struct {
	// The product descriptions returned.
	Auctions []*SearchImageByNameResponseBodyAuctions `json:"Auctions,omitempty" xml:"Auctions,omitempty" type:"Repeated"`
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// The summary of the search result.
	Head *SearchImageByNameResponseBodyHead `json:"Head,omitempty" xml:"Head,omitempty" type:"Struct"`
	// The error message returned.
	//
	// example:
	//
	// success
	Msg *string `json:"Msg,omitempty" xml:"Msg,omitempty"`
	// The information such as the system-selected category and result of subject recognition.
	PicInfo *SearchImageByNameResponseBodyPicInfo `json:"PicInfo,omitempty" xml:"PicInfo,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// 36C43E96-8F68-44AA-B1AF-B1F7AB94A6C1
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (SearchImageByNameResponseBody) GoString

func (*SearchImageByNameResponseBody) SetAuctions

func (*SearchImageByNameResponseBody) SetCode

func (*SearchImageByNameResponseBody) SetHead

func (*SearchImageByNameResponseBody) SetMsg

func (*SearchImageByNameResponseBody) SetRequestId

func (*SearchImageByNameResponseBody) SetSuccess

func (SearchImageByNameResponseBody) String

type SearchImageByNameResponseBodyAuctions

type SearchImageByNameResponseBodyAuctions struct {
	// The category of the image.
	//
	// example:
	//
	// 20
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// The user-defined content.
	//
	// example:
	//
	// zidingyi
	CustomContent *string `json:"CustomContent,omitempty" xml:"CustomContent,omitempty"`
	// The attribute, which is an integer.
	//
	// example:
	//
	// 2
	IntAttr *int32 `json:"IntAttr,omitempty" xml:"IntAttr,omitempty"`
	// example:
	//
	// 20
	IntAttr2 *int32 `json:"IntAttr2,omitempty" xml:"IntAttr2,omitempty"`
	IntAttr3 *int32 `json:"IntAttr3,omitempty" xml:"IntAttr3,omitempty"`
	IntAttr4 *int32 `json:"IntAttr4,omitempty" xml:"IntAttr4,omitempty"`
	// The name of the image.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The similarity score of the returned image. Valid values: 0 to 1.
	//
	// >  To use this feature, you must upgrade the SDK to version 3.1.1.
	//
	// example:
	//
	// 1
	Score *float32 `json:"Score,omitempty" xml:"Score,omitempty"`
	// The score information about the image.
	//
	// > 	- This parameter is not supported. We recommend that you use the Score parameter.
	//
	// >	- The SortExprValues parameter indicates a 2-tuple in which values are separated by a semicolon (;). The first value indicates the correlation score of the returned image. A greater value indicates a higher correlation with the sample image. Different algorithms are used.
	//
	// >	- If the value of CategoryId is within the value range from 0 to 2, the value range of SortExprValues is from 0 to 7.33136443711219e+24.
	//
	// >	- If the value of CategoryId is not within the value range from 0 to 2, the value range of SortExprValues is from 0 to 5.37633353624177e+24. If the returned image is identical with the sample image, the highest correlation score is generated.
	//
	// example:
	//
	// 5.37633353624177e+24;0
	SortExprValues *string `json:"SortExprValues,omitempty" xml:"SortExprValues,omitempty"`
	// The attribute, which is a string.
	//
	// example:
	//
	// ss
	StrAttr *string `json:"StrAttr,omitempty" xml:"StrAttr,omitempty"`
	// example:
	//
	// test
	StrAttr2 *string `json:"StrAttr2,omitempty" xml:"StrAttr2,omitempty"`
	StrAttr3 *string `json:"StrAttr3,omitempty" xml:"StrAttr3,omitempty"`
	StrAttr4 *string `json:"StrAttr4,omitempty" xml:"StrAttr4,omitempty"`
}

func (SearchImageByNameResponseBodyAuctions) GoString

func (*SearchImageByNameResponseBodyAuctions) SetCategoryId

func (*SearchImageByNameResponseBodyAuctions) SetCustomContent

func (*SearchImageByNameResponseBodyAuctions) SetIntAttr

func (*SearchImageByNameResponseBodyAuctions) SetIntAttr2 added in v4.0.2

func (*SearchImageByNameResponseBodyAuctions) SetIntAttr3 added in v4.1.0

func (*SearchImageByNameResponseBodyAuctions) SetIntAttr4 added in v4.1.0

func (*SearchImageByNameResponseBodyAuctions) SetPicName

func (*SearchImageByNameResponseBodyAuctions) SetProductId

func (*SearchImageByNameResponseBodyAuctions) SetScore

func (*SearchImageByNameResponseBodyAuctions) SetSortExprValues

func (*SearchImageByNameResponseBodyAuctions) SetStrAttr

func (*SearchImageByNameResponseBodyAuctions) SetStrAttr2 added in v4.0.2

func (*SearchImageByNameResponseBodyAuctions) SetStrAttr3 added in v4.1.0

func (*SearchImageByNameResponseBodyAuctions) SetStrAttr4 added in v4.1.0

func (SearchImageByNameResponseBodyAuctions) String

type SearchImageByNameResponseBodyHead

type SearchImageByNameResponseBodyHead struct {
	// The number of images returned.
	//
	// example:
	//
	// 10
	DocsFound *int32 `json:"DocsFound,omitempty" xml:"DocsFound,omitempty"`
	// The number of images that match the search conditions on the Image Search instance.
	//
	// example:
	//
	// 10000
	DocsReturn *int32 `json:"DocsReturn,omitempty" xml:"DocsReturn,omitempty"`
	// The time it takes to complete the search process. Unit: milliseconds.
	//
	// example:
	//
	// 95
	SearchTime *int32 `json:"SearchTime,omitempty" xml:"SearchTime,omitempty"`
}

func (SearchImageByNameResponseBodyHead) GoString

func (*SearchImageByNameResponseBodyHead) SetDocsFound

func (*SearchImageByNameResponseBodyHead) SetDocsReturn

func (*SearchImageByNameResponseBodyHead) SetSearchTime

func (SearchImageByNameResponseBodyHead) String

type SearchImageByNameResponseBodyPicInfo

type SearchImageByNameResponseBodyPicInfo struct {
	// The categories that are supported by the system.
	AllCategories []*SearchImageByNameResponseBodyPicInfoAllCategories `json:"AllCategories,omitempty" xml:"AllCategories,omitempty" type:"Repeated"`
	// The category selected by the system.
	//
	// If a category is specified in the request, the specified category prevails.
	//
	// example:
	//
	// 20
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// The recognized subjects.
	MultiRegion []*SearchImageByNameResponseBodyPicInfoMultiRegion `json:"MultiRegion,omitempty" xml:"MultiRegion,omitempty" type:"Repeated"`
	// The result of subject recognition.
	//
	// The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
}

func (SearchImageByNameResponseBodyPicInfo) GoString

func (*SearchImageByNameResponseBodyPicInfo) SetCategoryId

func (*SearchImageByNameResponseBodyPicInfo) SetRegion

func (SearchImageByNameResponseBodyPicInfo) String

type SearchImageByNameResponseBodyPicInfoAllCategories

type SearchImageByNameResponseBodyPicInfoAllCategories struct {
	// The ID of the category.
	//
	// example:
	//
	// other
	Id *int32 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The name of the category.
	//
	// example:
	//
	// 88888888
	Name *string `json:"Name,omitempty" xml:"Name,omitempty"`
}

func (SearchImageByNameResponseBodyPicInfoAllCategories) GoString

func (*SearchImageByNameResponseBodyPicInfoAllCategories) SetId

func (*SearchImageByNameResponseBodyPicInfoAllCategories) SetName

func (SearchImageByNameResponseBodyPicInfoAllCategories) String

type SearchImageByNameResponseBodyPicInfoMultiRegion

type SearchImageByNameResponseBodyPicInfoMultiRegion struct {
	// The result of subject recognition.
	//
	// The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
}

func (SearchImageByNameResponseBodyPicInfoMultiRegion) GoString

func (*SearchImageByNameResponseBodyPicInfoMultiRegion) SetRegion

func (SearchImageByNameResponseBodyPicInfoMultiRegion) String

type SearchImageByPicAdvanceRequest

type SearchImageByPicAdvanceRequest struct {
	// The category of the product. For more information, see [Category references](https://help.aliyun.com/document_detail/179184.html).
	//
	// 	- For product search: If a category is specified, the specified category prevails. If no category is specified, the system estimates and selects a category. The category selected by the system is included in the response.
	//
	// 	- For generic search: The parameter value is set to 88888888 regardless of whether a category is specified.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// Specifies whether to recognize the subject in the image and search for images based on the recognized subject. Valid values: true and false. Default value: true.
	//
	// 	- true: The system recognizes the subject in the image, and searches for images based on the recognized subject. The recognition result is included in the response.
	//
	// 	- false: The system does not recognize the subject of the image, and searches for images based on the entire image.
	//
	// example:
	//
	// true
	Crop              *bool `json:"Crop,omitempty" xml:"Crop,omitempty"`
	DistinctProductId *bool `json:"DistinctProductId,omitempty" xml:"DistinctProductId,omitempty"`
	// The filter conditions. int_attr supports the following operators: >, >=, <, <=, and =. str_attr supports the following operators: = and !=. You can set the logical operator between conditions to AND or OR.
	//
	// Examples:
	//
	// 	- int_attr>=100
	//
	// 	- str_attr!="value1"
	//
	// 	- Example: int_attr=1000 AND str_attr="value1"
	//
	// example:
	//
	// int_attr=1000 AND str_attr="value1"
	Filter *string `json:"Filter,omitempty" xml:"Filter,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The number of images to return on each page. Valid values: 1 to 100. Default value: 10.
	//
	// example:
	//
	// 10
	Num *int32 `json:"Num,omitempty" xml:"Num,omitempty"`
	// The image file. The image file is encoded in Base64.
	//
	// 	- The file size of the image cannot exceed 4 MB.
	//
	// 	- The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.
	//
	// 	- The transmission timeout period cannot exceed 5 seconds.
	//
	// 	- For brand image searches, the length and the width of the image must range from 200 pixels to 4,096 pixels.
	//
	// 	- For cloth image searches, the length and the width of the image must range from 448 pixels to 4,096 pixels.
	//
	// 	- For product and generic image searches, the length and the width of the image must range from 100 pixels to 4,096 pixels.
	//
	// 	- The image cannot contain rotation settings.
	//
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PicContentObject io.Reader `json:"PicContent,omitempty" xml:"PicContent,omitempty"`
	// The subject area of the image. Specify the subject area in the following format: `x1,x2,y1,y2`. `x1 and y1` represent the upper-left corner pixel. `x2 and y2` represent the lower-right corner pixel.
	//
	// >	- If you set the Region parameter, the system searches for images based on the value of Region regardless of the value of the Crop parameter.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
	// The number of the image to return. Valid values: 0 to 499. Default value: 0.
	//
	// example:
	//
	// 0
	Start *int32 `json:"Start,omitempty" xml:"Start,omitempty"`
}

func (SearchImageByPicAdvanceRequest) GoString

func (*SearchImageByPicAdvanceRequest) SetCategoryId

func (*SearchImageByPicAdvanceRequest) SetCrop

func (*SearchImageByPicAdvanceRequest) SetDistinctProductId added in v4.1.0

func (*SearchImageByPicAdvanceRequest) SetFilter

func (*SearchImageByPicAdvanceRequest) SetInstanceName

func (*SearchImageByPicAdvanceRequest) SetNum

func (*SearchImageByPicAdvanceRequest) SetPicContentObject

func (*SearchImageByPicAdvanceRequest) SetRegion

func (*SearchImageByPicAdvanceRequest) SetStart

func (SearchImageByPicAdvanceRequest) String

type SearchImageByPicRequest

type SearchImageByPicRequest struct {
	// The category of the product. For more information, see [Category references](https://help.aliyun.com/document_detail/179184.html).
	//
	// 	- For product search: If a category is specified, the specified category prevails. If no category is specified, the system estimates and selects a category. The category selected by the system is included in the response.
	//
	// 	- For generic search: The parameter value is set to 88888888 regardless of whether a category is specified.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// Specifies whether to recognize the subject in the image and search for images based on the recognized subject. Valid values: true and false. Default value: true.
	//
	// 	- true: The system recognizes the subject in the image, and searches for images based on the recognized subject. The recognition result is included in the response.
	//
	// 	- false: The system does not recognize the subject of the image, and searches for images based on the entire image.
	//
	// example:
	//
	// true
	Crop              *bool `json:"Crop,omitempty" xml:"Crop,omitempty"`
	DistinctProductId *bool `json:"DistinctProductId,omitempty" xml:"DistinctProductId,omitempty"`
	// The filter conditions. int_attr supports the following operators: >, >=, <, <=, and =. str_attr supports the following operators: = and !=. You can set the logical operator between conditions to AND or OR.
	//
	// Examples:
	//
	// 	- int_attr>=100
	//
	// 	- str_attr!="value1"
	//
	// 	- Example: int_attr=1000 AND str_attr="value1"
	//
	// example:
	//
	// int_attr=1000 AND str_attr="value1"
	Filter *string `json:"Filter,omitempty" xml:"Filter,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The number of images to return on each page. Valid values: 1 to 100. Default value: 10.
	//
	// example:
	//
	// 10
	Num *int32 `json:"Num,omitempty" xml:"Num,omitempty"`
	// The image file. The image file is encoded in Base64.
	//
	// 	- The file size of the image cannot exceed 4 MB.
	//
	// 	- The following image formats are supported: PNG, JPG, JPEG, BMP, GIF, WebP, TIFF, and PPM.
	//
	// 	- The transmission timeout period cannot exceed 5 seconds.
	//
	// 	- For brand image searches, the length and the width of the image must range from 200 pixels to 4,096 pixels.
	//
	// 	- For cloth image searches, the length and the width of the image must range from 448 pixels to 4,096 pixels.
	//
	// 	- For product and generic image searches, the length and the width of the image must range from 100 pixels to 4,096 pixels.
	//
	// 	- The image cannot contain rotation settings.
	//
	// This parameter is required.
	//
	// example:
	//
	// AAAANSUhEUgAAAPcAAAEVCAYAAAA8d3NuAAAAAXNSR0IArs......RK5CYII=
	PicContent *string `json:"PicContent,omitempty" xml:"PicContent,omitempty"`
	// The subject area of the image. Specify the subject area in the following format: `x1,x2,y1,y2`. `x1 and y1` represent the upper-left corner pixel. `x2 and y2` represent the lower-right corner pixel.
	//
	// >	- If you set the Region parameter, the system searches for images based on the value of Region regardless of the value of the Crop parameter.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
	// The number of the image to return. Valid values: 0 to 499. Default value: 0.
	//
	// example:
	//
	// 0
	Start *int32 `json:"Start,omitempty" xml:"Start,omitempty"`
}

func (SearchImageByPicRequest) GoString

func (s SearchImageByPicRequest) GoString() string

func (*SearchImageByPicRequest) SetCategoryId

func (*SearchImageByPicRequest) SetCrop

func (*SearchImageByPicRequest) SetDistinctProductId added in v4.1.0

func (s *SearchImageByPicRequest) SetDistinctProductId(v bool) *SearchImageByPicRequest

func (*SearchImageByPicRequest) SetFilter

func (*SearchImageByPicRequest) SetInstanceName

func (*SearchImageByPicRequest) SetNum

func (*SearchImageByPicRequest) SetPicContent

func (*SearchImageByPicRequest) SetRegion

func (*SearchImageByPicRequest) SetStart

func (SearchImageByPicRequest) String

func (s SearchImageByPicRequest) String() string

type SearchImageByPicResponse

type SearchImageByPicResponse struct {
	Headers    map[string]*string            `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                        `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *SearchImageByPicResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (SearchImageByPicResponse) GoString

func (s SearchImageByPicResponse) GoString() string

func (*SearchImageByPicResponse) SetBody

func (*SearchImageByPicResponse) SetHeaders

func (*SearchImageByPicResponse) SetStatusCode

func (SearchImageByPicResponse) String

func (s SearchImageByPicResponse) String() string

type SearchImageByPicResponseBody

type SearchImageByPicResponseBody struct {
	// The product descriptions returned.
	Auctions []*SearchImageByPicResponseBodyAuctions `json:"Auctions,omitempty" xml:"Auctions,omitempty" type:"Repeated"`
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// The summary of the search result.
	Head *SearchImageByPicResponseBodyHead `json:"Head,omitempty" xml:"Head,omitempty" type:"Struct"`
	// The error message returned.
	//
	// example:
	//
	// success
	Msg *string `json:"Msg,omitempty" xml:"Msg,omitempty"`
	// The information such as the system-selected category and result of subject recognition.
	PicInfo *SearchImageByPicResponseBodyPicInfo `json:"PicInfo,omitempty" xml:"PicInfo,omitempty" type:"Struct"`
	// The ID of the request.
	//
	// example:
	//
	// B3137727-7D6E-488C-BA21-0E034C38A879
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (SearchImageByPicResponseBody) GoString

func (s SearchImageByPicResponseBody) GoString() string

func (*SearchImageByPicResponseBody) SetAuctions

func (*SearchImageByPicResponseBody) SetCode

func (*SearchImageByPicResponseBody) SetHead

func (*SearchImageByPicResponseBody) SetMsg

func (*SearchImageByPicResponseBody) SetPicInfo

func (*SearchImageByPicResponseBody) SetRequestId

func (*SearchImageByPicResponseBody) SetSuccess

func (SearchImageByPicResponseBody) String

type SearchImageByPicResponseBodyAuctions

type SearchImageByPicResponseBodyAuctions struct {
	// The category of the image.
	//
	// example:
	//
	// 8888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// The user-defined content.
	//
	// example:
	//
	// zidingyi
	CustomContent *string `json:"CustomContent,omitempty" xml:"CustomContent,omitempty"`
	// The attribute, which is an integer.
	//
	// example:
	//
	// 2
	IntAttr *int32 `json:"IntAttr,omitempty" xml:"IntAttr,omitempty"`
	// example:
	//
	// 20
	IntAttr2 *int32 `json:"IntAttr2,omitempty" xml:"IntAttr2,omitempty"`
	IntAttr3 *int32 `json:"IntAttr3,omitempty" xml:"IntAttr3,omitempty"`
	IntAttr4 *int32 `json:"IntAttr4,omitempty" xml:"IntAttr4,omitempty"`
	// The name of the image.
	//
	// example:
	//
	// 2092061_1.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The similarity score of the searched image. Valid values: 0 to 1.
	//
	// >  To use this feature, you must upgrade the SDK to version 3.1.1.
	//
	// example:
	//
	// 1
	Score *float32 `json:"Score,omitempty" xml:"Score,omitempty"`
	// The score information about the image.
	//
	// > 	- This parameter is not supported. We recommend that you use the Score parameter.
	//
	// >	- The SortExprValues parameter indicates a 2-tuple in which values are separated by a semicolon (;). The first value indicates the correlation score of the returned image. A greater value indicates a higher correlation with the sample image. Different algorithms are used.
	//
	// >	- If the value of CategoryId is within the value range from 0 to 2, the value range of SortExprValues is from 0 to 7.33136443711219e+24.
	//
	// >	- If the value of CategoryId is not within the value range from 0 to 2, the value range of SortExprValues is from 0 to 5.37633353624177e+24. If the returned image is identical with the sample image, the highest correlation score is generated.
	//
	// example:
	//
	// 5.37633353624177e+24;0
	SortExprValues *string `json:"SortExprValues,omitempty" xml:"SortExprValues,omitempty"`
	// The attribute, which is a string.
	//
	// example:
	//
	// 2
	StrAttr *string `json:"StrAttr,omitempty" xml:"StrAttr,omitempty"`
	// example:
	//
	// test
	StrAttr2 *string `json:"StrAttr2,omitempty" xml:"StrAttr2,omitempty"`
	StrAttr3 *string `json:"StrAttr3,omitempty" xml:"StrAttr3,omitempty"`
	StrAttr4 *string `json:"StrAttr4,omitempty" xml:"StrAttr4,omitempty"`
}

func (SearchImageByPicResponseBodyAuctions) GoString

func (*SearchImageByPicResponseBodyAuctions) SetCategoryId

func (*SearchImageByPicResponseBodyAuctions) SetCustomContent

func (*SearchImageByPicResponseBodyAuctions) SetIntAttr

func (*SearchImageByPicResponseBodyAuctions) SetIntAttr2 added in v4.0.2

func (*SearchImageByPicResponseBodyAuctions) SetIntAttr3 added in v4.1.0

func (*SearchImageByPicResponseBodyAuctions) SetIntAttr4 added in v4.1.0

func (*SearchImageByPicResponseBodyAuctions) SetPicName

func (*SearchImageByPicResponseBodyAuctions) SetProductId

func (*SearchImageByPicResponseBodyAuctions) SetScore

func (*SearchImageByPicResponseBodyAuctions) SetSortExprValues

func (*SearchImageByPicResponseBodyAuctions) SetStrAttr

func (*SearchImageByPicResponseBodyAuctions) SetStrAttr2 added in v4.0.2

func (*SearchImageByPicResponseBodyAuctions) SetStrAttr3 added in v4.1.0

func (*SearchImageByPicResponseBodyAuctions) SetStrAttr4 added in v4.1.0

func (SearchImageByPicResponseBodyAuctions) String

type SearchImageByPicResponseBodyHead

type SearchImageByPicResponseBodyHead struct {
	// The number of images returned.
	//
	// example:
	//
	// 10
	DocsFound *int32 `json:"DocsFound,omitempty" xml:"DocsFound,omitempty"`
	// The number of images that match the search conditions on the Image Search instance.
	//
	// example:
	//
	// 10000
	DocsReturn *int32 `json:"DocsReturn,omitempty" xml:"DocsReturn,omitempty"`
	// The time it takes to complete the search process. Unit: milliseconds.
	//
	// example:
	//
	// 95
	SearchTime *int32 `json:"SearchTime,omitempty" xml:"SearchTime,omitempty"`
}

func (SearchImageByPicResponseBodyHead) GoString

func (*SearchImageByPicResponseBodyHead) SetDocsFound

func (*SearchImageByPicResponseBodyHead) SetDocsReturn

func (*SearchImageByPicResponseBodyHead) SetSearchTime

func (SearchImageByPicResponseBodyHead) String

type SearchImageByPicResponseBodyPicInfo

type SearchImageByPicResponseBodyPicInfo struct {
	// The categories that are supported by the system.
	AllCategories []*SearchImageByPicResponseBodyPicInfoAllCategories `json:"AllCategories,omitempty" xml:"AllCategories,omitempty" type:"Repeated"`
	// The category selected by the system. If a category is specified in the request, the specified category prevails.
	//
	// example:
	//
	// 88888888
	CategoryId *int32 `json:"CategoryId,omitempty" xml:"CategoryId,omitempty"`
	// The recognized subjects.
	//
	// >  To use this feature, you must upgrade the SDK to version 3.1.1.
	MultiRegion []*SearchImageByPicResponseBodyPicInfoMultiRegion `json:"MultiRegion,omitempty" xml:"MultiRegion,omitempty" type:"Repeated"`
	// The result of subject recognition. The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
}

func (SearchImageByPicResponseBodyPicInfo) GoString

func (*SearchImageByPicResponseBodyPicInfo) SetCategoryId

func (*SearchImageByPicResponseBodyPicInfo) SetRegion

func (SearchImageByPicResponseBodyPicInfo) String

type SearchImageByPicResponseBodyPicInfoAllCategories

type SearchImageByPicResponseBodyPicInfoAllCategories struct {
	// The ID of the category.
	//
	// example:
	//
	// 88888888
	Id *int32 `json:"Id,omitempty" xml:"Id,omitempty"`
	// The name of the category.
	//
	// example:
	//
	// other
	Name *string `json:"Name,omitempty" xml:"Name,omitempty"`
}

func (SearchImageByPicResponseBodyPicInfoAllCategories) GoString

func (*SearchImageByPicResponseBodyPicInfoAllCategories) SetId

func (*SearchImageByPicResponseBodyPicInfoAllCategories) SetName

func (SearchImageByPicResponseBodyPicInfoAllCategories) String

type SearchImageByPicResponseBodyPicInfoMultiRegion

type SearchImageByPicResponseBodyPicInfoMultiRegion struct {
	// The result of subject recognition. The subject area of the image, in the format of x1,x2,y1,y2. Specifically, x1 and y1 specify the upper-left pixel, and x2 and y2 specify the lower-right pixel. If a subject area is specified in the request, the specified subject area prevails.
	//
	// example:
	//
	// 280,486,232,351
	Region *string `json:"Region,omitempty" xml:"Region,omitempty"`
}

func (SearchImageByPicResponseBodyPicInfoMultiRegion) GoString

func (*SearchImageByPicResponseBodyPicInfoMultiRegion) SetRegion

func (SearchImageByPicResponseBodyPicInfoMultiRegion) String

type UpdateImageRequest

type UpdateImageRequest struct {
	// The user-defined content. The value can be up to 4,096 characters in length.
	//
	// >  If you set this parameter, the response includes this parameter and its value. You can add text such as an image description.
	//
	// example:
	//
	// zidingyi
	CustomContent *string `json:"CustomContent,omitempty" xml:"CustomContent,omitempty"`
	// The name of the Image Search instance. The name can be up to 20 characters in length.
	//
	// This parameter is required.
	//
	// example:
	//
	// demoinstance1
	InstanceName *string `json:"InstanceName,omitempty" xml:"InstanceName,omitempty"`
	// The attribute, which is an integer. The attribute can be used to filter images when you search for images. If you set this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// 2
	IntAttr *int32 `json:"IntAttr,omitempty" xml:"IntAttr,omitempty"`
	// example:
	//
	// 20
	IntAttr2 *int32 `json:"IntAttr2,omitempty" xml:"IntAttr2,omitempty"`
	IntAttr3 *int32 `json:"IntAttr3,omitempty" xml:"IntAttr3,omitempty"`
	IntAttr4 *int32 `json:"IntAttr4,omitempty" xml:"IntAttr4,omitempty"`
	// The name of the image. The name can be up to 512 characters in length.
	//
	// > 	- An image is uniquely identified by the values of the ProductId and PicName parameters.
	//
	// >	- If you add an image whose product ID (ProductId) and image name (PicName) are the same as those of an existing image, the newly added image overwrites the existing image.
	//
	// This parameter is required.
	//
	// example:
	//
	// namexxx.jpg
	PicName *string `json:"PicName,omitempty" xml:"PicName,omitempty"`
	// The ID of the product. The ID can be up to 512 characters in length.
	//
	// >  A product may have multiple images.
	//
	// This parameter is required.
	//
	// example:
	//
	// 2092061_1
	ProductId *string `json:"ProductId,omitempty" xml:"ProductId,omitempty"`
	// The attribute, which is a string. The value can be up to 128 characters in length. The attribute can be used to filter images. If you set this parameter, the response includes this parameter and its value.
	//
	// example:
	//
	// ss
	StrAttr *string `json:"StrAttr,omitempty" xml:"StrAttr,omitempty"`
	// example:
	//
	// test
	StrAttr2 *string `json:"StrAttr2,omitempty" xml:"StrAttr2,omitempty"`
	StrAttr3 *string `json:"StrAttr3,omitempty" xml:"StrAttr3,omitempty"`
	StrAttr4 *string `json:"StrAttr4,omitempty" xml:"StrAttr4,omitempty"`
}

func (UpdateImageRequest) GoString

func (s UpdateImageRequest) GoString() string

func (*UpdateImageRequest) SetCustomContent

func (s *UpdateImageRequest) SetCustomContent(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetInstanceName

func (s *UpdateImageRequest) SetInstanceName(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetIntAttr

func (s *UpdateImageRequest) SetIntAttr(v int32) *UpdateImageRequest

func (*UpdateImageRequest) SetIntAttr2 added in v4.0.2

func (s *UpdateImageRequest) SetIntAttr2(v int32) *UpdateImageRequest

func (*UpdateImageRequest) SetIntAttr3 added in v4.1.0

func (s *UpdateImageRequest) SetIntAttr3(v int32) *UpdateImageRequest

func (*UpdateImageRequest) SetIntAttr4 added in v4.1.0

func (s *UpdateImageRequest) SetIntAttr4(v int32) *UpdateImageRequest

func (*UpdateImageRequest) SetPicName

func (s *UpdateImageRequest) SetPicName(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetProductId

func (s *UpdateImageRequest) SetProductId(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetStrAttr

func (s *UpdateImageRequest) SetStrAttr(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetStrAttr2 added in v4.0.2

func (s *UpdateImageRequest) SetStrAttr2(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetStrAttr3 added in v4.1.0

func (s *UpdateImageRequest) SetStrAttr3(v string) *UpdateImageRequest

func (*UpdateImageRequest) SetStrAttr4 added in v4.1.0

func (s *UpdateImageRequest) SetStrAttr4(v string) *UpdateImageRequest

func (UpdateImageRequest) String

func (s UpdateImageRequest) String() string

type UpdateImageResponse

type UpdateImageResponse struct {
	Headers    map[string]*string       `json:"headers,omitempty" xml:"headers,omitempty"`
	StatusCode *int32                   `json:"statusCode,omitempty" xml:"statusCode,omitempty"`
	Body       *UpdateImageResponseBody `json:"body,omitempty" xml:"body,omitempty"`
}

func (UpdateImageResponse) GoString

func (s UpdateImageResponse) GoString() string

func (*UpdateImageResponse) SetBody

func (*UpdateImageResponse) SetHeaders

func (s *UpdateImageResponse) SetHeaders(v map[string]*string) *UpdateImageResponse

func (*UpdateImageResponse) SetStatusCode

func (s *UpdateImageResponse) SetStatusCode(v int32) *UpdateImageResponse

func (UpdateImageResponse) String

func (s UpdateImageResponse) String() string

type UpdateImageResponseBody

type UpdateImageResponseBody struct {
	// The error code returned.
	//
	// 	- A value of 0 indicates that the operation is successful.
	//
	// 	- Values other than 0 indicate errors.
	//
	// example:
	//
	// 0
	Code *int32 `json:"Code,omitempty" xml:"Code,omitempty"`
	// Id of the request
	//
	// example:
	//
	// success
	Message *string `json:"Message,omitempty" xml:"Message,omitempty"`
	// The ID of the request.
	//
	// example:
	//
	// E0845DE6-52AF-4B50-9F15-51ED4044E6AB
	RequestId *string `json:"RequestId,omitempty" xml:"RequestId,omitempty"`
	// Indicates whether the request is successful.
	//
	// example:
	//
	// true
	Success *bool `json:"Success,omitempty" xml:"Success,omitempty"`
}

func (UpdateImageResponseBody) GoString

func (s UpdateImageResponseBody) GoString() string

func (*UpdateImageResponseBody) SetCode

func (*UpdateImageResponseBody) SetMessage

func (*UpdateImageResponseBody) SetRequestId

func (*UpdateImageResponseBody) SetSuccess

func (UpdateImageResponseBody) String

func (s UpdateImageResponseBody) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL