ContentFieldDefinition Class

Definition of the field using a JSON Schema like syntax.

Constructor

ContentFieldDefinition(*args: Any, **kwargs: Any)

Variables

Name	Description
method	str or GenerationMethod Generation method. Known values are: "generate", "extract", and "classify".
type	str or ContentFieldType Semantic data type of the field value. Known values are: "string", "date", "time", "number", "integer", "boolean", "array", "object", and "json".
description	str Field description.
item_definition	ContentFieldDefinition Field type schema of each array element, if type is array.
properties	dict[str, ContentFieldDefinition] Named sub-fields, if type is object.
examples	list[str] Examples of field values.
enum	list[str] Enumeration of possible field values.
enum_descriptions	dict[str, str] Descriptions for each enumeration value.
ref	str Reference to another field definition.
estimate_source_and_confidence	bool Return grounding source and confidence.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

description

Field description.

description: str | None

enum

Enumeration of possible field values.

enum: list[str] | None

enum_descriptions

Descriptions for each enumeration value.

enum_descriptions: dict[str, str] | None

estimate_source_and_confidence

Return grounding source and confidence.

estimate_source_and_confidence: bool | None

examples

Examples of field values.

examples: list[str] | None

item_definition

Field type schema of each array element, if type is array.

item_definition: _models.ContentFieldDefinition | None

method

"generate", "extract", and "classify".

method: str | _models.GenerationMethod | None

properties

Named sub-fields, if type is object.

properties: dict[str, '_models.ContentFieldDefinition'] | None

ref

Reference to another field definition.

ref: str | None

type

"string", "date", "time", "number", "integer", "boolean", "array", "object", and "json".

type: str | _models.ContentFieldType | None