Skip to content

Commit f7bf9f7

Browse files
docs: swap examples used in readme (#110)
docs: document how to forcibly omit required field
1 parent c2c1501 commit f7bf9f7

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

+24
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,30 @@ JsonValue complexValue = JsonValue.from(Map.of(
459459
));
460460
```
461461

462+
Normally a `Builder` class's `build` method will throw [`IllegalStateException`](https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html) if any required parameter or property is unset.
463+
464+
To forcibly omit a required parameter or property, pass [`JsonMissing`](openlayer-java-core/src/main/kotlin/com/openlayer/api/core/Values.kt):
465+
466+
```java
467+
import com.openlayer.api.core.JsonMissing;
468+
import com.openlayer.api.core.JsonValue;
469+
import com.openlayer.api.models.inferencepipelines.data.DataStreamParams;
470+
471+
DataStreamParams params = DataStreamParams.builder()
472+
.config(DataStreamParams.Config.LlmData.builder()
473+
.outputColumnName("output")
474+
.build())
475+
.addRow(DataStreamParams.Row.builder()
476+
.putAdditionalProperty("user_query", JsonValue.from("bar"))
477+
.putAdditionalProperty("output", JsonValue.from("bar"))
478+
.putAdditionalProperty("tokens", JsonValue.from("bar"))
479+
.putAdditionalProperty("cost", JsonValue.from("bar"))
480+
.putAdditionalProperty("timestamp", JsonValue.from("bar"))
481+
.build())
482+
.inferencePipelineId(JsonMissing.of())
483+
.build();
484+
```
485+
462486
### Response properties
463487

464488
To access undocumented response properties, call the `_additionalProperties()` method:

0 commit comments

Comments
 (0)