Skip to main content

GetLibrary

Retrieves the detailed configuration of a document library, including its name, description, and index settings.

Operation description

Prerequisites
  • Activate the Alibaba Cloud Model Studio and Tongyi Dianjin services.
  • Obtain a workspace identifier.

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

dianjin:GetLibrary

get

*All Resource

*

NoneNone

Request syntax 

GET /{workspaceId}/api/library/get HTTP/1.1

Path Parameters

Parameter

Type

Required

Description

Example

workspaceId

string

No

Path parameter. The workspace ID.

llm-xxxxx

Request parameters

Parameter

Type

Required

Description

Example

libraryId

string

Yes

The document library ID.

cjshcxxxx

Response elements

Element

Type

Description

Example

object

The response data.

cost

integer

Response time in milliseconds.

null

data

object

The response data object.

description

string

The document library description.

Document library description

documentCount

integer

The number of documents in the library.

10

gmtCreate

string

Creation time

2024-01-01 00:00:00

gmtModified

string

The last modification time in YYYY-MM-DD HH:MM:SS format.

2024-01-01 00:00:00

id

string

The document library ID.

19386728376

indexSetting

object

The document library index settings.

chunkStrategy

object

The chunking strategy.

docTreeSplit

boolean

Enable layout-based splitting.

true

docTreeSplitSize

integer

The layout-based splitting size.

160

enhanceGraph

boolean

Enhance images.

true

enhanceTable

boolean

Enhance tables.

true

overlap

integer

The overlap length between chunks.

40

sentenceSplit

boolean

Split by sentence.

true

sentenceSplitSize

integer

The sentence-based splitting size.

160

size

integer

The chunk size.

256

split

boolean

Enable chunking.

true

modelConfig

object

Model configuration.

temperature

number

temperature

0.8

topP

number

topP

0.8

promptRoleStyle

string

The prompt role style.

You are an information processing expert.

queryEnhancer

object

Query enhancement settings.

enableFollowUp

boolean

Enable multi-turn query enhancement.

true

enableMultiQuery

boolean

Use Large Language Model (LLM) knowledge to decompose queries.

true

enableOpenQa

boolean

Use Large Language Model (LLM) knowledge to answer questions.

true

enableQueryRewrite

boolean

Rewrite queries using domain-specific knowledge.

true

enableSession

boolean

Record session history.

true

localKnowledgeId

string

The document library ID used for knowledge rewriting.

2836482634

withDocumentReference

boolean

Include document references in responses.

true

recallStrategy

object

The recall strategy.

documentRankType

string

The merge and sort policy.

model

limit

integer

The number of results returned after merging two recall paths.

10

textIndexSetting

object

Text index settings.

category

string

The text index type.

ElasticSearch

enable

boolean

Enable text indexing.

true

indexAnalyzer

string

The text index analyzer: Standard, IkMaxWord, or IkSmart.

IkMaxWord

rankThreshold

number

The ranking threshold for text indexing.

null

searchAnalyzer

string

The text index search analyzer: Standard, IkMaxWord, or IkSmart.

Standard

topK

integer

The number of final summary results from text indexing.

10

vectorIndexSetting

object

Vector index settings.

category

string

The vector index source. We recommend ADB.

ADB

embeddingType

string

The text embedding model for the vector index.

DashScope

enable

boolean

Enable vector indexing.

true

rankThreshold

number

The ranking threshold for vector indexing.

null

topK

integer

Number of final results returned by the vector index.

10

libraryName

string

The document library name.

Test document library

dataType

string

The data type.

null

errCode

string

The error code.

0

message

string

Fault type

ok

requestId

string

The request ID.

44BD277A-87F9-5310-8D63-3E6645F1DA85

success

boolean

Indicates whether the request succeeded.

true

time

string

UNIX timestamp

2024-01-01 00:00:00

Examples

Success response JSON format 
{
  "cost": 0,
  "data": {
    "description": "文档库的描述",
    "documentCount": 10,
    "gmtCreate": "2024-01-01 00:00:00",
    "gmtModified": "2024-01-01 00:00:00\n",
    "id": "19386728376",
    "indexSetting": {
      "chunkStrategy": {
        "docTreeSplit": true,
        "docTreeSplitSize": 160,
        "enhanceGraph": true,
        "enhanceTable": true,
        "overlap": 40,
        "sentenceSplit": true,
        "sentenceSplitSize": 160,
        "size": 256,
        "split": true
      },
      "modelConfig": {
        "temperature": 0.8,
        "topP": 0.8
      },
      "promptRoleStyle": "你是一个信息处理专家。",
      "queryEnhancer": {
        "enableFollowUp": true,
        "enableMultiQuery": true,
        "enableOpenQa": true,
        "enableQueryRewrite": true,
        "enableSession": true,
        "localKnowledgeId": "2836482634",
        "withDocumentReference": true
      },
      "recallStrategy": {
        "documentRankType": "model",
        "limit": 10
      },
      "textIndexSetting": {
        "category": "ElasticSearch",
        "enable": true,
        "indexAnalyzer": "IkMaxWord",
        "rankThreshold": 0,
        "searchAnalyzer": "Standard",
        "topK": 10
      },
      "vectorIndexSetting": {
        "category": "ADB",
        "embeddingType": "DashScope",
        "enable": true,
        "rankThreshold": 0,
        "topK": 10
      }
    },
    "libraryName": "测试文档库"
  },
  "dataType": "null",
  "errCode": "0",
  "message": "ok",
  "requestId": "44BD277A-87F9-5310-8D63-3E6645F1DA85",
  "success": true,
  "time": "2024-01-01 00:00:00"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Get Started
Billing
Token Plan
Model Playground
Clients and Developer Tools
Model Inference
Fine-tuning
Evaluation
Model Compression
Statistics and Monitoring
Model Data
Security and Compliance
Best Practices
Support
Changelog