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

    Interface Indexing_jobsRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/indexing_jobs

    interface Indexing_jobsRequestBuilder {
        byIndexing_job_uuId(
            indexing_job_uuId: string,
        ): Indexing_job_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Indexing_jobsRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiListKnowledgeBaseIndexingJobsOutput>;
        post(
            body: ApiStartKnowledgeBaseIndexingJobInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiStartKnowledgeBaseIndexingJobOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Indexing_jobsRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiStartKnowledgeBaseIndexingJobInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Indexing_jobsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byIndexing_job_uuId get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all indexing jobs for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs.

      Parameters

      Returns Promise<undefined | ApiListKnowledgeBaseIndexingJobsOutput>

      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

    post

    • post(
          body: ApiStartKnowledgeBaseIndexingJobInputPublic,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ApiStartKnowledgeBaseIndexingJobOutput>

      To start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.

      Parameters

      • body: ApiStartKnowledgeBaseIndexingJobInputPublic

        StartKnowledgeBaseIndexingJobInputPublic description

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiStartKnowledgeBaseIndexingJobOutput>

      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 start an indexing job for a knowledge base, send a POST request to /v2/gen-ai/indexing_jobs.

      Parameters

      • body: ApiStartKnowledgeBaseIndexingJobInputPublic

        StartKnowledgeBaseIndexingJobInputPublic description

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods