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

    Interface Data_sourcesRequestBuilder

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

    interface Data_sourcesRequestBuilder {
        byData_source_uuid(
            data_source_uuid: string,
        ): WithData_source_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Data_sourcesRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiListKnowledgeBaseDataSourcesOutput>;
        post(
            body: ApiCreateKnowledgeBaseDataSourceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCreateKnowledgeBaseDataSourceOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Data_sourcesRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiCreateKnowledgeBaseDataSourceInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Data_sourcesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byData_source_uuid get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all data sources for a knowledge base, send a GET request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

      Parameters

      Returns Promise<undefined | ApiListKnowledgeBaseDataSourcesOutput>

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

      To add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

      Parameters

      • body: ApiCreateKnowledgeBaseDataSourceInputPublic

        Data to create a knowledge base data source

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiCreateKnowledgeBaseDataSourceOutput>

      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 add a data source to a knowledge base, send a POST request to /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources.

      Parameters

      • body: ApiCreateKnowledgeBaseDataSourceInputPublic

        Data to create a knowledge base data source

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods