Documents

Search Document Pages

Search through document pages using semantic similarity.

This endpoint performs a semantic search at the page level, which is best for:

Finding broad context about a topic
Getting an overview of document sections
When you need more context around the matches

Performance Considerations:

Fastest search performance of all levels
Most efficient memory usage
Best for initial broad searches
Recommended for large document collections

Best Practices:

Use for initial exploratory searches
Combine with metadata filters for better performance
Start with this before using more granular searches
Ideal for queries needing broader context

The search uses embeddings to find the most semantically similar pages to your query, regardless of exact keyword matches.

POST

api

documents

pages

curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/search/pages \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "metadata_filter": {},
  "top_k": 10,
  "optimize_metadata": false,
  "optimize_query": false
}'

{
  "success": true,
  "data": {
    "results": [
      {
        "id": 123,
        "document_id": 123,
        "page_number": 123,
        "content": "<string>",
        "relevance": 123
      }
    ],
    "optimized_query": "<string>",
    "optimized_metadata": {}
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Headers

X-API-Key

string | null

Body

application/json

Request model for searching pages.

query

string

required

The search query

metadata_filter

object | null

Optional metadata filters using MongoDB-like query syntax

top_k

integer

default:10

Number of results to return

Required range: 1 <= x <= 100

optimize_metadata

boolean

default:false

Whether to optimize metadata filter

optimize_query

boolean

default:false

Whether to optimize search query

Response

200

application/json

Successful Response

Response model for page search.

data

object

required

Response data

success

boolean

default:true

error

object | null

Schema for API error responses.

Example:

{
  "error_code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found"
}

meta

object

Metadata for API responses

Search document pages (deprecated)Search Document Paragraphs

curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/search/pages \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "metadata_filter": {},
  "top_k": 10,
  "optimize_metadata": false,
  "optimize_query": false
}'

{
  "success": true,
  "data": {
    "results": [
      {
        "id": 123,
        "document_id": 123,
        "page_number": 123,
        "content": "<string>",
        "relevance": 123
      }
    ],
    "optimized_query": "<string>",
    "optimized_metadata": {}
  },
  "error": {
    "error_code": "RESOURCE_NOT_FOUND",
    "message": "Resource not found"
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "version": "1.0"
  }
}

Documents

Content

Extractions

Tasks

Search Document Pages

Headers

Body

Response