Package com.firecrawl.models

Class JsonFormat

java.lang.Object

com.firecrawl.models.JsonFormat

public class JsonFormat
extends java.lang.Object

JSON extraction format with optional schema and prompt.

Usage:

 JsonFormat jsonFmt = JsonFormat.builder()
     .prompt("Extract the product name and price")
     .schema(Map.of(
         "type", "object",
         "properties", Map.of(
             "name", Map.of("type", "string"),
             "price", Map.of("type", "number")
         )
     ))
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonFormat.Builder

Method Summary

Modifier and Type	Method	Description
static JsonFormat.Builder	builder()
java.lang.String	getPrompt()
java.util.Map<java.lang.String,java.lang.Object>	getSchema()
java.lang.String	getType()

Methods inherited from class java.lang.Object

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

Method Detail

getType

public java.lang.String getType()

getPrompt

public java.lang.String getPrompt()

getSchema

public java.util.Map<java.lang.String,java.lang.Object> getSchema()

builder

public static JsonFormat.Builder builder()