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

    Interface Knowledge_base_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/knowledge_bases/{knowledge_base_uu-id}

    interface Knowledge_base_uuItemRequestBuilder {
        get data_sources(): Data_sourcesRequestBuilder;
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiDeleteKnowledgeBaseOutput>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiGetKnowledgeBaseOutput>;
        put(
            body: ApiUpdateKnowledgeBaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateKnowledgeBaseOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateKnowledgeBaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Knowledge_base_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    data_sources

    Methods

    delete get put toDeleteRequestInformation toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To delete a knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiDeleteKnowledgeBaseOutput>

      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 retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiGetKnowledgeBaseOutput>

      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 knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • body: ApiUpdateKnowledgeBaseInputPublic

        Information about updating a knowledge base

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUpdateKnowledgeBaseOutput>

      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 knowledge base, send a DELETE request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To retrive information about an existing knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update a knowledge base, send a PUT request to /v2/gen-ai/knowledge_bases/{uuid}.

      Parameters

      • body: ApiUpdateKnowledgeBaseInputPublic

        Information about updating a knowledge base

      • 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