oa.oa_types

Types for oa

Functions

heatmap_of_models_and_their_fields()

Classes

BatchRequest(**data)

BatchRequestBody(**data)

EmbeddingResponse(**data)

InputDataJsonL

InputText(**data)

Used to specify the input data in some OpenAI API endpounts.

JsonL([root])

A generic class for JSONL (JSON Lines) files, which are lists of dictionaries.

JsonL[InputText]([root])

A generic class for JSONL (JSON Lines) files, which are lists of dictionaries.

RequestResponse(**data)

Response(**data)

ResponseBody(**data)

Response[Embedding](**data)

Usage(**data)

class oa.oa_types.BatchRequest(**data)[source]

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.BatchRequestBody(**data)[source]

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.EmbeddingResponse(**data)

Bases: Response

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

oa.oa_types.InputDataJsonL

alias of JsonL[InputText]

class oa.oa_types.InputText(**data)[source]

Bases: BaseModel

Used to specify the input data in some OpenAI API endpounts.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.JsonL(root=PydanticUndefined, **data)[source]

Bases: RootModel[list[TypeVar]], Generic[T]

A generic class for JSONL (JSON Lines) files, which are lists of dictionaries.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.JsonL(root=PydanticUndefined, **data)[source]

Bases: RootModel[list[TypeVar]], Generic[T]

A generic class for JSONL (JSON Lines) files, which are lists of dictionaries.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.RequestResponse(**data)[source]

Bases: BaseModel, Generic[DatumT]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.Response(**data)[source]

Bases: BaseModel, Generic[DatumT]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.Response(**data)[source]

Bases: BaseModel, Generic[DatumT]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.ResponseBody(**data)[source]

Bases: BaseModel, Generic[DatumT]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class oa.oa_types.Usage(**data)[source]

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].