evalquiz_proto.shared.generated package

Module contents

class evalquiz_proto.shared.generated.Batch(lecture_materials: List[ForwardRef('LectureMaterial')] = <object object at 0x7fabb3fd71a0>, question_to_generate: List[ForwardRef('Question')] = <object object at 0x7fabb3fd71a0>, capabilites: List[ForwardRef('Capability')] = <object object at 0x7fabb3fd71a0>)

Bases: Message

capabilites: List[Capability] = <object object>

lecture_materials: List[LectureMaterial] = <object object>

question_to_generate: List[Question] = <object object>

class evalquiz_proto.shared.generated.BatchStatus(error_message: Optional[str] = None, pipeline_module: 'PipelineModule' = <object object at 0x7fabb3fd71a0>, module_status: 'ModuleStatus' = <object object at 0x7fabb3fd71a0>)

Bases: Message

error_message: str | None = None

module_status: ModuleStatus = <object object>

pipeline_module: PipelineModule = <object object>

class evalquiz_proto.shared.generated.ByMetrics(evaluation_reference: str = <object object at 0x7fabb3fd71a0>, evaluator_type: str = <object object at 0x7fabb3fd71a0>, evaluation_result: 'EvaluationResult' = <object object at 0x7fabb3fd71a0>)

Bases: Message

evaluation_reference: str = <object object>

evaluation_result: EvaluationResult = <object object>

evaluator_type: str = <object object>

class evalquiz_proto.shared.generated.Capability(keywords: List[str] = <object object at 0x7fabb3fd71a0>, educational_objective: 'EducationalObjective' = <object object at 0x7fabb3fd71a0>, relationship: 'Relationship' = <object object at 0x7fabb3fd71a0>)

Bases: Message

educational_objective: EducationalObjective = <object object>

keywords: List[str] = <object object>

relationship: Relationship = <object object>

class evalquiz_proto.shared.generated.Categorical(categories: List[str] = <object object at 0x7fabb3fd71a0>)

Bases: Message

categories: List[str] = <object object>

class evalquiz_proto.shared.generated.Complete

Bases: Message

class evalquiz_proto.shared.generated.CourseSettings(course_goals: List[ForwardRef('Capability')] = <object object at 0x7fabb3fd71a0>, required_capabilites: List[ForwardRef('Capability')] = <object object at 0x7fabb3fd71a0>, advantageous_capabilities: List[ForwardRef('Capability')] = <object object at 0x7fabb3fd71a0>)

Bases: Message

advantageous_capabilities: List[Capability] = <object object>

course_goals: List[Capability] = <object object>

required_capabilites: List[Capability] = <object object>

class evalquiz_proto.shared.generated.EducationalObjective(value)

Bases: Enum

An enumeration.

ANALYZE = 2

APPLY = 1

EVALUATE = 4

INNOVATE = 5

KNOW_AND_UNDERSTAND = 0

SYNTHESIZE = 3

class evalquiz_proto.shared.generated.Empty

Bases: Message

class evalquiz_proto.shared.generated.Evaluation(language_model_evaluation: 'LanguageModelEvaluation' = <object object at 0x7fabb3fd71a0>)

Bases: Message

language_model_evaluation: LanguageModelEvaluation = <object object>

class evalquiz_proto.shared.generated.EvaluationResult(str_value: str = <object object at 0x7fabb3fd71a0>, float_value: float = <object object at 0x7fabb3fd71a0>)

Bases: Message

float_value: float = <object object>

str_value: str = <object object>

class evalquiz_proto.shared.generated.EvaluationResultType(value_range: 'ValueRange' = <object object at 0x7fabb3fd71a0>, categorical: 'Categorical' = <object object at 0x7fabb3fd71a0>)

Bases: Message

categorical: Categorical = <object object>

value_range: ValueRange = <object object>

class evalquiz_proto.shared.generated.EvaluationSettings(metrics: List[ForwardRef('Metric')] = <object object at 0x7fabb3fd71a0>)

Bases: Message

metrics: List[Metric] = <object object>

class evalquiz_proto.shared.generated.GenerationEvaluationResult(generation_result: 'GenerationResult' = <object object at 0x7fabb3fd71a0>, evaluation_result: 'EvaluationResult' = <object object at 0x7fabb3fd71a0>)

Bases: Message

evaluation_result: EvaluationResult = <object object>

generation_result: GenerationResult = <object object>

class evalquiz_proto.shared.generated.GenerationResult(multiple_choice: 'MultipleChoice' = <object object at 0x7fabb3fd71a0>, multiple_response: 'MultipleResponse' = <object object at 0x7fabb3fd71a0>)

Bases: Message

multiple_choice: MultipleChoice = <object object>

multiple_response: MultipleResponse = <object object>

class evalquiz_proto.shared.generated.GenerationSettings(mode: Optional[ForwardRef('Mode')] = None, model: str | None = None)

Bases: Message

mode: Mode | None = None

model: str | None = None

class evalquiz_proto.shared.generated.InternalConfig(material_server_urls: ~typing.List[str] = <object object>, batches: ~typing.List[~evalquiz_proto.shared.generated.Batch] = <object object>, course_settings: ~evalquiz_proto.shared.generated.CourseSettings | None = None, generation_settings: ~evalquiz_proto.shared.generated.GenerationSettings | None = None, evaluation_settings: ~evalquiz_proto.shared.generated.EvaluationSettings | None = None)

Bases: Message

*Matches question type specification.

batches: List[Batch] = <object object>

course_settings: CourseSettings | None = None

evaluation_settings: EvaluationSettings | None = None

generation_settings: GenerationSettings | None = None

material_server_urls: List[str] = <object object>

class evalquiz_proto.shared.generated.LanguageModelEvaluation(model: str = <object object at 0x7fabb3fd71a0>, evaluation_description: str = <object object at 0x7fabb3fd71a0>, few_shot_examples: List[ForwardRef('GenerationEvaluationResult')] = <object object at 0x7fabb3fd71a0>, evaluation_result_type: 'EvaluationResultType' = <object object at 0x7fabb3fd71a0>)

Bases: Message

evaluation_description: str = <object object>

evaluation_result_type: EvaluationResultType = <object object>

few_shot_examples: List[GenerationEvaluationResult] = <object object>

model: str = <object object>

class evalquiz_proto.shared.generated.LectureMaterial(reference: str = <object object at 0x7fabb3fd71a0>, url: Optional[str] = None, hash: str = <object object at 0x7fabb3fd71a0>, file_type: str = <object object at 0x7fabb3fd71a0>, page_filter: Optional[ForwardRef('PageFilter')] = None)

Bases: Message

file_type: str = <object object>

hash: str = <object object>

page_filter: PageFilter | None = None

reference: str = <object object>

url: str | None = None

class evalquiz_proto.shared.generated.ListOfStrings(values: List[str] = <object object at 0x7fabb3fd71a0>)

Bases: Message

values: List[str] = <object object>

class evalquiz_proto.shared.generated.MaterialServerBase

Bases: ServiceBase

async delete_material(string: String) → Empty

async get_material(string: String) → AsyncIterator[MaterialUploadData]

async get_material_hashes(empty: Empty) → ListOfStrings

async get_material_name(string: String) → String

async upload_material(material_upload_data_iterator: AsyncIterator[MaterialUploadData]) → Empty

class evalquiz_proto.shared.generated.MaterialServerStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async delete_material(string: String, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → Empty

async get_material(string: String, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[MaterialUploadData]

async get_material_hashes(empty: Empty, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → ListOfStrings

async get_material_name(string: String, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → String

async upload_material(material_upload_data_iterator: AsyncIterable[MaterialUploadData] | Iterable[MaterialUploadData], *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → Empty

class evalquiz_proto.shared.generated.MaterialUploadData(metadata: 'Metadata' = <object object at 0x7fabb3fd71a0>, data: bytes = <object object at 0x7fabb3fd71a0>)

Bases: Message

data: bytes = <object object>

metadata: Metadata = <object object>

class evalquiz_proto.shared.generated.Metadata(mimetype: str = <object object at 0x7fabb3fd71a0>, name: str = <object object at 0x7fabb3fd71a0>)

Bases: Message

mimetype: str = <object object>

name: str = <object object>

class evalquiz_proto.shared.generated.Metric(reference: str = <object object at 0x7fabb3fd71a0>, mode: Optional[ForwardRef('Mode')] = None, evaluation: 'Evaluation' = <object object at 0x7fabb3fd71a0>)

Bases: Message

evaluation: Evaluation = <object object>

mode: Mode | None = None

reference: str = <object object>

class evalquiz_proto.shared.generated.Mode(complete: 'Complete' = <object object at 0x7fabb3fd71a0>, overwrite: 'Overwrite' = <object object at 0x7fabb3fd71a0>, by_metrics: 'ByMetrics' = <object object at 0x7fabb3fd71a0>)

Bases: Message

by_metrics: ByMetrics = <object object>

complete: Complete = <object object>

overwrite: Overwrite = <object object>

class evalquiz_proto.shared.generated.ModuleStatus(value)

Bases: Enum

An enumeration.

FAILED = 2

IDLE = 0

RUNNING = 1

SUCCESS = 3

class evalquiz_proto.shared.generated.MultipleChoice(question_text: str = <object object at 0x7fabb3fd71a0>, answer_text: str = <object object at 0x7fabb3fd71a0>, distractor_text: List[str] = <object object at 0x7fabb3fd71a0>)

Bases: Message

answer_text: str = <object object>

distractor_text: List[str] = <object object>

question_text: str = <object object>

class evalquiz_proto.shared.generated.MultipleResponse(question_text: str = <object object at 0x7fabb3fd71a0>, answer_texts: List[str] = <object object at 0x7fabb3fd71a0>, distractor_texts: List[str] = <object object at 0x7fabb3fd71a0>)

Bases: Message

answer_texts: List[str] = <object object>

distractor_texts: List[str] = <object object>

question_text: str = <object object>

class evalquiz_proto.shared.generated.Overwrite

Bases: Message

class evalquiz_proto.shared.generated.PageFilter(lower_bound: int = <object object at 0x7fabb3fd71a0>, upper_bound: int = <object object at 0x7fabb3fd71a0>)

Bases: Message

lower_bound: int = <object object>

upper_bound: int = <object object>

class evalquiz_proto.shared.generated.PipelineModule(name: str = <object object at 0x7fabb3fd71a0>, input_datatype: str = <object object at 0x7fabb3fd71a0>, output_datatype: str = <object object at 0x7fabb3fd71a0>)

Bases: Message

input_datatype: str = <object object>

name: str = <object object>

output_datatype: str = <object object>

class evalquiz_proto.shared.generated.PipelineResult(internal_config: 'InternalConfig' = <object object at 0x7fabb3fd71a0>)

Bases: Message

internal_config: InternalConfig = <object object>

class evalquiz_proto.shared.generated.PipelineServerBase

Bases: ServiceBase

async iterate_config(internal_config: InternalConfig) → AsyncIterator[PipelineStatus]

class evalquiz_proto.shared.generated.PipelineServerStub(channel: Channel, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: Mapping[str, str | bytes] | Collection[Tuple[str, str | bytes]] | None = None)

Bases: ServiceStub

async iterate_config(internal_config: InternalConfig, *, timeout: float | None = None, deadline: Deadline | None = None, metadata: MetadataLike | None = None) → AsyncIterator[PipelineStatus]

class evalquiz_proto.shared.generated.PipelineStatus(result: Optional[ForwardRef('PipelineResult')] = None, batch_status: List[ForwardRef('BatchStatus')] = <object object at 0x7fabb3fd71a0>)

Bases: Message

batch_status: List[BatchStatus] = <object object>

result: PipelineResult | None = None

class evalquiz_proto.shared.generated.Question(question_type: 'QuestionType' = <object object at 0x7fabb3fd71a0>, generation_result: Optional[ForwardRef('GenerationResult')] = None, evaluation_results: Dict[str, ForwardRef('EvaluationResult')] = <object object at 0x7fabb3fd71a0>)

Bases: Message

evaluation_results: Dict[str, EvaluationResult] = <object object>

generation_result: GenerationResult | None = None

question_type: QuestionType = <object object>

class evalquiz_proto.shared.generated.QuestionType(value)

Bases: Enum

An enumeration.

MULTIPLE_CHOICE = 0

MULTIPLE_RESPONSE = 1

class evalquiz_proto.shared.generated.Relationship(value)

Bases: Enum

An enumeration.

COMPLEX = 3

DIFFERENCES = 1

ORDER = 2

SIMILARITY = 0

class evalquiz_proto.shared.generated.String(value: str = <object object at 0x7fabb3fd71a0>)

Bases: Message

value: str = <object object>

class evalquiz_proto.shared.generated.ValueRange(lower_bound: float = <object object at 0x7fabb3fd71a0>, upper_bound: float = <object object at 0x7fabb3fd71a0>)

Bases: Message

lower_bound: float = <object object>

upper_bound: float = <object object>