graphai.api.image.schemas module

class graphai.api.image.schemas.RetrieveImageURLRequest(*, url: str, force: bool = False, no_cache: bool = False)

Bases: BaseModel

url: str

force: bool

no_cache: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.UploadedFileOriginInfo(*, id: str, name: str)

Bases: BaseModel

id: str

name: str

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.UploadImageRequest(*, contents: str, file_extension: Literal['bmp', 'png', 'jpg', 'jpeg', 'pdf'], origin: Literal['gdrive', 'localdisk'], origin_info: UploadedFileOriginInfo, force: bool = False, no_cache: bool = False)

Bases: BaseModel

contents: str

file_extension: Literal['bmp', 'png', 'jpg', 'jpeg', 'pdf']

origin: Literal['gdrive', 'localdisk']

origin_info: UploadedFileOriginInfo

force: bool

no_cache: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.RetrieveImageURLResponseInner(*, token: str | None = None, token_status: TokenStatus | None = None, token_size: int | None = None, fresh: bool, successful: bool, error: str | None = None)

Bases: BaseModel

token: str | None

token_status: TokenStatus | None

token_size: int | None

fresh: bool

successful: bool

error: str | None

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.RetrieveImageURLResponse(*, task_id: str, task_name: str | None = None, task_status: str, task_result: RetrieveImageURLResponseInner | None)

Bases: TaskStatusResponse

task_result: RetrieveImageURLResponseInner | None

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ImageFingerprintRequest(*, token: str, force: bool = False)

Bases: BaseModel

token: str

force: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ImageFingerprintTaskResponse(*, result: str | None = None, fresh: bool, closest_token: str | None = None, closest_token_origin: str | None = None, successful: bool)

Bases: BaseModel

result: str | None

fresh: bool

closest_token: str | None

closest_token_origin: str | None

successful: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ImageFingerprintResponse(*, task_id: str, task_name: str | None = None, task_status: str, task_result: ImageFingerprintTaskResponse | None)

Bases: TaskStatusResponse

task_result: ImageFingerprintTaskResponse | None

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ExtractTextRequest(*, token: str, method: Literal['google', 'tesseract', 'openai', 'gemini'] = 'google', force: bool = False, no_cache: bool = False, google_api_token: str | None = None, openai_api_token: str | None = None, gemini_api_token: str | None = None, pdf_in_pages: bool = True, model_type: str | None = None)

Bases: BaseModel

token: str

method: Literal['google', 'tesseract', 'openai', 'gemini']

force: bool

no_cache: bool

google_api_token: str | None

openai_api_token: str | None

gemini_api_token: str | None

pdf_in_pages: bool

model_type: str | None

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.IndividualOCRResult(*, method: str, text: str)

Bases: BaseModel

method: str

text: str

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ExtractTextTaskResponse(*, result: List[IndividualOCRResult] | None = None, language: str | None = None, fresh: bool, successful: bool)

Bases: BaseModel

result: List[IndividualOCRResult] | None

language: str | None

fresh: bool

successful: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.ExtractTextResponse(*, task_id: str, task_name: str | None = None, task_status: str, task_result: ExtractTextTaskResponse | None)

Bases: TaskStatusResponse

task_result: ExtractTextTaskResponse | None

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.DetectOCRLanguageTaskResponse(*, language: str | None = None, fresh: bool, successful: bool)

Bases: BaseModel

language: str | None

fresh: bool

successful: bool

model_config: ClassVar[ConfigDict] = {}

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

class graphai.api.image.schemas.DetectOCRLanguageResponse(*, task_id: str, task_name: str | None = None, task_status: str, task_result: DetectOCRLanguageTaskResponse | None)

Bases: TaskStatusResponse

task_result: DetectOCRLanguageTaskResponse | None

model_config: ClassVar[ConfigDict] = {}

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