Sign in
extract

Data extraction

Performs data extraction using LLM based on the specified data source, filter conditions, and JSON schema. Retrieves chunked data and uses the schema to extract and return the result as JSON via LLM.

Required scope: `knowledge:read`

post/extract

Request body

tagsstring[]
tag_idsstring[]
tag_filter_logic'AND' | 'OR'

Logical operator for combining filter conditions

source_typesSourceType[]
file_typesFileType[]
date_frominteger

Start date for content search (Unix timestamp in seconds)

date_tointeger

End date for content search (Unix timestamp in seconds)

domainsstring[]
use_postfilterboolean

Whether to bypass LanceDB prefilter and apply WHERE after the vector search (IVF_PQ) returns top-K. Significantly faster for broad filters that cover most of the table, but may return fewer than limit results when the hit rate is low.

limitinteger
offsetinteger
authz_policystring

(reserved for future use) Name of the registered authz policy to evaluate when retrieving content. Defaults to the reserved "default" policy when omitted. Ignored when authz is disabled.

principal_idstring

Identifier of the end-user (principal) on whose behalf this request is made. Used to look up the principal's authz subject attributes for policy evaluation. When omitted, subject attributes are empty (most restrictive). Ignored when authz is disabled.

schemaobject required

JSON Schema for the data to be extracted.

promptstring

Additional prompt for the LLM (optional, if not specified, a default prompt in Japanese will be used).

use_relatedboolean

Whether to search for and use related content

Example request

{
  "authz_policy": "external-chatbot",
  "principal_id": "user-123"
}

Response

Successful extraction

createdinteger required

抽出実行時刻（Unix timestamp）

resultExtractResult required

Extraction result as a JSON object conforming to the provided schema.

Changes

Changed in 15 of the 71 revisions of this API.121445

  • 09c7c8b9121d2See the full diff
    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property //////

      new-optional-request-property

  • 05add33422b22See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the new optional request property /

      new-optional-request-property

  • 02104c44c0992See the full diff
    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property //////

      new-optional-request-property

  • 995a53b75a922See the full diff
    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property //////

      new-optional-request-property

  • 756b9db552594See the full diff
    • ○

      added the new datetime enum value to the request property ///////

      request-property-enum-value-added

    • ○

      added the new datetime enum value to the request property ///////

      request-property-enum-value-added

    • ○

      added the new datetime enum value to the request property /////////

      request-property-enum-value-added

    • ○

      added the new datetime enum value to the request property /////////

      request-property-enum-value-added

  • 19a49e909676214See the full diff
    • ▲

      added subschema #2 to the request body allOf list

      request-body-all-of-added

    • ▲

      the request's body type changed from object to no type

      request-body-type-changed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the request property

      request-property-removed

  • 288bf03b951a1See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 82b3e15cf9471See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 13aa0e48bae91See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • e5a84cf939111See the full diff
    • ○

      added the new aac enum value to the request property /

      request-property-enum-value-added

Of the 71 revisions, 18 have no diff computed.