Skip to content

README.md

Latest commit

 

History

History
265 lines (187 loc) · 18.5 KB

README.md

File metadata and controls

265 lines (187 loc) · 18.5 KB

Namespaces

Overview

Available Operations

  • list - Retrieve a list of namespaces
  • create - Create a namespace.
  • get - Retrieve a namespace
  • update - Update a namespace.
  • delete - Delete a namespace.

list

Retrieve a list of namespaces for the authenticated organization.

Example Usage

from agentset import Agentset


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

    res = a_client.namespaces.list()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListNamespacesResponse

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

create

Create a namespace for the authenticated organization.

Example Usage

from agentset import Agentset


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

    res = a_client.namespaces.create(name="<value>", slug="<value>", embedding_config={
        "provider": "GOOGLE",
        "model": "text-embedding-004",
        "api_key": "<value>",
    }, vector_store_config={
        "provider": "PINECONE",
        "api_key": "<value>",
        "index_host": "https://example.svc.aped-1234-a56b.pinecone.io",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
name str ✔️ N/A
slug str ✔️ N/A
embedding_config Optional[models.EmbeddingModelConfig] ➖ The embedding model config. If not provided, our managed embedding model will be used. Note: You can't change the embedding model config after the namespace is created.
vector_store_config Optional[models.CreateVectorStoreConfig] ➖ The vector store config. If not provided, our MANAGED_PINECONE vector store will be used. Note: You can't change the vector store config after the namespace is created.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateNamespaceResponse

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

get

Retrieve the info 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.namespaces.get()

    # Handle response
    print(res)

Parameters

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

Response

models.GetNamespaceResponse

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 a namespace for the authenticated organization. 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.namespaces.update()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
name Optional[str] ➖ N/A
slug Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.UpdateNamespaceResponse

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 a namespace for the authenticated organization. This will delete all the data associated with the namespace.

Example Usage

from agentset import Agentset


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

    res = a_client.namespaces.delete()

    # Handle response
    print(res)

Parameters

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

Response

models.DeleteNamespaceResponse

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