@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface WithWorkspace_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/workspaces/{workspace_uuid}

    interface WithWorkspace_uuItemRequestBuilder {
        get agents(): AgentsRequestBuilder;
        get evaluation_test_cases(): Evaluation_test_casesRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiDeleteWorkspaceOutput>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiGetWorkspaceOutput>;
        put(
            body: ApiUpdateWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateWorkspaceOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateWorkspaceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithWorkspace_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    agents evaluation_test_cases

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiDeleteWorkspaceOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiGetWorkspaceOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

      Parameters

      • body: ApiUpdateWorkspaceInputPublic

        Parameters for Update Workspace

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<undefined | ApiUpdateWorkspaceOutput>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To delete a workspace, send a DELETE request to /v2/gen-ai/workspace/{workspace_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To retrieve details of a workspace, GET request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • To update a workspace, send a PUT request to /v2/gen-ai/workspaces/{workspace_uuid}. The response body is a JSON object containing the workspace.

      Parameters

      • body: ApiUpdateWorkspaceInputPublic

        Parameters for Update Workspace

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods