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

    Interface Evaluation_runsRequestBuilder

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

    interface Evaluation_runsRequestBuilder {
        byEvaluation_run_uuid(
            evaluation_run_uuid: string,
        ): WithEvaluation_run_uuItemRequestBuilder;
        post(
            body: ApiRunEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiRunEvaluationTestCaseOutput>;
        toPostRequestInformation(
            body: ApiRunEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Evaluation_runsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byEvaluation_run_uuid post toPostRequestInformation withUrl

    Methods

    post

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

      To run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.

      Parameters

      • body: ApiRunEvaluationTestCaseInputPublic

        Run an evaluation test case.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiRunEvaluationTestCaseOutput>

      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 run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.

      Parameters

      • body: ApiRunEvaluationTestCaseInputPublic

        Run an evaluation test case.

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Methods