Documents

Search Document Paragraphs

Search through document paragraphs using semantic similarity.

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

Finding specific topics or concepts
Getting more focused results than page-level search
When you need a moderate amount of context

Performance Considerations:

Moderate search performance
Balanced memory usage
Good for medium-sized document collections
More vectors to search than pages

Best Practices:

Use when page-level search is too broad
Ideal for finding specific explanations
Good for topic-focused research
Consider using metadata filters to improve performance

Paragraphs provide a natural unit of text that maintains coherent thoughts and ideas, making this search level ideal for finding self-contained explanations or descriptions.

POST

api

documents

paragraphs

curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/search/paragraphs \
  --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,
        "page_id": 123,
        "paragraph_index": 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 paragraphs.

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 paragraph 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 Search Document Sentences

curl --request POST \
  --url https://api.fieldwise.ai/api/v1/documents/search/paragraphs \
  --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,
        "page_id": 123,
        "paragraph_index": 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 Paragraphs

Headers

Body

Response