すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeKnowledgeSpaceAttribute

最終更新日:Sep 24, 2026

ナレッジスペースの詳細を照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribeKnowledgeSpaceAttribute

get

*すべてのリソース。

*

なし なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

KnowledgeSpaceId

string

必須

ナレッジスペースの一意の識別子。

pks-xxxx

RegionId

string

必須

リージョン ID。

cn-beijing

レスポンスフィールド

フィールド

型

説明

例

object

応答のスキーマ。

RequestId

string

リクエストの ID。

6BD9CDE4-5E7B-4BF3-9BB8-83C73E******

KnowledgeSpaceId

string

ナレッジスペースの一意の識別子。

pks-xxxxxx

Name

string

ナレッジスペースの名前。

testName

Description

string

ナレッジスペースの説明。

testDesc

DBClusterId

string

PolarDB インスタンスの ID。

pc-*************

DBName

string

データベースの名前。

polar_rag_meta

DBType

string

データベースエンジンのタイプ。有効な値:

  • MySQL

  • PostgreSQL

MySQL

ACLMode

string

ナレッジスペースのアクセスコントロールリスト (ACL) モード。有効な値:

  • DISABLED: ACL が無効です。

  • ENFORCED: ACL が適用されます。

ENFORCED

Status

string

インスタンスステータス。

Activation

EmbeddingModel

string

埋め込みモデル。

text-埋め込み-v4

EmbeddingDimension

integer

ベクトル次元。

1536

RerankModel

string

再ランキングモデル。

qwen3-rerank

LLMModel

string

large 言語モデル。

qwen3.6-plus

Strategy

string

チャンク戦略。

hybrid

ShardSize

integer

トークン単位のチャンクサイズ。

512

ShardingStrategyConfig

object

ナレッジスペースのデフォルトのチャンク戦略の構成。既存のインスタンスに完全な構成が保存されていない場合、この値は空になることがあります。

DefaultStrategy

object

デフォルトのチャンク戦略。この戦略は、一致するルールがない場合に使用されます。

Type

string

デフォルトのチャンク戦略のタイプ。有効な値: hybrid または階層。

hybrid

Parameters

object

パラメーターの詳細。

MaxTokens

integer

単一チャンク内のトークンの最大値。

512

MergePeers

boolean

同じ見出しの下にある隣接する small チャンクをマージするかどうかを指定します。

true

Rules

array<object>

順序に従って一致するオーバーライドルールのリスト。

array<object>

Match

object

コンテンツタイプ。現在、table がサポートされています。

ContentType

string

コンテンツタイプ。現在、table がサポートされています。

table

Strategy

object

チャンク戦略。

Type

string

ルールが一致したときに使用されるチャンク戦略のタイプ。

階層

Parameters

object

パラメーターの詳細。

MaxTokens

integer

一致したコンテンツの単一チャンク内のトークンの最大値。

512

MarkdownTables

string

Markdown テーブルの処理モード。有効な値: auto、on、または off。

auto

KnowledgeBaseCount

integer

ナレッジベースの総数。

1

TotalDocs

integer

ドキュメントの総数。

1

TotalSizeBytes

integer

バイト単位の合計サイズ。

318881

CreationTime

string

作成時間。

時間は協定世界時 (UTC) の ISO 8601 フォーマット (形式: YYYY-MM-DDTHH:mm:ssZ) です。

2026-06-25T09:53:44Z

OSSBucket

string

OSS バケット。

test-バケット

例

成功レスポンス

JSONJSON

{
  "RequestId": "6BD9CDE4-5E7B-4BF3-9BB8-83C73E******",
  "KnowledgeSpaceId": "pks-xxxxxx",
  "Name": "testName",
  "Description": "testDesc",
  "DBClusterId": "pc-*************",
  "DBName": "polar_rag_meta",
  "DBType": "MySQL",
  "ACLMode": "ENFORCED",
  "Status": "Activation",
  "EmbeddingModel": "text-embedding-v4",
  "EmbeddingDimension": 1536,
  "RerankModel": "qwen3-rerank",
  "LLMModel": "qwen3.6-plus",
  "Strategy": "hybrid",
  "ShardSize": 512,
  "ShardingStrategyConfig": {
    "DefaultStrategy": {
      "Type": "hybrid",
      "Parameters": {
        "MaxTokens": 512,
        "MergePeers": true
      }
    },
    "Rules": [
      {
        "Match": {
          "ContentType": "table"
        },
        "Strategy": {
          "Type": "hierarchical",
          "Parameters": {
            "MaxTokens": 512,
            "MarkdownTables": "auto"
          }
        }
      }
    ]
  },
  "KnowledgeBaseCount": 1,
  "TotalDocs": 1,
  "TotalSizeBytes": 318881,
  "CreationTime": "2026-06-25T09:53:44Z",
  "OSSBucket": "test-bucket"
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。