Question¶
- pydantic model schemas.question.FaqQuestionBase¶
Base class for Question
Show JSON schema
{ "title": "FaqQuestionBase", "description": "Base class for Question", "type": "object", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" } }, "required": [ "text", "url" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- field doctype: str | None = None¶
Type of the document
- field hyq: List[str] | None = None¶
Hypothetical queries associated to the document text
- field hyq_declarative: List[str] | None = None¶
Declarative hypothetical queries associated to the document text
- field language: str | None = None¶
Language of the question and answer text
- field organizations: List[str] | None = None¶
Organizations to which the question belongs
- field subtopics: List[str] | None = None¶
Subtopics of the document text
- field summary: str | None = None¶
Summary of the document text
- field tags: List[str] | None = None¶
Tags of the document text
- field text: str [Required]¶
Content of the question
- field url: str [Required]¶
URL where the question-answer was found
- pydantic model schemas.question.FaqQuestionCreate¶
Create class for Question
Show JSON schema
{ "title": "FaqQuestionCreate", "description": "Create class for Question", "type": "object", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "answer": { "title": "Answer", "type": "string" }, "text_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Text Embedding" }, "answer_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Answer Embedding" }, "subtopics_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics Embedding" }, "tags_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags Embedding" }, "summary_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Summary Embedding" }, "hyq_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Embedding" }, "hyq_declarative_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative Embedding" }, "source": { "title": "Source", "type": "string" } }, "required": [ "text", "url", "answer", "source" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- field answer: str [Required]¶
Text of the answer to the question
- field answer_embedding: list[float] | None = None¶
- field doctype: str | None = None¶
Type of the document
- field hyq: List[str] | None = None¶
Hypothetical queries associated to the document text
- field hyq_declarative: List[str] | None = None¶
Declarative hypothetical queries associated to the document text
- field hyq_declarative_embedding: list[float] | None = None¶
- field hyq_embedding: list[float] | None = None¶
- field language: str | None = None¶
Language of the question and answer text
- field organizations: List[str] | None = None¶
Organizations to which the question belongs
- field source: str [Required]¶
How the question-answer was found, can be a URL or a file path for example
- field subtopics: List[str] | None = None¶
Subtopics of the document text
- field subtopics_embedding: list[float] | None = None¶
- field summary: str | None = None¶
Summary of the document text
- field summary_embedding: list[float] | None = None¶
- field tags: List[str] | None = None¶
Tags of the document text
- field tags_embedding: list[float] | None = None¶
- field text: str [Required]¶
Content of the question
- field text_embedding: list[float] | None = None¶
- field url: str [Required]¶
URL where the question-answer was found
- pydantic model schemas.question.FaqQuestionsCreate¶
Create class for Question
Show JSON schema
{ "title": "FaqQuestionsCreate", "description": "Create class for Question", "type": "object", "properties": { "objects": { "items": { "$ref": "#/$defs/FaqQuestionCreate" }, "title": "Objects", "type": "array" } }, "$defs": { "FaqQuestionCreate": { "description": "Create class for Question", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "answer": { "title": "Answer", "type": "string" }, "text_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Text Embedding" }, "answer_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Answer Embedding" }, "subtopics_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics Embedding" }, "tags_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags Embedding" }, "summary_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Summary Embedding" }, "hyq_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Embedding" }, "hyq_declarative_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative Embedding" }, "source": { "title": "Source", "type": "string" } }, "required": [ "text", "url", "answer", "source" ], "title": "FaqQuestionCreate", "type": "object" } }, "required": [ "objects" ] }
- field objects: list[FaqQuestionCreate] [Required]¶
A list of questions to add to the database
- pydantic model schemas.question.FaqQuestionItem¶
Upsert class for Question in Survey Pipeline
Show JSON schema
{ "title": "FaqQuestionItem", "description": "Upsert class for Question in Survey Pipeline", "type": "object", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "answer": { "title": "Answer", "type": "string" }, "text_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Text Embedding" }, "answer_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Answer Embedding" }, "subtopics_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics Embedding" }, "tags_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags Embedding" }, "summary_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Summary Embedding" }, "hyq_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Embedding" }, "hyq_declarative_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative Embedding" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Source" }, "id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Id" } }, "required": [ "text", "url", "answer" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- field answer: str [Required]¶
Text of the answer to the question
- field answer_embedding: list[float] | None = None¶
- field doctype: str | None = None¶
Type of the document
- field hyq: List[str] | None = None¶
Hypothetical queries associated to the document text
- field hyq_declarative: List[str] | None = None¶
Declarative hypothetical queries associated to the document text
- field hyq_declarative_embedding: list[float] | None = None¶
- field hyq_embedding: list[float] | None = None¶
- field id: int | None = None¶
- field language: str | None = None¶
Language of the question and answer text
- field organizations: List[str] | None = None¶
Organizations to which the question belongs
- field source: str | None = None¶
How the question-answer was found, can be a URL or a file path for example
- field subtopics: List[str] | None = None¶
Subtopics of the document text
- field subtopics_embedding: list[float] | None = None¶
- field summary: str | None = None¶
Summary of the document text
- field summary_embedding: list[float] | None = None¶
- field tags: List[str] | None = None¶
Tags of the document text
- field tags_embedding: list[float] | None = None¶
- field text: str [Required]¶
Content of the question
- field text_embedding: list[float] | None = None¶
- field url: str [Required]¶
URL where the question-answer was found
- pydantic model schemas.question.FaqQuestionUpdate¶
Update class for Question
Show JSON schema
{ "title": "FaqQuestionUpdate", "description": "Update class for Question", "type": "object", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "source_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Source Id" }, "text_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Text Embedding" }, "subtopics_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics Embedding" }, "tags_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags Embedding" }, "summary_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Summary Embedding" }, "hyq_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Embedding" }, "hyq_declarative_embedding": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative Embedding" } }, "required": [ "text", "url" ] }
- Config:
arbitrary_types_allowed: bool = True
- Fields:
- field doctype: str | None = None¶
Type of the document
- field hyq: List[str] | None = None¶
Hypothetical queries associated to the document text
- field hyq_declarative: List[str] | None = None¶
Declarative hypothetical queries associated to the document text
- field hyq_declarative_embedding: list[float] | None = None¶
- field hyq_embedding: list[float] | None = None¶
- field language: str | None = None¶
Language of the question and answer text
- field organizations: List[str] | None = None¶
Organizations to which the question belongs
- field source_id: int | None = None¶
- field subtopics: List[str] | None = None¶
Subtopics of the document text
- field subtopics_embedding: list[float] | None = None¶
- field summary: str | None = None¶
Summary of the document text
- field summary_embedding: list[float] | None = None¶
- field tags: List[str] | None = None¶
Tags of the document text
- field tags_embedding: list[float] | None = None¶
- field text: str [Required]¶
Content of the question
- field text_embedding: list[float] | None = None¶
- field url: str [Required]¶
URL where the question-answer was found
- pydantic model schemas.question.FaqQuestion¶
Show JSON schema
{ "title": "FaqQuestion", "type": "object", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Language" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "id": { "title": "Id", "type": "integer" }, "answer": { "$ref": "#/$defs/DocumentBase" } }, "$defs": { "DocumentBase": { "description": "Base class for Document", "properties": { "text": { "title": "Text", "type": "string" }, "url": { "title": "Url", "type": "string" }, "language": { "default": null, "title": "Language", "type": "string" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Tags" }, "subtopics": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Subtopics" }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Summary" }, "hyq": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq" }, "hyq_declarative": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Hyq Declarative" }, "doctype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Doctype" }, "organizations": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "title": "Organizations" }, "user_uuid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "User Uuid" } }, "required": [ "text", "url" ], "title": "DocumentBase", "type": "object" } }, "required": [ "text", "url", "id", "answer" ] }
- Config:
arbitrary_types_allowed: bool = True
from_attributes: bool = True
- Fields:
- field answer: DocumentBase [Required]¶
Related answer from Document table
- field doctype: str | None = None¶
Type of the document
- field hyq: List[str] | None = None¶
Hypothetical queries associated to the document text
- field hyq_declarative: List[str] | None = None¶
Declarative hypothetical queries associated to the document text
- field id: int [Required]¶
- field language: str | None = None¶
Language of the question and answer text
- field organizations: List[str] | None = None¶
Organizations to which the question belongs
- field subtopics: List[str] | None = None¶
Subtopics of the document text
- field summary: str | None = None¶
Summary of the document text
- field tags: List[str] | None = None¶
Tags of the document text
- field text: str [Required]¶
Content of the question
- field url: str [Required]¶
URL where the question-answer was found