Constructor Detail

Method Detail

• withRawResponse

   abstract ExampleServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract ExampleServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• bulk

   abstract BulkServiceAsync bulk()

• validate

   abstract ValidateServiceAsync validate()

• create

   CompletableFuture<Example> create(ExampleCreateParams params)

  Create a new example.

• create

   abstract CompletableFuture<Example> create(ExampleCreateParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Example> retrieve(String exampleId)

  Get a specific example.

• retrieve

   CompletableFuture<Example> retrieve(String exampleId, ExampleRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Example> retrieve(String exampleId, ExampleRetrieveParams params)

• retrieve

   abstract CompletableFuture<Example> retrieve(ExampleRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<Example> retrieve(ExampleRetrieveParams params)

• retrieve

   CompletableFuture<Example> retrieve(String exampleId, RequestOptions requestOptions)

• update

   CompletableFuture<ExampleUpdateResponse> update(String exampleId)

  Update a specific example.

• update

   CompletableFuture<ExampleUpdateResponse> update(String exampleId, ExampleUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<ExampleUpdateResponse> update(String exampleId, ExampleUpdateParams params)

• update

   abstract CompletableFuture<ExampleUpdateResponse> update(ExampleUpdateParams params, RequestOptions requestOptions)

• update

   CompletableFuture<ExampleUpdateResponse> update(ExampleUpdateParams params)

• update

   CompletableFuture<ExampleUpdateResponse> update(String exampleId, RequestOptions requestOptions)

• list

   CompletableFuture<ExampleListPageAsync> list()

  Get all examples by query params

• list

   abstract CompletableFuture<ExampleListPageAsync> list(ExampleListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<ExampleListPageAsync> list(ExampleListParams params)

• list

   CompletableFuture<ExampleListPageAsync> list(RequestOptions requestOptions)

• delete

   CompletableFuture<ExampleDeleteResponse> delete(String exampleId)

  Soft delete an example. Only deletes the example in the 'latest' version of the dataset.

• delete

   CompletableFuture<ExampleDeleteResponse> delete(String exampleId, ExampleDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<ExampleDeleteResponse> delete(String exampleId, ExampleDeleteParams params)

• delete

   abstract CompletableFuture<ExampleDeleteResponse> delete(ExampleDeleteParams params, RequestOptions requestOptions)

• delete

   CompletableFuture<ExampleDeleteResponse> delete(ExampleDeleteParams params)

• delete

   CompletableFuture<ExampleDeleteResponse> delete(String exampleId, RequestOptions requestOptions)

• deleteAll

   CompletableFuture<ExampleDeleteAllResponse> deleteAll(ExampleDeleteAllParams params)

  Soft delete examples. Only deletes the examples in the 'latest' version of the dataset.

• deleteAll

   abstract CompletableFuture<ExampleDeleteAllResponse> deleteAll(ExampleDeleteAllParams params, RequestOptions requestOptions)

• retrieveCount

   CompletableFuture<Long> retrieveCount()

  Count all examples by query params

• retrieveCount

   abstract CompletableFuture<Long> retrieveCount(ExampleRetrieveCountParams params, RequestOptions requestOptions)

• retrieveCount

   CompletableFuture<Long> retrieveCount(ExampleRetrieveCountParams params)

• retrieveCount

   CompletableFuture<Long> retrieveCount(RequestOptions requestOptions)

• uploadFromCsv

   CompletableFuture<List<Example>> uploadFromCsv(String datasetId, ExampleUploadFromCsvParams params)

  Upload examples from a CSV file.

  Note: For non-csv upload, please use the POST /v1/platform/datasets/{dataset_id}/examples endpoint which provides more efficient upload.

• uploadFromCsv

   CompletableFuture<List<Example>> uploadFromCsv(String datasetId, ExampleUploadFromCsvParams params, RequestOptions requestOptions)

• uploadFromCsv

   CompletableFuture<List<Example>> uploadFromCsv(ExampleUploadFromCsvParams params)

• uploadFromCsv

   abstract CompletableFuture<List<Example>> uploadFromCsv(ExampleUploadFromCsvParams params, RequestOptions requestOptions)