Skip to content

README.md

Latest commit

 

History

History
98 lines (65 loc) · 7.55 KB

README.md

File metadata and controls

98 lines (65 loc) · 7.55 KB

Embedding

Overview

Available Operations

embedding_presign_create_embedding_presign_token

Creates a presign token for embedding operations with configurable expiration time

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.embedding.embedding_presign_create_embedding_presign_token(expires_in=60)

    # Handle response
    print(res)

Parameters

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

Response

models.EmbeddingPresignCreateEmbeddingPresignTokenResponse

Errors

Error Type Status Code Content Type
models.EmbeddingPresignCreateEmbeddingPresignTokenBadRequestError 400 application/json
models.EmbeddingPresignCreateEmbeddingPresignTokenUnauthorizedError 401 application/json
models.EmbeddingPresignCreateEmbeddingPresignTokenForbiddenError 403 application/json
models.EmbeddingPresignCreateEmbeddingPresignTokenInternalServerError 500 application/json
models.APIError 4XX, 5XX */*

embedding_presign_verify_embedding_presign_token

Verifies a presign token for embedding operations and returns the associated API token

Example Usage

from documenso_sdk import Documenso
import os


with Documenso(
    api_key=os.getenv("DOCUMENSO_API_KEY", ""),
) as documenso:

    res = documenso.embedding.embedding_presign_verify_embedding_presign_token(token="<value>")

    # Handle response
    print(res)

Parameters

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

Response

models.EmbeddingPresignVerifyEmbeddingPresignTokenResponse

Errors

Error Type Status Code Content Type
models.EmbeddingPresignVerifyEmbeddingPresignTokenBadRequestError 400 application/json
models.EmbeddingPresignVerifyEmbeddingPresignTokenUnauthorizedError 401 application/json
models.EmbeddingPresignVerifyEmbeddingPresignTokenForbiddenError 403 application/json
models.EmbeddingPresignVerifyEmbeddingPresignTokenInternalServerError 500 application/json
models.APIError 4XX, 5XX */*