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

    Interface WithKnowledge_base_uuItemRequestBuilder

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

    interface WithKnowledge_base_uuItemRequestBuilder {
        delete(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUnlinkKnowledgeBaseOutput>;
        post(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiLinkKnowledgeBaseOutput>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithKnowledge_base_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    delete post toDeleteRequestInformation toPostRequestInformation withUrl

    Methods

    • To detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUnlinkKnowledgeBaseOutput>

      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(
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | ApiLinkKnowledgeBaseOutput>

      To attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiLinkKnowledgeBaseOutput>

      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 detach a knowledge base from an agent, send a DELETE request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To attach a knowledge base to an agent, send a POST request to /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_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

    Methods