Use DescribeBaseExperiment to retrieve base experiment details - Artificial Intelligence Recommendation

Retrieves the base experiment.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /v2/openapi/instances/{instanceId}/scenes/{sceneId}/base-experiment HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	airec-cn-****
sceneId	string	Yes	The scene ID.	sceneId

Response elements

Element	Type	Description	Example
	object	The response parameters.
result	object	The response parameters.
base	boolean	Indicates whether the experiment is the default experiment.	true
onlineTime	string	The time when the experiment was published.	2020-12-07T06:47:30.000Z
offlineTime	string	The time when the experiment was unpublished or fully rolled out.	2020-12-07T06:47:30.000Z
description	string	The description of the experiment.	xxx
status	string	The status of the experiment. Valid values: Init: The experiment is not published. Online: The experiment is published. Finish: The experiment is fully rolled out. Offline: The experiment is unpublished.	Init
name	string	The name of the experiment.	测试实验
algorithms	array<object>	A list of experiment parameters.
	object	The information about an experiment parameter.
key	string	The key of the algorithm. Valid values: I2I: The I2I retrieval endpoint. u2X2I: The U2X2I retrieval endpoint. hot: The hot items retrieval endpoint. new: The new items retrieval endpoint. embedding: The vector retrieval endpoint. mtorder: The priority of the retrieval endpoint. rankservice: The sorting service.	I2I
config	array<object>	A list of child configuration items.
	object	The information about a child configuration item.
key	string	The key of the algorithm configuration item.	I2I
defaultValue	string	The default value of the algorithm configuration item.	true
experimentValue	string	The experiment value.	400
name	string	The name of the child configuration item.	xxx
defaultValue	string	The default number of items to retrieve.	true
type	string	The category of the algorithm. Valid values: SYSTEM: The default system type. CUSTOM: The custom user-defined type.	SYSTEM
experimentValue	string	The experiment value.	400
hasConfig	boolean	Indicates whether a child configuration item exists. Valid values: true: Yes false: No	false
category	string	The category of the algorithm. Valid values: RECALL: Retrieval. RANK: Sorting.	RECALL
name	string	The name of the experiment.	xxx
buckets	array	A list of buckets. This parameter takes effect only when the experiment is published.
	string	The information about a bucket.	[1,2,3]
experimentId	string	The experiment ID.	xxx
requestId	string	The request ID.	A74E3FB7-406C-5CBB-833E-E49308B5DC05

Examples

Success response

JSON format

{
  "result": {
    "base": true,
    "onlineTime": "2020-12-07T06:47:30.000Z",
    "offlineTime": "2020-12-07T06:47:30.000Z",
    "description": "xxx",
    "status": "Init",
    "name": "测试实验",
    "algorithms": [
      {
        "key": "I2I",
        "config": [
          {
            "key": "I2I",
            "defaultValue": "true",
            "experimentValue": "400",
            "name": "xxx"
          }
        ],
        "defaultValue": "true",
        "type": "SYSTEM",
        "experimentValue": "400",
        "hasConfig": false,
        "category": "RECALL",
        "name": "xxx"
      }
    ],
    "buckets": [
      "[1,2,3]"
    ],
    "experimentId": "xxx"
  },
  "requestId": "A74E3FB7-406C-5CBB-833E-E49308B5DC05"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.