Package ai.extend.resources.evaluationsetitem

Class RawEvaluationSetItemClient

java.lang.Object

ai.extend.resources.evaluationsetitem.RawEvaluationSetItemClient

public class RawEvaluationSetItemClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
RawEvaluationSetItemClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
ExtendClientHttpResponse<EvaluationSetItemCreateResponse>	create(EvaluationSetItemCreateRequest request)	Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.
ExtendClientHttpResponse<EvaluationSetItemCreateResponse>	create(EvaluationSetItemCreateRequest request, RequestOptions requestOptions)	Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.
ExtendClientHttpResponse<EvaluationSetItemCreateBatchResponse>	createBatch(EvaluationSetItemCreateBatchRequest request)	If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once.
ExtendClientHttpResponse<EvaluationSetItemCreateBatchResponse>	createBatch(EvaluationSetItemCreateBatchRequest request, RequestOptions requestOptions)	If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once.
ExtendClientHttpResponse<EvaluationSetItemDeleteResponse>	delete(java.lang.String id)	Delete an evaluation set item from an evaluation set.
ExtendClientHttpResponse<EvaluationSetItemDeleteResponse>	delete(java.lang.String id, RequestOptions requestOptions)	Delete an evaluation set item from an evaluation set.
ExtendClientHttpResponse<EvaluationSetItemListResponse>	list(java.lang.String id)	List all items in a specific evaluation set.
ExtendClientHttpResponse<EvaluationSetItemListResponse>	list(java.lang.String id, EvaluationSetItemListRequest request)	List all items in a specific evaluation set.
ExtendClientHttpResponse<EvaluationSetItemListResponse>	list(java.lang.String id, EvaluationSetItemListRequest request, RequestOptions requestOptions)	List all items in a specific evaluation set.
ExtendClientHttpResponse<EvaluationSetItemUpdateResponse>	update(java.lang.String id, EvaluationSetItemUpdateRequest request)	If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item.
ExtendClientHttpResponse<EvaluationSetItemUpdateResponse>	update(java.lang.String id, EvaluationSetItemUpdateRequest request, RequestOptions requestOptions)	If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

RawEvaluationSetItemClient

public RawEvaluationSetItemClient(ClientOptions clientOptions)

Method Detail

list

public ExtendClientHttpResponse<EvaluationSetItemListResponse> list(java.lang.String id)

List all items in a specific evaluation set. Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.

This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

list

public ExtendClientHttpResponse<EvaluationSetItemListResponse> list(java.lang.String id,
                                                                    EvaluationSetItemListRequest request)

List all items in a specific evaluation set. Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.

This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

list

public ExtendClientHttpResponse<EvaluationSetItemListResponse> list(java.lang.String id,
                                                                    EvaluationSetItemListRequest request,
                                                                    RequestOptions requestOptions)

List all items in a specific evaluation set. Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend.

This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

create

public ExtendClientHttpResponse<EvaluationSetItemCreateResponse> create(EvaluationSetItemCreateRequest request)

Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set item in Extend, which will be used during an evaluation run.

Best Practices for Outputs in Evaluation Sets:

• Configure First, Output Later
  • Always create and finalize your processor configuration before creating evaluation sets
  • Field IDs in outputs must match those defined in your processor configuration
• Type Consistency
  • Ensure output types exactly match your processor configuration
  • For example, if a field is configured as "currency", don't submit a simple number value
• Field IDs
  • Use the exact field IDs from your processor configuration
  • Create your own semantic IDs instead in the configs for each field/type instead of using the generated ones
• Value
  • Remember that all results are inside the value key of a result object, except the values within nested structures.

create

public ExtendClientHttpResponse<EvaluationSetItemCreateResponse> create(EvaluationSetItemCreateRequest request,
                                                                        RequestOptions requestOptions)

Evaluation set items are the individual files and expected outputs that are used to evaluate the performance of a given processor in Extend. This endpoint will create a new evaluation set item in Extend, which will be used during an evaluation run.

Best Practices for Outputs in Evaluation Sets:

• Configure First, Output Later
  • Always create and finalize your processor configuration before creating evaluation sets
  • Field IDs in outputs must match those defined in your processor configuration
• Type Consistency
  • Ensure output types exactly match your processor configuration
  • For example, if a field is configured as "currency", don't submit a simple number value
• Field IDs
  • Use the exact field IDs from your processor configuration
  • Create your own semantic IDs instead in the configs for each field/type instead of using the generated ones
• Value
  • Remember that all results are inside the value key of a result object, except the values within nested structures.

update

public ExtendClientHttpResponse<EvaluationSetItemUpdateResponse> update(java.lang.String id,
                                                                        EvaluationSetItemUpdateRequest request)

If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item. This can be useful if you need to correct an error in the expected output or if the output of the processor has changed.

update

public ExtendClientHttpResponse<EvaluationSetItemUpdateResponse> update(java.lang.String id,
                                                                        EvaluationSetItemUpdateRequest request,
                                                                        RequestOptions requestOptions)

If you need to change the expected output for a given evaluation set item, you can use this endpoint to update the item. This can be useful if you need to correct an error in the expected output or if the output of the processor has changed.

delete

public ExtendClientHttpResponse<EvaluationSetItemDeleteResponse> delete(java.lang.String id)

Delete an evaluation set item from an evaluation set. This operation is permanent and cannot be undone.

This endpoint can be used to remove individual items from an evaluation set when they are no longer needed or if they were added in error.

delete

public ExtendClientHttpResponse<EvaluationSetItemDeleteResponse> delete(java.lang.String id,
                                                                        RequestOptions requestOptions)

Delete an evaluation set item from an evaluation set. This operation is permanent and cannot be undone.

This endpoint can be used to remove individual items from an evaluation set when they are no longer needed or if they were added in error.

createBatch

public ExtendClientHttpResponse<EvaluationSetItemCreateBatchResponse> createBatch(EvaluationSetItemCreateBatchRequest request)

If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once. This can be useful if you have a large dataset that you need to evaluate the performance of a processor against.

Note: you still need to create each File first using the file API.

createBatch

public ExtendClientHttpResponse<EvaluationSetItemCreateBatchResponse> createBatch(EvaluationSetItemCreateBatchRequest request,
                                                                                  RequestOptions requestOptions)

If you have a large number of files that you need to add to an evaluation set, you can use this endpoint to create multiple evaluation set items at once. This can be useful if you have a large dataset that you need to evaluate the performance of a processor against.

Note: you still need to create each File first using the file API.