Search Document Collection

POST/v0/search/searchDocumentCollectionSearch Document Collection

Search across all documents in a document collection using the document metadata and contents.

Request body

application/json

object

collectionIdstring · uuidrequired

metadataFilterExpressionstring

Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead.

searchOptionsobject

Show child attributes

enableQueryExtractionboolean

/ Whether to extract search terms from the user query and use them for semantic search. Defaults to false.

enableRerankingboolean

Whether to rerank the search results after the initial semantic search query. Defaults to false.

enableSmartFilteringboolean

Whether to automatically filter the search results based on the user query and available metadata on the collection. Defaults to false.

maxChunksinteger

The maximum number of chunks to return. Defaults to 10.

mergeContentsboolean

Whether to merge the chunks for a document and just return one result per document. Defaults to false.

thresholdnumber · double

The similarity threshold between 0 and 1 for the search results. A higher number leads to fewer but more relevant results. Defaults to 0.45.

searchQuerystringrequired

structuredQueryFiltersarray of object

The structured query filters to apply to the search query.

Show child attributes

Show array items

fieldstringrequired

operatorstringrequired

one of "<", ">", "<=", ">=", "!=", "==", "contains"

valuestringrequired

userEmailstringrequired

The email of the user making the search request for permissions reduction.

Example request

{
  "collectionId": "00000000-0000-0000-0000-000000000000",
  "metadataFilterExpression": "string",
  "searchOptions": {
    "enableQueryExtraction": true,
    "enableReranking": true,
    "enableSmartFiltering": true,
    "maxChunks": 0,
    "mergeContents": true,
    "threshold": 0
  },
  "searchQuery": "string",
  "structuredQueryFilters": [
    {
      "field": "string",
      "operator": "!=",
      "value": "string"
    }
  ],
  "userEmail": "string"
}

Responses

objectsearch_SearchDocumentCollectionResponse

SearchDocumentCollectionResponse

resultsarray of objectrequired

Show child attributes

Show array items

chunksarray of objectrequired

Show child attributes

Show array items

chunkIdstring · uuidrequired

chunkIndexintegerrequired

scorenumber · doublerequired

The similarity score between 0 and 1 for the search result. A higher number means the chunk is more relevant to the search query.

textstringrequired

documentExternalIdstringrequired

documentIdstring · uuidrequired

documentMetadataobjectrequired

documentNamestringrequired

documentUrlstringrequired

mergedContentsstring

searchIdstring · uuidrequired

searchTermsUsedarray of stringrequired

Show child attributes

structuredFiltersAppliedarray of objectrequired

Show child attributes

Items: search_SingleFieldFilter ↑

Example response

{
  "results": [
    {
      "chunks": [
        {
          "chunkId": "00000000-0000-0000-0000-000000000000",
          "chunkIndex": 0,
          "score": 0,
          "text": "string"
        }
      ],
      "documentExternalId": "string",
      "documentId": "00000000-0000-0000-0000-000000000000",
      "documentMetadata": {
        "additionalProp1": "string"
      },
      "documentName": "string",
      "documentUrl": "string",
      "mergedContents": "string"
    }
  ],
  "searchId": "00000000-0000-0000-0000-000000000000",
  "searchTermsUsed": [
    "string"
  ],
  "structuredFiltersApplied": [
    {
      "field": "string",
      "operator": "!=",
      "value": "string"
    }
  ]
}

Examples

curl -X POST 'https://api.credal.ai/api/v0/search/searchDocumentCollection' \
  -H 'Content-Type: application/json' \
  -d '{"collectionId":"00000000-0000-0000-0000-000000000000","metadataFilterExpression":"string","searchOptions":{"enableQueryExtraction":true,"enableReranking":true,"enableSmartFiltering":true,"maxChunks":0,"mergeContents":true,"threshold":0},"searchQuery":"string","structuredQueryFilters":[{"field":"string","operator":"!=","value":"string"}],"userEmail":"string"}'

const response = await fetch('https://api.credal.ai/api/v0/search/searchDocumentCollection', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"collectionId":"00000000-0000-0000-0000-000000000000","metadataFilterExpression":"string","searchOptions":{"enableQueryExtraction":true,"enableReranking":true,"enableSmartFiltering":true,"maxChunks":0,"mergeContents":true,"threshold":0},"searchQuery":"string","structuredQueryFilters":[{"field":"string","operator":"!=","value":"string"}],"userEmail":"string"}),
});
const data = await response.json();

const response = await fetch('https://api.credal.ai/api/v0/search/searchDocumentCollection', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"metadataFilterExpression\":\"string\",\"searchOptions\":{\"enableQueryExtraction\":true,\"enableReranking\":true,\"enableSmartFiltering\":true,\"maxChunks\":0,\"mergeContents\":true,\"threshold\":0},\"searchQuery\":\"string\",\"structuredQueryFilters\":[{\"field\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"userEmail\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.credal.ai/api/v0/search/searchDocumentCollection",
    headers={"Content-Type": "application/json"},
    data='{"collectionId":"00000000-0000-0000-0000-000000000000","metadataFilterExpression":"string","searchOptions":{"enableQueryExtraction":true,"enableReranking":true,"enableSmartFiltering":true,"maxChunks":0,"mergeContents":true,"threshold":0},"searchQuery":"string","structuredQueryFilters":[{"field":"string","operator":"!=","value":"string"}],"userEmail":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"collectionId":"00000000-0000-0000-0000-000000000000","metadataFilterExpression":"string","searchOptions":{"enableQueryExtraction":true,"enableReranking":true,"enableSmartFiltering":true,"maxChunks":0,"mergeContents":true,"threshold":0},"searchQuery":"string","structuredQueryFilters":[{"field":"string","operator":"!=","value":"string"}],"userEmail":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.credal.ai/api/v0/search/searchDocumentCollection", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.credal.ai/api/v0/search/searchDocumentCollection");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"metadataFilterExpression\":\"string\",\"searchOptions\":{\"enableQueryExtraction\":true,\"enableReranking\":true,\"enableSmartFiltering\":true,\"maxChunks\":0,\"mergeContents\":true,\"threshold\":0},\"searchQuery\":\"string\",\"structuredQueryFilters\":[{\"field\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"userEmail\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.credal.ai/api/v0/search/searchDocumentCollection"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"metadataFilterExpression\":\"string\",\"searchOptions\":{\"enableQueryExtraction\":true,\"enableReranking\":true,\"enableSmartFiltering\":true,\"maxChunks\":0,\"mergeContents\":true,\"threshold\":0},\"searchQuery\":\"string\",\"structuredQueryFilters\":[{\"field\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"userEmail\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.credal.ai/api/v0/search/searchDocumentCollection")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"metadataFilterExpression\":\"string\",\"searchOptions\":{\"enableQueryExtraction\":true,\"enableReranking\":true,\"enableSmartFiltering\":true,\"maxChunks\":0,\"mergeContents\":true,\"threshold\":0},\"searchQuery\":\"string\",\"structuredQueryFilters\":[{\"field\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"userEmail\":\"string\"}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.credal.ai/api/v0/search/searchDocumentCollection");
request.Content = new StringContent("{\"collectionId\":\"00000000-0000-0000-0000-000000000000\",\"metadataFilterExpression\":\"string\",\"searchOptions\":{\"enableQueryExtraction\":true,\"enableReranking\":true,\"enableSmartFiltering\":true,\"maxChunks\":0,\"mergeContents\":true,\"threshold\":0},\"searchQuery\":\"string\",\"structuredQueryFilters\":[{\"field\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"userEmail\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "results": [
    {
      "chunks": [
        {
          "chunkId": "00000000-0000-0000-0000-000000000000",
          "chunkIndex": 0,
          "score": 0,
          "text": "string"
        }
      ],
      "documentExternalId": "string",
      "documentId": "00000000-0000-0000-0000-000000000000",
      "documentMetadata": {
        "additionalProp1": "string"
      },
      "documentName": "string",
      "documentUrl": "string",
      "mergedContents": "string"
    }
  ],
  "searchId": "00000000-0000-0000-0000-000000000000",
  "searchTermsUsed": [
    "string"
  ],
  "structuredFiltersApplied": [
    {
      "field": "string",
      "operator": "!=",
      "value": "string"
    }
  ]
}

Search documentation

copilots

documentCatalog

documentCollections

search

users

Request body

Responses

copilots

documentCatalog

documentCollections

search

users