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

    Interface CancelRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/indexing_jobs/{indexing_job_uu-id}/cancel

    interface CancelRequestBuilder {
        put(
            body: ApiCancelKnowledgeBaseIndexingJobInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCancelKnowledgeBaseIndexingJobOutput>;
        toPutRequestInformation(
            body: ApiCancelKnowledgeBaseIndexingJobInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): CancelRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

      Parameters

      • body: ApiCancelKnowledgeBaseIndexingJobInputPublic

        CancelKnowledgeBaseIndexingJobInputPublic description

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiCancelKnowledgeBaseIndexingJobOutput>

      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 cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

      Parameters

      • body: ApiCancelKnowledgeBaseIndexingJobInputPublic

        CancelKnowledgeBaseIndexingJobInputPublic description

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns CancelRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods