Search knowledge base
Search a Knowledge Base and return the most similar chunks, along with their search and rerank scores. Note that all configuration changes made in the API will override the settings in the UI.
Path parameters
The unique identifier or key of the knowledge base.
Request body
Example request
{
"rerank_config": {
"model": "cohere/rerank-multilingual-v3.0"
}
}Response
Search knowledge base
Changes
Changed in 10 of the 256 revisions of this API.645453
- ▲
request body became required
request-body-became-required
- ▲
added
SearchOptionsto thesearch_optionsrequest propertyallOflistrequest-property-all-of-added
- ▲
added
SearchRerankConfigto thererank_configrequest propertyallOflistrequest-property-all-of-added
- ▲
the
agentic_rag_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
thresholdrequest property type/format changed fromnumber/tonumber/doublerequest-property-type-changed
- ▲
the
top_krequest property type/format changed frominteger/tointeger/int32request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the request property
agentic_rag_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/thresholdrequest-property-removed
- ●
removed the request property
rerank_config/top_krequest-property-removed
- ●
removed the request property
search_options/include_metadatarequest-property-removed
- ●
removed the request property
search_options/include_scoresrequest-property-removed
- ●
removed the request property
search_options/include_vectorsrequest-property-removed
- ●
removed the optional property
matches/items/scores/rerank_scorefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
matches/items/scores/search_scorefrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional request property
retrieval_confignew-optional-request-property
- ○
added
subschema #1subschema #2to theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-added
- ○
added
SearchKnowledgeScoresto thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-added
This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added the new required request property
agentic_rag_config/modelnew-required-request-property
- ▲
added the new required request property
rerank_config/modelnew-required-request-property
- ▲
removed
subschema #1subschema #2from theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-removed
- ▲
the
agentic_rag_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed from/toobject/for status200response-property-type-changed
- ▲
the
matches/items/vector/items/response's property type/format changed fromnumber/doubletonumber/for status200response-property-type-changed
- ●
removed
SearchOptionsfrom thesearch_optionsrequest propertyallOflistrequest-property-all-of-removed
- ●
removed
SearchRerankConfigfrom thererank_configrequest propertyallOflistrequest-property-all-of-removed
- ●
removed the request property
retrieval_configrequest-property-removed
- ○
added the new optional request property
rerank_config/thresholdnew-optional-request-property
- ○
added the new optional request property
rerank_config/top_knew-optional-request-property
- ○
added the new optional request property
search_options/include_metadatanew-optional-request-property
- ○
added the new optional request property
search_options/include_scoresnew-optional-request-property
- ○
added the new optional request property
search_options/include_vectorsnew-optional-request-property
- ○
request body became optional
request-body-became-optional
- ○
the
thresholdrequest property type/format was generalized fromnumber/doubletonumber/request-property-type-generalized
- ○
the
top_krequest property type/format was generalized frominteger/int32tointeger/request-property-type-generalized
- ○
added the optional property
matches/items/scores/rerank_scoreto the response with the200statusresponse-optional-property-added
- ○
added the optional property
matches/items/scores/search_scoreto the response with the200statusresponse-optional-property-added
- ○
removed
SearchKnowledgeScoresfrom thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-removed
This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
request body became required
request-body-became-required
- ▲
added
SearchOptionsto thesearch_optionsrequest propertyallOflistrequest-property-all-of-added
- ▲
added
SearchRerankConfigto thererank_configrequest propertyallOflistrequest-property-all-of-added
- ▲
the
agentic_rag_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
thresholdrequest property type/format changed fromnumber/tonumber/doublerequest-property-type-changed
- ▲
the
top_krequest property type/format changed frominteger/tointeger/int32request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the request property
agentic_rag_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/thresholdrequest-property-removed
- ●
removed the request property
rerank_config/top_krequest-property-removed
- ●
removed the request property
search_options/include_metadatarequest-property-removed
- ●
removed the request property
search_options/include_scoresrequest-property-removed
- ●
removed the request property
search_options/include_vectorsrequest-property-removed
- ●
removed the optional property
matches/items/scores/rerank_scorefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
matches/items/scores/search_scorefrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional request property
retrieval_confignew-optional-request-property
- ○
added
subschema #1subschema #2to theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-added
- ○
added
SearchKnowledgeScoresto thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-added
This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added the new required request property
agentic_rag_config/modelnew-required-request-property
- ▲
added the new required request property
rerank_config/modelnew-required-request-property
- ▲
removed
subschema #1subschema #2from theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-removed
- ▲
the
agentic_rag_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed from/toobject/for status200response-property-type-changed
- ▲
the
matches/items/vector/items/response's property type/format changed fromnumber/doubletonumber/for status200response-property-type-changed
- ●
removed
SearchOptionsfrom thesearch_optionsrequest propertyallOflistrequest-property-all-of-removed
- ●
removed
SearchRerankConfigfrom thererank_configrequest propertyallOflistrequest-property-all-of-removed
- ●
removed the request property
retrieval_configrequest-property-removed
- ○
added the new optional request property
rerank_config/thresholdnew-optional-request-property
- ○
added the new optional request property
rerank_config/top_knew-optional-request-property
- ○
added the new optional request property
search_options/include_metadatanew-optional-request-property
- ○
added the new optional request property
search_options/include_scoresnew-optional-request-property
- ○
added the new optional request property
search_options/include_vectorsnew-optional-request-property
- ○
request body became optional
request-body-became-optional
- ○
the
thresholdrequest property type/format was generalized fromnumber/doubletonumber/request-property-type-generalized
- ○
the
top_krequest property type/format was generalized frominteger/int32tointeger/request-property-type-generalized
- ○
added the optional property
matches/items/scores/rerank_scoreto the response with the200statusresponse-optional-property-added
- ○
added the optional property
matches/items/scores/search_scoreto the response with the200statusresponse-optional-property-added
- ○
removed
SearchKnowledgeScoresfrom thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-removed
This revision also has 175 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
the
rerank_config/allOf[SearchRerankConfig]/thresholdrequest property's max was set to1.00request-property-max-set
- ●
the
rerank_config/allOf[SearchRerankConfig]/top_krequest property's max was set to100.00request-property-max-set
- ●
the
thresholdrequest property's max was set to1.00request-property-max-set
- ●
the
top_krequest property's max was set to100.00request-property-max-set
- ●
the
rerank_config/allOf[SearchRerankConfig]/top_krequest property's min was set to1.00request-property-min-set
- ●
the
top_krequest property's min was set to1.00request-property-min-set
- ○
the
thresholdrequest property default value changed from0to0request-property-default-value-changed
- ○
the
top_krequest property default value changed from10to10request-property-default-value-changed
- ●
- ▲
request body became required
request-body-became-required
- ▲
added
SearchOptionsto thesearch_optionsrequest propertyallOflistrequest-property-all-of-added
- ▲
added
SearchRerankConfigto thererank_configrequest propertyallOflistrequest-property-all-of-added
- ▲
the
agentic_rag_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
thresholdrequest property type/format changed fromnumber/tonumber/doublerequest-property-type-changed
- ▲
the
top_krequest property type/format changed frominteger/tointeger/int32request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the request property
agentic_rag_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/thresholdrequest-property-removed
- ●
removed the request property
rerank_config/top_krequest-property-removed
- ●
removed the request property
search_options/include_metadatarequest-property-removed
- ●
removed the request property
search_options/include_scoresrequest-property-removed
- ●
removed the request property
search_options/include_vectorsrequest-property-removed
- ●
removed the optional property
matches/items/scores/rerank_scorefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
matches/items/scores/search_scorefrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional request property
retrieval_confignew-optional-request-property
- ○
added
subschema #1subschema #2to theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-added
- ○
added
SearchKnowledgeScoresto thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-added
This revision also has 31 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
added the new required request property
agentic_rag_config/modelnew-required-request-property
- ▲
added the new required request property
rerank_config/modelnew-required-request-property
- ▲
removed
subschema #1subschema #2from theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-removed
- ▲
the
agentic_rag_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed from/toobject/request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed from/toobject/for status200response-property-type-changed
- ▲
the
matches/items/vector/items/response's property type/format changed fromnumber/doubletonumber/for status200response-property-type-changed
- ●
removed
SearchOptionsfrom thesearch_optionsrequest propertyallOflistrequest-property-all-of-removed
- ●
removed
SearchRerankConfigfrom thererank_configrequest propertyallOflistrequest-property-all-of-removed
- ●
the
thresholdrequest property's max was set to1.00request-property-max-set
- ●
the
top_krequest property's max was set to100.00request-property-max-set
- ●
the
top_krequest property's min was set to1.00request-property-min-set
- ●
removed the request property
retrieval_configrequest-property-removed
- ○
added the new optional request property
rerank_config/thresholdnew-optional-request-property
- ○
added the new optional request property
rerank_config/top_knew-optional-request-property
- ○
added the new optional request property
search_options/include_metadatanew-optional-request-property
- ○
added the new optional request property
search_options/include_scoresnew-optional-request-property
- ○
added the new optional request property
search_options/include_vectorsnew-optional-request-property
- ○
request body became optional
request-body-became-optional
- ○
the
thresholdrequest property type/format was generalized fromnumber/doubletonumber/request-property-type-generalized
- ○
the
top_krequest property type/format was generalized frominteger/int32tointeger/request-property-type-generalized
- ○
added the optional property
matches/items/scores/rerank_scoreto the response with the200statusresponse-optional-property-added
- ○
added the optional property
matches/items/scores/search_scoreto the response with the200statusresponse-optional-property-added
- ○
removed
SearchKnowledgeScoresfrom thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-removed
This revision also has 173 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
request body became required
request-body-became-required
- ▲
added
SearchOptionsto thesearch_optionsrequest propertyallOflistrequest-property-all-of-added
- ▲
added
SearchRerankConfigto thererank_configrequest propertyallOflistrequest-property-all-of-added
- ▲
the
agentic_rag_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
rerank_configrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
search_optionsrequest property type/format changed fromobject/to/request-property-type-changed
- ▲
the
thresholdrequest property type/format changed fromnumber/tonumber/doublerequest-property-type-changed
- ▲
the
top_krequest property type/format changed frominteger/tointeger/int32request-property-type-changed
- ▲
the
matches/items/scoresresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the request property
agentic_rag_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/modelrequest-property-removed
- ●
removed the request property
rerank_config/thresholdrequest-property-removed
- ●
removed the request property
rerank_config/top_krequest-property-removed
- ●
removed the request property
search_options/include_metadatarequest-property-removed
- ●
removed the request property
search_options/include_scoresrequest-property-removed
- ●
removed the request property
search_options/include_vectorsrequest-property-removed
- ●
removed the optional property
matches/items/scores/rerank_scorefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
matches/items/scores/search_scorefrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional request property
retrieval_confignew-optional-request-property
- ○
added
subschema #1subschema #2to theagentic_rag_configrequest propertyanyOflistrequest-property-any-of-added
- ○
added
SearchKnowledgeScoresto thematches/items/scoresresponse propertyallOflist for the response status200response-property-all-of-added
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ▲
the request property
search_typebecame not nullablerequest-property-became-not-nullable
- ▲
the request property
thresholdbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
top_kbecame not nullablerequest-property-became-not-nullable
- ▲
removed the enum value
undefinedof the request propertysearch_typerequest-property-enum-value-removed
- ○
the
search_typerequest property default valuehybrid_searchwas addedrequest-property-default-value-added
This revision also has 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
the request property
search_typebecame nullablerequest-property-became-nullable
- ○
the request property
thresholdbecame nullablerequest-property-became-nullable
- ○
the request property
top_kbecame nullablerequest-property-became-nullable
- ○
the
search_typerequest property default valuehybrid_searchwas removedrequest-property-default-value-removed
- ○
added the new
undefinedenum value to the request propertysearch_typerequest-property-enum-value-added
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
Of the 256 revisions, 71 have no diff computed.