Skip to main content
For POST /v1/search, the JSON body includes results (premium content) and, when query.external_search is enabled, external_results.web with live web hits.

​
Document main attributes

The documents returned has the following attributes:
  • id: The unique identifier of the document, a 32-character hexadecimal string.
  • headline: The title of the document.
  • url: The URL of the original document.
  • sentiment (Sunsetting. Instead use the chunk-level sentiment described below)
  • source: The source of the document, an instance of Source, which contains the key and name of the source, and its Rank.
  • timestamp: The timestamp of the document, a datetime object.
  • chunks: The content of the document.
As for “chunks”, each chunk object has the following attributes:
  • text: The text of the chunk.
  • cnum: The one-based index of the chunk in the document. Use it to sort chunks in document order.
  • detections: Entities and topics detected in the chunk text, including their IDs and character offsets. Available with response_detail: "standard" or "extended".
  • locations: Coordinates that locate the chunk inside the document. Available with response_detail: "extended".
  • relevance: A float between 0 and 1. Relevance indicates the degree to which a particular match aligns with the various terms in your query. It’s important to note that the relevance scores you receive are only meaningful within the context of the same search. Each execution generates unique scores, so comparing relevance across different queries is not meaningful.
  • sentiment: A score between -1.0 and +1.0 that represents the chunk-level sentiment.

​
Download the entire document

Search results return document id values that can be used to retrieve the full annotated document as JSON (metadata, content, analytics). For those IDs, use the Fetch document API (GET /v1/documents/{document_id}) only in the case of Ravenpack content (news, premium content, web, etc.). It does not apply to private files you uploaded or ingested via the Content API; for those, use Get annotated document or Get original document (/contents/v1/documents/{content_id}/...).
  1. GET https://api.bigdata.com/v1/documents/{document_id} with your API key in the X-API-KEY header.
  2. The response includes a time-limited pre-signed url (valid for 24 hours).
  3. GET that URL to download the complete document JSON.
You can also find example scripts in bigdata-docs-resources: