Skip to content

README.md

Latest commit

 

History

History
224 lines (161 loc) · 18.1 KB

README.md

File metadata and controls

224 lines (161 loc) · 18.1 KB

Hosting

Overview

Available Operations

  • get - Retrieve hosting configuration
  • enable - Enable hosting
  • update - Update hosting configuration
  • delete - Delete hosting configuration

get

Retrieve the hosting configuration for a namespace.

Example Usage

from agentset import Agentset


with Agentset(
    namespace_id="ns_123",
    token="AGENTSET_API_KEY",
) as a_client:

    res = a_client.hosting.get()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.GetHostingRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetHostingResponse

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 */*

enable

Enable hosting for a namespace.

Example Usage

from agentset import Agentset


with Agentset(
    namespace_id="ns_123",
    token="AGENTSET_API_KEY",
) as a_client:

    res = a_client.hosting.enable()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.EnableHostingRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EnableHostingResponse

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 */*

update

Update the hosting configuration for a namespace. If there is no change, return it as it is.

Example Usage

from agentset import Agentset


with Agentset(
    namespace_id="ns_123",
    token="AGENTSET_API_KEY",
) as a_client:

    res = a_client.hosting.update()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
title Optional[str] ➖ N/A
slug Optional[str] ➖ N/A
logo OptionalNullable[str] ➖ N/A
og_title Optional[str] ➖ N/A
og_description Optional[str] ➖ N/A
og_image OptionalNullable[str] ➖ N/A
protected Optional[bool] ➖ N/A
allowed_emails List[str] ➖ N/A
allowed_email_domains List[str] ➖ N/A
system_prompt Optional[str] ➖ N/A
example_questions List[str] ➖ N/A
example_search_queries List[str] ➖ N/A
welcome_message Optional[str] ➖ N/A
citation_metadata_path Optional[str] ➖ N/A
search_enabled Optional[bool] ➖ N/A
rerank_model Optional[models.UpdateHostingRerankModel] ➖ N/A
llm_model Optional[models.LlmModel] ➖ N/A
top_k Optional[int] ➖ N/A
rerank_limit Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdateHostingResponse

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 */*

delete

Delete the hosting configuration for a namespace.

Example Usage

from agentset import Agentset


with Agentset(
    namespace_id="ns_123",
    token="AGENTSET_API_KEY",
) as a_client:

    res = a_client.hosting.delete()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.DeleteHostingRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DeleteHostingResponse

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 */*