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

    Interface Evaluation_test_case_uuItemRequestBuilder

    Builds and executes requests for operations under /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uu-id}

    interface Evaluation_test_case_uuItemRequestBuilder {
        get evaluation_runs(): Evaluation_runsRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<
                Evaluation_test_case_uuItemRequestBuilderGetQueryParameters,
            >,
        ): Promise<undefined | ApiGetEvaluationTestCaseOutput>;
        put(
            body: ApiUpdateEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ApiUpdateEvaluationTestCaseOutput>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<
                Evaluation_test_case_uuItemRequestBuilderGetQueryParameters,
            >,
        ): RequestInformation;
        toPutRequestInformation(
            body: ApiUpdateEvaluationTestCaseInputPublic,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): Evaluation_test_case_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    evaluation_runs

    Methods

    get put toGetRequestInformation toPutRequestInformation withUrl

    Accessors

    Methods

    • To retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.

      Parameters

      Returns Promise<undefined | ApiGetEvaluationTestCaseOutput>

      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 an evaluation test-case send a PUT request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.

      Parameters

      • body: ApiUpdateEvaluationTestCaseInputPublic

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ApiUpdateEvaluationTestCaseOutput>

      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 an evaluation test-case send a PUT request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.

      Parameters

      • body: ApiUpdateEvaluationTestCaseInputPublic

        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

    Accessors
    Methods