GetParseSettings - Alibaba Cloud Model Studio - Alibaba Cloud ドキュメントセンター

指定されたカテゴリのデータ解析設定を照会します。

操作説明

RAM ユーザー (サブアカウント) がこの API を呼び出すには、まず Alibaba Cloud Bailian の API 権限 (`AliyunBailianDataFullAccess` または `AliyunBailianDataReadOnlyAccess` のいずれか。sfm:GetParseSettings 権限ポイントを含みます) を取得し、ビジネススペースに参加する必要があります。Alibaba Cloud アカウント (メインアカウント) は、権限を付与することなく直接呼び出すことができます。この API を呼び出すには、最新バージョンの Alibaba Cloud Bailian SDK を使用することを推奨します。
この API はべき等性を持ちます。

レート制限の説明： この API を頻繁に呼び出すとレート制限がトリガーされます。呼び出し頻度は 10 回/秒を超えないようにしてください。レート制限が発生した場合は、しばらくしてから再試行してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sfm:GetParseSettings

get

*All Resource

*

なし

リクエスト構文

GET /{WorkspaceId}/datacenter/parser/settings HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
WorkspaceId	string	任意	ファイルが属するワークスペースの ID。詳細については、「ワークスペースの使用」をご参照ください。	llm-3shx2gu255oqxxxx

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CategoryId	string	任意	カテゴリ ID。これは AddCategory によって返される `CategoryId` です。カテゴリ ID を表示するには、[アプリケーションデータ] ページの [非構造化データ] タブで、カテゴリ名の横にある ID アイコンをクリックします。	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	35A267BF-xxxx-54DB-8394-AA3B0742D833
Data	array<object>	返されるデータフィールド。
	array<object>	返されるデータ。
FileType	string	ファイルタイプ。有効な値は、pdf、docx、doc などです。カテゴリでサポートされているすべてのファイルタイプがここにリストされます。	pdf
ParserDisplayName	string	解析メソッドの表示名。	电子文档解析
ParserConfig	object	パーサ構成。現在、これは Qwen VL 解析でのみ利用可能です。
ModelName	string	モデル名。列挙値: qwen-vl-max : qwen-vl-max qwen-vl-plus : qwen-vl-plus	qwen-vl-max
ModelPrompt	string	解析に使用されるプロンプト。	#角色你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标请结合输入图片，详细描述图片中的内容。
Parser	string	現在のタイプのファイルに使用されるパーサ。有効な値： DOCMIND (インテリジェント解析) DOCMIND_DIGITAL (デジタル解析) DOCMIND_LLM_VERSION (LLM 解析) DASH_QWEN_VL_PARSER (Qwen VL 解析)	DOCMIND
Status	string	返される HTTP ステータスコード。	200
Success	boolean	呼び出しが成功したかどうかを示します。有効な値： true false	True
Message	string	エラーメッセージ。	workspace id is null or invalid.
Code	string	ステータスコード。	success

例

成功レスポンス

JSONJSON

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Data": [
    {
      "FileType": "pdf",
      "ParserDisplayName": "电子文档解析",
      "ParserConfig": {
        "ModelName": "qwen-vl-max",
        "ModelPrompt": "#角色\n你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。\n# 任务目标\n请结合输入图片，详细描述图片中的内容。"
      },
      "Parser": "DOCMIND"
    }
  ],
  "Status": "200",
  "Success": true,
  "Message": "workspace id is null or invalid.",
  "Code": "success"
}

エラーコード

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

変更履歴

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