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

    Interface Evaluation_test_casesRequestBuilder

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

    interface Evaluation_test_casesRequestBuilder {
        byEvaluation_test_case_uuId(
            evaluation_test_case_uuId: string,
        ): Evaluation_test_case_uuItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiListEvaluationTestCasesOutput>;
        post(
            body: ApiCreateEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiCreateEvaluationTestCaseOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: ApiCreateEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Evaluation_test_casesRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byEvaluation_test_case_uuId get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiListEvaluationTestCasesOutput>

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

      To create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.

      Parameters

      • body: ApiCreateEvaluationTestCaseInputPublic

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiCreateEvaluationTestCaseOutput>

      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 list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.

      Parameters

      • body: ApiCreateEvaluationTestCaseInputPublic

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods