GetDataset

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.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	Access level	Resource type	Condition key	Dependent action
aimiaobi:GetDataset	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:GetDataset

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see Obtain a workspace ID.	llm-xxx
DatasetName	string	No	The name of the dataset. The name must be globally unique.	businessDataset
DatasetId	integer	No	The ID of the dataset. You must specify either this parameter or `DatasetName`.	1

Response elements

Element	Type	Description	Example
	object	The response.
Data	object	The business data.
DatasetId	integer	The ID of the dataset.	1
CreateUser	string	The user who created the dataset.	xxx
CreateTime	string	The time when the dataset was created.	2024-11-12 21:46:24
DatasetType	string	The type of the dataset.	CustomSemanticSearch
DatasetName	string	The name of the dataset.	xxx
DatasetConfig	object	The search configuration of the dataset.
SearchSourceConfigs	array<object>	Third-party search: API definition.
	array<object>	Third-party search: API definition.
DemoQuery	string	A sample query keyword. This keyword is used to test whether the search source is available.	Keywords that can be searched to verify availability
Size	integer	The default number of data entries for requests and responses.	10
SearchSourceRequestConfig	object	The API request configuration.
Url	string	The API URL.	API URL
Method	string	The request method.	Request method
ConnectTimeout	integer	The connection timeout period.	30
SocketTimeout	integer	The read timeout period.	78
Headers	array<object>	The HTTP request headers.
	object	The HTTP request headers.
Name	string	The name of the parameter.	Parameter name
ValueType	string	The data type of the parameter value. Default value: string.	Parameter value data type: default string
ValueFormat	string	This parameter is valid only when `ValueType` is set to `time`.	Valid when valueType = time
Value	string	The value of the parameter.	Parameter value
Params	array<object>	The request path parameters.
	object	The request path parameters.
Name	string	The name of the parameter.	Parameter name
ValueType	string	The data type of the parameter value. Default value: string.	Parameter value data type: default string
ValueFormat	string	This parameter is valid only when `ValueType` is set to `time`.	Valid when valueType = time
Value	string	The value of the parameter.	Parameter value
PathParamsEnable	boolean	Specifies whether to enable path parameters.	true
Body	string	The request body.	Request body
SearchSourceResponseConfig	object	The API response configuration.
JqNodes	array<object>	The node configurations.
	array<object>	The child node configurations.
Key	string	The key of the node.	Node key
Type	string	The data type of the node. Valid values: string, number, list, object, and base.	Node data type: string number list object base
Path	string	The path of the node.	Node path
JqNodes	array<object>	The child node configurations.
	array<object>	The child node configurations.	xx
Key	string	The key of the node.	title
Type	string	The data type of the node. Valid values: string, number, list, object, and base.	string
Path	string	The path of the node.	.title
JqNodes	array<object>	The child node configurations.
	object	The child node configurations.
Key	string	The key of the node.	title
Type	string	The data type of the node. Valid values: string, number, list, object, and base.	string
Path	string	The path of the node.	.title
SearchSourceConfig	object	The configuration items for the dataset.
TagSearchEnable	string	Specifies whether to include tags in the search. Default value: true.	true
TagGenerateEnable	string	Specifies whether to include tags in the generation. Default value: true.	true
MetadataKeyValueSearchEnable	string	Specifies whether to include the key-value pairs of metadata in the search. Default value: true.	true
MetadataKeyValueGenerateEnable	string	Specifies whether to include the key-value pairs of metadata in the generation. Default value: true.	true
DatasetDescription	string	The display name of the dataset.	xxx
SearchDatasetEnable	integer	The switch that enables or disables search for the dataset.	1
DocumentHandleConfig	object	The document processing configuration.
DisableHandleMultimodalMedia	boolean	Specifies whether to disable the processing logic for multimedia files. Default value: false.	true
AccessLevel	string		private
RequestId	string	The unique ID of the request.	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the request was successful. A value of `true` indicates success. A value of `false` indicates failure.	true
Code	string	The status code.	NoData
Message	string	The error message returned if the request fails.	success
HttpStatusCode	integer	The HTTP status code.	200

Examples

Success response JSON format

{
  "Data": {
    "DatasetId": 1,
    "CreateUser": "xxx",
    "CreateTime": "2024-11-12 21:46:24",
    "DatasetType": "CustomSemanticSearch",
    "DatasetName": "xxx",
    "DatasetConfig": {
      "SearchSourceConfigs": [
        {
          "DemoQuery": "Keywords that can be searched to verify availability",
          "Size": 10,
          "SearchSourceRequestConfig": {
            "Url": "API URL",
            "Method": "Request method",
            "ConnectTimeout": 30,
            "SocketTimeout": 78,
            "Headers": [
              {
                "Name": "Parameter name",
                "ValueType": "Parameter value data type: default string",
                "ValueFormat": "Valid when valueType = time",
                "Value": "Parameter value"
              }
            ],
            "Params": [
              {
                "Name": "Parameter name",
                "ValueType": "Parameter value data type: default string",
                "ValueFormat": "Valid when valueType = time",
                "Value": "Parameter value"
              }
            ],
            "PathParamsEnable": true,
            "Body": "Request body"
          },
          "SearchSourceResponseConfig": {
            "JqNodes": [
              {
                "Key": "Node key",
                "Type": "Node data type: string number list object base",
                "Path": "Node path",
                "JqNodes": [
                  {
                    "Key": "title",
                    "Type": "string",
                    "Path": ".title",
                    "JqNodes": [
                      {
                        "Key": "title",
                        "Type": "string",
                        "Path": ".title"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      ],
      "SearchSourceConfig": {
        "TagSearchEnable": "true",
        "TagGenerateEnable": "true",
        "MetadataKeyValueSearchEnable": "true",
        "MetadataKeyValueGenerateEnable": "true"
      }
    },
    "DatasetDescription": "xxx",
    "SearchDatasetEnable": 1,
    "DocumentHandleConfig": {
      "DisableHandleMultimodalMedia": true
    },
    "AccessLevel": "private"
  },
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "Code": "NoData",
  "Message": "success",
  "HttpStatusCode": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes