すべてのプロダクト
Search

このプロダクト

    :GetUploadDocumentJob

    ドキュメントセンター

    :GetUploadDocumentJob

    最終更新日:Mar 21, 2026

    ジョブ ID に基づいて、非同期ドキュメントアップロードジョブの進行状況と結果を照会します。

    操作説明

    この操作は、UploadDocumentAsync 操作に関連しています。UploadDocumentAsync 操作を呼び出してアップロードジョブを作成し、ジョブ ID を取得した後、GetUploadDocumentJob 操作を呼び出してジョブの実行情報を照会できます。

    説明

    提案

    • ドキュメントの複雑さや、結果として生成されるベクターチャンクの数に基づいてタイムアウトが推定され、通常は 2 時間を超えることはありません。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:GetUploadDocumentJob

    create

    *Document

    acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    ベクトルエンジン最適化が有効になっているインスタンスの ID。

    説明

    リージョン内のすべての AnalyticDB for PostgreSQL インスタンスに関する情報 (インスタンス ID を含む) を照会するには、DescribeDBInstances 操作を呼び出します。

    gp-xxxxxxxxx
    Namespace

    string

    任意

    テナント隔離用の名前空間名。デフォルト値: public。

    説明

    名前空間を作成するには CreateNamespace 操作を呼び出し、名前空間のリストを照会するには ListNamespaces 操作を呼び出します。

    mynamespace
    Collection

    string

    必須

    ドキュメントコレクション名。

    説明

    ドキュメントコレクションを作成するには CreateDocumentCollection 操作を呼び出し、ドキュメントコレクションのリストを照会するには ListDocumentCollections 操作を呼び出します。

    document
    RegionId

    string

    必須

    クラスターのリージョン ID。

    cn-hangzhou
    NamespacePassword

    string

    必須

    名前空間のパスワード。

    説明

    このパラメーターの値は、CreateNamespace 操作を呼び出すときに指定されます。

    testpassword
    JobId

    string

    必須

    ドキュメントアップロードジョブの ID。ジョブ ID を取得するには、UploadDocumentAsync 操作を呼び出します。

    bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストの一意の ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    返されたメッセージ。

    success
    Status

    string

    操作のステータス。有効な値:

    • success

    • fail

    success
    Job

    object

    ドキュメントアップロードジョブに関する情報です。

    Id

    string

    ジョブ ID。

    231460f8-75dc-405e-a669-0c5204887e91
    Completed

    boolean

    操作が完了したかどうかを示します。

    false
    CreateTime

    string

    ジョブ作成時間。

    2024-01-08 16:52:04.864664
    UpdateTime

    string

    ジョブ最終更新時間。

    2024-01-08 16:53:04.864664
    Status

    string

    ジョブのステータス。有効な値:

    • Success

    • Failed (失敗の理由については、Error パラメーターをご参照ください。)

    • Cancelling

    • Cancelled

    • Start

    • Running

    • Pending

    Running
    Error

    string

    現在の操作が異常または失敗した場合に返されるエラーメッセージ。

    Failed to connect database.
    Progress

    integer

    ドキュメントアップロードジョブの進捗。単位: %。値が 100 の場合は、ジョブが完了したことを示します。

    20
    ErrorCode

    string

    返されたエラーコード。

    InternalError
    ChunkResult

    object

    チャンク化の結果。

    ChunkFileUrl

    string

    チャンク化後のファイルの URL。URL の有効期間は 2 時間です。ファイルは JSONL 形式です。各行は {"page_content":"*****", "metadata": {"**":"***","**":"***"} 形式です。

    http://xxx/test.jsonl
    PlainChunkFileUrl

    string

    チャンク化後にメタデータを含まないファイルの URL。URL の有効期間は 2 時間です。ファイルは TXT 形式です。各行はチャンクです。このファイルは埋め込みに簡単に使用できます。

    http://xxx/test.txt
    DocumentLoaderResultFileUrl

    string

    ADBPGLoader によって生成される Markdown 出力ファイル。有効期間は 2 時間です。

    http://oss.xxx/adbpg_loader_result.md
    Usage

    object

    ドキュメント理解または埋め込みによって消費されるトークン数。

    EmbeddingTokens

    integer

    ベクトル化中に消費されるトークン数。

    説明

    トークンは、テキストを分割するための最小単位です。トークンは、単語、フレーズ、句読点、または文字である場合があります。

    475
    EmbeddingEntries

    integer

    ベクトル化中のエントリ数。

    10

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Running",
    "Error": "Failed to connect database.",
    "Progress": 20,
    "ErrorCode": "InternalError"
  },
  "ChunkResult": {
    "ChunkFileUrl": "http://xxx/test.jsonl",
    "PlainChunkFileUrl": "http://xxx/test.txt",
    "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
  },
  "Usage": {
    "EmbeddingTokens": 475,
    "EmbeddingEntries": 10
  }
}

    エラーコード

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

    変更履歴

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