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

    Interface Indexing_job_uuItemRequestBuilder

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

    interface Indexing_job_uuItemRequestBuilder {
        get cancel(): CancelRequestBuilder;
        get data_sources(): Data_sourcesRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiGetKnowledgeBaseIndexingJobOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Indexing_job_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    cancel data_sources

    Methods

    get toGetRequestInformation withUrl

    Accessors

    Methods

    • To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiGetKnowledgeBaseIndexingJobOutput>

      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 get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.

      Parameters

      • 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