Skip to content

README.md

Latest commit

 

History

History
68 lines (50 loc) · 10.5 KB

README.md

File metadata and controls

68 lines (50 loc) · 10.5 KB

Search

Overview

Available Operations

execute

Search a namespace for a query.

Example Usage

from agentset import Agentset


with Agentset(
    namespace_id="ns_123",
    x_tenant_id="<id>",
    token="AGENTSET_API_KEY",
) as a_client:

    res = a_client.search.execute(query="<value>", top_k=10, rerank=True, rerank_model="zeroentropy:zerank-2", include_relationships=False, include_metadata=True, mode="semantic")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
query str ✔️ The query to search for.
x_tenant_id Optional[str] ➖ Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.
top_k Optional[float] ➖ The number of results to fetch from the vector store. Defaults to 10.
rerank Optional[bool] ➖ Whether to rerank the results. Defaults to true.
rerank_limit Optional[float] ➖ The number of results to return after reranking. Defaults to topK.
rerank_model Optional[models.SearchRerankModel] ➖ The reranking model to use.
filter_ Dict[str, Any] ➖ A filter to apply to the results.
min_score Optional[float] ➖ The minimum score to return.
include_relationships Optional[bool] ➖ Whether to include relationships in the results. Defaults to false.
include_metadata Optional[bool] ➖ Whether to include metadata in the results. Defaults to true.
keyword_filter Optional[str] ➖ N/A
mode Optional[models.SearchMode] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SearchResponse

Errors

Error Type Status Code Content Type
errors.BadRequestError 400 application/json
errors.UnauthorizedError 401 application/json
errors.ForbiddenError 403 application/json
errors.NotFoundError 404 application/json
errors.ConflictError 409 application/json
errors.InviteExpiredError 410 application/json
errors.UnprocessableEntityError 422 application/json
errors.RateLimitExceededError 429 application/json
errors.InternalServerError 500 application/json
errors.AgentsetDefaultError 4XX, 5XX */*