genai.schema package

pydantic model genai.schema.AIMessage

Bases: BaseMessage

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field role: ChatRole = ChatRole.ASSISTANT

class genai.schema.ApiEndpoint

Bases: object

class_name: str

method: str

path: str

version: str

class genai.schema.ApiKeyRegenerateCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/api_key/regenerate'

version: str = '2023-11-22'

pydantic model genai.schema.ApiKeyRegenerateCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: ApiKeyResult | None = None

pydantic model genai.schema.ApiKeyResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field generated_at: AwareDatetime [Required]

field last_used_at: AwareDatetime | None = None

field value: str [Required]

class genai.schema.ApiKeyRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/api_key'

version: str = '2023-11-22'

pydantic model genai.schema.ApiKeyRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: ApiKeyResult | None = None

pydantic model genai.schema.BadRequestResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions [Required]

field status_code: Literal[400] = 400

pydantic model genai.schema.BaseErrorExtension

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: str [Required]

field state: dict[str, Any] | None = None

pydantic model genai.schema.BaseErrorResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field error: str [Required]

field extensions: BaseErrorExtension [Required]

field message: str [Required]

field status_code: int [Required]

pydantic model genai.schema.BaseMessage

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field content: str [Required]

field files: list[MessageFile] | None = None

field role: ChatRole [Required]

pydantic model genai.schema.BaseTokens

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field logprob: float | str | None = None

field rank: int | None = None

field text: str | None = None

field top_tokens: list[GeneratedToken] | None = None

class genai.schema.ChatRole

Bases: str, Enum

An enumeration.

ASSISTANT = 'assistant'

SYSTEM = 'system'

USER = 'user'

pydantic model genai.schema.ConcurrencyLimit

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field limit: int [Required]

field remaining: int [Required]

class genai.schema.DecodingMethod

Bases: str, Enum

An enumeration.

GREEDY = 'greedy'

SAMPLE = 'sample'

class genai.schema.DeploymentCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/deployments'

version: str = '2023-11-22'

pydantic model genai.schema.DeploymentCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: DeploymentResult [Required]

class genai.schema.DeploymentIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/deployments/{id}'

version: str = '2023-11-22'

class genai.schema.DeploymentIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/deployments/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.DeploymentIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: DeploymentResult [Required]

pydantic model genai.schema.DeploymentResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field deployed_at: AwareDatetime | None = None

field expires_at: AwareDatetime | None = None

field id: str [Required]

field status: DeploymentStatus [Required]

field tune_id: str | None = None

field updated_at: AwareDatetime [Required]

class genai.schema.DeploymentRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/deployments'

version: str = '2023-11-22'

pydantic model genai.schema.DeploymentRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[DeploymentResult] [Required]

field total_count: float [Required]

class genai.schema.DeploymentStatus

Bases: str, Enum

An enumeration.

EXPIRED = 'expired'

FAILED = 'failed'

INITIALIZING = 'initializing'

QUEUED = 'queued'

READY = 'ready'

class genai.schema.EvaluationCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/evaluations'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationResult [Required]

pydantic model genai.schema.EvaluationExperiment

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field description: str | None = None

field evaluations_count: float [Required]

field file: EvaluationFile | None = None

field id: str [Required]

field name: str [Required]

field task: EvaluationTask [Required]

field template_id: str [Required]

class genai.schema.EvaluationExperimentCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/evaluations/experiments'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationExperimentCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationExperiment [Required]

class genai.schema.EvaluationExperimentIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/beta/evaluations/experiments/{id}'

version: str = '2023-11-22'

class genai.schema.EvaluationExperimentIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/experiments/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationExperimentIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationResult [Required]

class genai.schema.EvaluationExperimentRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/experiments'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationExperimentRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[EvaluationExperiment] [Required]

field total_count: int [Required]

class genai.schema.EvaluationExperimentSortBy

Bases: str, Enum

An enumeration.

ID = 'id'

NAME = 'name'

TEMPLATE = 'template'

pydantic model genai.schema.EvaluationFieldOperation

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field type: EvaluationOperationType [Required]

pydantic model genai.schema.EvaluationFile

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field bytes: int [Required]

field created_at: AwareDatetime [Required]

field file_name: str [Required]

field id: str [Required]

field metadata: FileMetadata | None = None

class genai.schema.EvaluationIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/beta/evaluations/{id}'

version: str = '2023-11-22'

class genai.schema.EvaluationIdInstanceResultRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/{id}/instance_results'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationIdInstanceResultRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[EvaluationInstanceResult] [Required]

field total_count: int [Required]

class genai.schema.EvaluationIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationResult [Required]

pydantic model genai.schema.EvaluationInstanceResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field generation_info: dict[str, Any] | None = None

field score: dict[str, Any] [Required]

pydantic model genai.schema.EvaluationLimit

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field concurrency: ConcurrencyLimit [Required]

class genai.schema.EvaluationLimitRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/limits'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationLimitRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationLimit [Required]

class genai.schema.EvaluationOperationType

Bases: str, Enum

An enumeration.

ADD_FIELDS = 'add_fields'

RENAME_FIELDS = 'rename_fields'

SHUFFLE = 'shuffle'

pydantic model genai.schema.EvaluationParentTask

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field name: str [Required]

class genai.schema.EvaluationPreviewCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/evaluations/preview'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationPreviewCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[EvaluationInstanceResult] [Required]

field total_count: int [Required]

pydantic model genai.schema.EvaluationPrompt

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field input: str | None = None

field metadata: dict[str, Any] | None = None

field name: str [Required]

pydantic model genai.schema.EvaluationResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field description: str | None = None

field experiment_id: str [Required]

field file: EvaluationFile | None = None

field finished_at: AwareDatetime | None = None

field id: str [Required]

field model_id: str [Required]

field name: str [Required]

field parameters: dict[str, Any] | None = None

field prompt: EvaluationPrompt [Required]

field result: dict[str, Any] [Required]

field started_at: AwareDatetime | None = None

field status: EvaluationStatus [Required]

field status_message: str | None = None

field task_id: str [Required]

field template_id: str [Required]

field template_name: str [Required]

class genai.schema.EvaluationRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[EvaluationResult] [Required]

field total_count: int [Required]

class genai.schema.EvaluationSortBy

Bases: str, Enum

An enumeration.

ID = 'id'

NAME = 'name'

TEMPLATE = 'template'

class genai.schema.EvaluationStatus

Bases: str, Enum

An enumeration.

COMPLETED = 'completed'

FAILED = 'failed'

PENDING = 'pending'

QUEUED = 'queued'

RUNNING = 'running'

pydantic model genai.schema.EvaluationTask

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field name: str [Required]

field parent_task: EvaluationParentTask | None = None

pydantic model genai.schema.EvaluationTemplate

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field dataset_fields: dict[str, Any] [Required]

field default_prompt_ids: list[str] | None = None

field id: str [Required]

field metrics: list[list[Metric] | Metrics] [Required]

field name: str [Required]

field postprocessors: list[str] [Required]

field task: EvaluationTask | None = None

class genai.schema.EvaluationTemplateIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/templates/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationTemplateIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: EvaluationTemplate [Required]

class genai.schema.EvaluationTemplateRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/evaluations/templates'

version: str = '2023-11-22'

pydantic model genai.schema.EvaluationTemplateRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[EvaluationTemplate] [Required]

pydantic model genai.schema.Extensions

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['INVALID_INPUT'] = 'INVALID_INPUT'

pydantic model genai.schema.Extensions1

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['INTERNAL_SERVER_ERROR'] = 'INTERNAL_SERVER_ERROR'

pydantic model genai.schema.Extensions2

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['NOT_FOUND'] = 'NOT_FOUND'

pydantic model genai.schema.Extensions3

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['TOO_MANY_REQUESTS'] = 'TOO_MANY_REQUESTS'

pydantic model genai.schema.Extensions4

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['AUTH_ERROR'] = 'AUTH_ERROR'

pydantic model genai.schema.Extensions5

Bases: BaseErrorExtension

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field code: Literal['SERVICE_UNAVAILABLE'] = 'SERVICE_UNAVAILABLE'

class genai.schema.FileCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/files'

version: str = '2024-05-13'

pydantic model genai.schema.FileCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FileResult [Required]

pydantic model genai.schema.FileDescendant

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

pydantic model genai.schema.FileFormat

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: int [Required]

field name: str [Required]

class genai.schema.FileIdContentRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/files/{id}/content'

version: str = '2023-11-22'

class genai.schema.FileIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/files/{id}'

version: str = '2023-11-22'

class genai.schema.FileIdPatchEndpoint

Bases: ApiEndpoint

method: str = 'PATCH'

path: str = '/v2/files/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.FileIdPatchResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FileResult [Required]

class genai.schema.FileIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/files/{id}'

version: str = '2024-05-13'

pydantic model genai.schema.FileIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FileResult [Required]

class genai.schema.FileListSortBy

Bases: str, Enum

An enumeration.

CREATED_AT = 'created_at'

NAME = 'name'

pydantic model genai.schema.FileMetadata

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field stats: FileMetadataStats [Required]

pydantic model genai.schema.FileMetadataStats

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field columns: list[str] [Required]

field records_count: float [Required]

class genai.schema.FilePurpose

Bases: str, Enum

An enumeration.

EXTRACTION = 'extraction'

GENERIC_STRUCTURED = 'generic_structured'

TEMPLATE = 'template'

TUNE = 'tune'

TUNE_IMPORT = 'tune_import'

pydantic model genai.schema.FileResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field bytes: int [Required]

field created_at: AwareDatetime [Required]

field descendants: list[FileDescendant] | None = None

field file_formats: list[FileFormat] | None = None

field file_name: str [Required]

field id: str [Required]

field metadata: FileMetadata | None = None

field origin: FileDescendant | None = None

field purpose: FilePurpose [Required]

field storage_provider_location: StorageProviderLocation [Required]

field updated_at: AwareDatetime [Required]

class genai.schema.FileRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/files'

version: str = '2024-05-13'

pydantic model genai.schema.FileRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[FileResult] [Required]

field total_count: int [Required]

class genai.schema.FolderCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/folders'

version: str = '2023-11-22'

pydantic model genai.schema.FolderCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FolderResult [Required]

class genai.schema.FolderIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/folders/{id}'

version: str = '2023-11-22'

class genai.schema.FolderIdPatchEndpoint

Bases: ApiEndpoint

method: str = 'PATCH'

path: str = '/v2/folders/{id}'

version: str = '2024-01-10'

pydantic model genai.schema.FolderIdPatchResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FolderResult [Required]

class genai.schema.FolderIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/folders/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.FolderIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FolderResult [Required]

class genai.schema.FolderIdUpdateEndpoint

Bases: ApiEndpoint

method: str = 'PUT'

path: str = '/v2/folders/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.FolderIdUpdateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: FolderResult [Required]

pydantic model genai.schema.FolderResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field id: str [Required]

field name: str [Required]

field prompt_ids: list[str] | None = None

class genai.schema.FolderRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/folders'

version: str = '2023-11-22'

pydantic model genai.schema.FolderRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[FolderResult] [Required]

field total_count: int [Required]

pydantic model genai.schema.GeneratedToken

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field logprob: float | str | None = None

field text: str | None = None

pydantic model genai.schema.HAPOptions

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field send_tokens: bool | None = False

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

pydantic model genai.schema.HumanMessage

Bases: BaseMessage

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field role: ChatRole = ChatRole.USER

pydantic model genai.schema.Input

Bases: RootModel[list[Any]]

field root: list[Any] [Required]

Constraints:

• max_length = 20

pydantic model genai.schema.InternalServerErrorResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions1 [Required]

field status_code: Literal[500] = 500

pydantic model genai.schema.LengthPenalty

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field decay_factor: float | None = None

Represents the factor of exponential decay and must be > 1.0. Larger values correspond to more aggressive decay.

Constraints:

• gt = 1.0

field start_index: int | None = None

A number of generated tokens after which this should take effect.

Constraints:

• ge = 1

pydantic model genai.schema.MessageFile

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field content: str | None = None

field id: str | None = None

pydantic model genai.schema.Metric

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field description: str [Required]

field id: str [Required]

field name: str [Required]

pydantic model genai.schema.Metrics

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

pydantic model genai.schema.ModelFacet

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field name: str [Required]

field type: ModelFacetType [Required]

class genai.schema.ModelFacetType

Bases: str, Enum

An enumeration.

INDUSTRY = 'industry'

LANGUAGE = 'language'

MODEL_TYPE = 'model_type'

pydantic model genai.schema.ModelFamily

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field description: str | None = None

field id: int [Required]

field name: str [Required]

field prompt_example: str | None = None

field short_description: str | None = None

field system_prompt: str | None = None

class genai.schema.ModelIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/models/{id}'

version: str = '2024-01-30'

pydantic model genai.schema.ModelIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: ModelIdRetrieveResult [Required]

pydantic model genai.schema.ModelIdRetrieveResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field description: str | None = None

field developer: str | None = None

field disabled: bool [Required]

field facets: list[ModelFacet] | None = None

field id: str [Required]

field is_live: bool [Required]

field label: str [Required]

field model_family: ModelFamily [Required]

field name: str [Required]

field preferred: bool [Required]

field prompt_builder_example: dict[str, Any] | None = None

field size: str [Required]

field source_model_id: str | None = None

field system_prompt: str | None = None

field system_prompt_id: int | None = None

field tags: list[str] [Required]

field tasks: list[Tasks] [Required]

field token_limits: list[ModelTokenLimits] [Required]

field warning: str | None = None

class genai.schema.ModelRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/models'

version: str = '2023-11-22'

pydantic model genai.schema.ModelRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[ModelRetrieveResults] [Required]

field total_count: int [Required]

pydantic model genai.schema.ModelRetrieveResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field facets: list[ModelFacet] | None = None

field id: str [Required]

field is_live: bool [Required]

field label: str [Required]

field name: str [Required]

field size: str [Required]

field source_model_id: str | None = None

field task_ids: list[str] [Required]

field token_limits: list[ModelTokenLimits] [Required]

field warning: str | None = None

pydantic model genai.schema.ModelTokenLimits

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field beam_width: int [Required]

field token_limit: int [Required]

class genai.schema.ModelType

Bases: str, Enum

An enumeration.

MODEL = 'model'

TUNE = 'tune'

pydantic model genai.schema.ModerationHAP

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input: ModerationHAPInput | None = None

field output: ModerationHAPOutput | None = None

pydantic model genai.schema.ModerationHAPInput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool | None = False

Detects HAP (hateful, abusive, or profane language).

field send_tokens: bool | None = False

field threshold: float | None = 0.75

The higher the number, the more confidence that the sentence contains HAP. The threshold allows you to modify how much confidence is needed for the sentence to be flagged as containing HAP.

Constraints:

• ge = 0.01

• le = 0.99

• multiple_of = 0.01

pydantic model genai.schema.ModerationHAPOutput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool | None = False

Detects HAP (hateful, abusive, or profane language).

field send_tokens: bool | None = False

field threshold: float | None = 0.75

The higher the number, the more confidence that the sentence contains HAP. The threshold allows you to modify how much confidence is needed for the sentence to be flagged as containing HAP.

Constraints:

• ge = 0.01

• le = 0.99

• multiple_of = 0.01

pydantic model genai.schema.ModerationImplicitHate

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input: ModerationImplicitHateInput | None = None

field output: ModerationImplicitHateOutput | None = None

pydantic model genai.schema.ModerationImplicitHateInput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool [Required]

field send_tokens: bool | None = None

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

pydantic model genai.schema.ModerationImplicitHateOutput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool [Required]

field send_tokens: bool | None = None

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

pydantic model genai.schema.ModerationParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field hap: ModerationHAP | None = None

field social_bias: ModerationSocialBias | None = None

pydantic model genai.schema.ModerationPosition

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field end: int [Required]

field start: int [Required]

pydantic model genai.schema.ModerationSocialBias

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input: ModerationSocialBiasInput | None = None

field output: ModerationSocialBiasOutput | None = None

pydantic model genai.schema.ModerationSocialBiasInput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool | None = False

Detects social bias.

field send_tokens: bool | None = False

field threshold: float | None = 0.75

The higher the number, the more confidence that the sentence contains social bias. The threshold allows you to modify how much confidence is needed for the sentence to be flagged as containing social bias.

Constraints:

• ge = 0.01

• le = 0.99

• multiple_of = 0.01

pydantic model genai.schema.ModerationSocialBiasOutput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool | None = False

Detects social bias.

field send_tokens: bool | None = False

field threshold: float | None = 0.75

The higher the number, the more confidence that the sentence contains social bias. The threshold allows you to modify how much confidence is needed for the sentence to be flagged as containing social bias.

Constraints:

• ge = 0.01

• le = 0.99

• multiple_of = 0.01

pydantic model genai.schema.ModerationStigma

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input: ModerationStigmaInput | None = None

field output: ModerationStigmaOutput | None = None

pydantic model genai.schema.ModerationStigmaInput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool [Required]

field send_tokens: bool | None = None

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

pydantic model genai.schema.ModerationStigmaOutput

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field enabled: bool [Required]

field send_tokens: bool | None = None

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

pydantic model genai.schema.ModerationTokens

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field index: int | None = None

field score: float | None = None

field token: str | None = None

pydantic model genai.schema.NotFoundResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions2 [Required]

field status_code: Literal[404] = 404

class genai.schema.PromptCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/prompts'

version: str = '2024-03-19'

pydantic model genai.schema.PromptCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: PromptResult [Required]

class genai.schema.PromptIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/prompts/{id}'

version: str = '2023-11-22'

class genai.schema.PromptIdPatchEndpoint

Bases: ApiEndpoint

method: str = 'PATCH'

path: str = '/v2/prompts/{id}'

version: str = '2024-03-19'

pydantic model genai.schema.PromptIdPatchResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: PromptResult [Required]

class genai.schema.PromptIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/prompts/{id}'

version: str = '2024-03-19'

pydantic model genai.schema.PromptIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: PromptResult [Required]

class genai.schema.PromptIdUpdateEndpoint

Bases: ApiEndpoint

method: str = 'PUT'

path: str = '/v2/prompts/{id}'

version: str = '2024-03-19'

pydantic model genai.schema.PromptIdUpdateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: PromptResult [Required]

class genai.schema.PromptListSortBy

Bases: str, Enum

An enumeration.

CREATED_AT = 'created_at'

ID = 'id'

MODEL = 'model'

MODEL_TASK = 'model_task'

NAME = 'name'

TYPE = 'type'

UPDATED_AT = 'updated_at'

USAGE_COUNT = 'usage_count'

class genai.schema.PromptListSource

Bases: str, Enum

An enumeration.

COMMUNITY = 'community'

EXAMPLE = 'example'

USER = 'user'

pydantic model genai.schema.PromptModerationParameters

Bases: ModerationParameters

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field hap: ModerationHAP | None = None

field implicit_hate: ModerationImplicitHate | None = None

field social_bias: ModerationSocialBias | None = None

field stigma: ModerationStigma | None = None

pydantic model genai.schema.PromptResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field author: PromptResultAuthor | None = None

field created_at: AwareDatetime [Required]

field data: dict[str, Any] | None = None

field description: str | None = None

field folder_id: str | None = None

field id: str [Required]

field input: str | None = None

field messages: list[BaseMessage] | None = None

field metadata: dict[str, Any] | None = None

field model_id: str | None = None

field moderations: PromptModerationParameters | None = None

field name: str [Required]

field output: str | None = None

field parameters: TextGenerationParameters | None = None

field prompt_id: str | None = None

field public: bool | None = None

field tags: list[PromptTag] | None = None

field task: PromptResultTask | None = None

field type: PromptType [Required]

field updated_at: AwareDatetime | None = None

field usage_count: int [Required]

pydantic model genai.schema.PromptResultAuthor

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field first_name: str | None = None

field id: int | None = None

field last_name: str | None = None

pydantic model genai.schema.PromptResultTask

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field icon: str | None = None

field id: str | None = None

field name: str | None = None

class genai.schema.PromptRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/prompts'

version: str = '2024-03-19'

pydantic model genai.schema.PromptRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[PromptResult] [Required]

field total_count: int [Required]

pydantic model genai.schema.PromptTag

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field name: str [Required]

field type: PromptTagType [Required]

class genai.schema.PromptTagType

Bases: str, Enum

An enumeration.

INDUSTRY = 'industry'

LANGUAGE = 'language'

MODEL_TYPE = 'model_type'

pydantic model genai.schema.PromptTemplateData

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field example_file_ids: list[str] | None = None

Constraints:

• min_length = 0

• max_length = 5

class genai.schema.PromptType

Bases: str, Enum

An enumeration.

COMMUNITY = 'community'

EXAMPLE = 'example'

PRIVATE = 'private'

PUBLIC = 'public'

class genai.schema.RequestApiVersion

Bases: str, Enum

An enumeration.

V0 = 'v0'

V1 = 'v1'

V2 = 'v2'

class genai.schema.RequestChatConversationIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/requests/chat/{conversation_id}'

version: str = '2023-11-22'

class genai.schema.RequestChatConversationIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/requests/chat/{conversation_id}'

version: str = '2024-03-19'

pydantic model genai.schema.RequestChatConversationIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[RequestChatConversationIdRetrieveResults] [Required]

pydantic model genai.schema.RequestChatConversationIdRetrieveResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field duration: int [Required]

field id: str [Required]

field parent_id: str | None = None

field request: RequestChatConversationIdRetrieveResultsRequest | None = None

field response: RequestChatConversationIdRetrieveResultsResponse | None = None

field status: RequestStatus [Required]

field version: RequestResultVersion | None = None

pydantic model genai.schema.RequestChatConversationIdRetrieveResultsRequest

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

pydantic model genai.schema.RequestChatConversationIdRetrieveResultsResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

class genai.schema.RequestEndpoint

Bases: str, Enum

An enumeration.

CHAT = 'chat'

COMPARE = 'compare'

GENERATE = 'generate'

class genai.schema.RequestFeedbackCategory

Bases: str, Enum

An enumeration.

CORRECT_CONTENT = 'correct_content'

CORRECT_STYLE = 'correct_style'

INACCURATE = 'inaccurate'

KNOWLEDGE_GAP = 'knowledge_gap'

NOT_RELEVANT = 'not_relevant'

OFFENSIVE_HARMFUL = 'offensive_harmful'

OTHER_CONTENT = 'other_content'

OTHER_STYLE = 'other_style'

TOO_LONG = 'too_long'

TOO_SHORT = 'too_short'

WRONG_FORMAT = 'wrong_format'

WRONG_TONE = 'wrong_tone'

pydantic model genai.schema.RequestFeedbackResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field api_request: str [Required]

field categories: list[str] [Required]

field comment: str | None = None

field contact_consent: bool [Required]

field created_at: AwareDatetime [Required]

field id: int [Required]

field updated_at: AwareDatetime [Required]

field vote: RequestFeedbackVote | None = None

class genai.schema.RequestFeedbackVote

Bases: str, Enum

An enumeration.

DOWN = 'down'

UP = 'up'

class genai.schema.RequestIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/requests/{id}'

version: str = '2023-11-22'

class genai.schema.RequestIdFeedbackCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/requests/{id}/feedback'

version: str = '2023-11-22'

pydantic model genai.schema.RequestIdFeedbackCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: RequestFeedbackResult [Required]

class genai.schema.RequestIdFeedbackRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/requests/{id}/feedback'

version: str = '2023-11-22'

pydantic model genai.schema.RequestIdFeedbackRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: RequestFeedbackResult [Required]

class genai.schema.RequestIdFeedbackUpdateEndpoint

Bases: ApiEndpoint

method: str = 'PUT'

path: str = '/v2/requests/{id}/feedback'

version: str = '2023-11-22'

pydantic model genai.schema.RequestIdFeedbackUpdateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: RequestFeedbackResult [Required]

class genai.schema.RequestOrigin

Bases: str, Enum

An enumeration.

API = 'api'

UI = 'ui'

pydantic model genai.schema.RequestResultVersion

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field api: str | None = None

field date_: date | None = None (alias 'date')

class genai.schema.RequestRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/requests'

version: str = '2023-11-22'

pydantic model genai.schema.RequestRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[RequestRetrieveResults] [Required]

field total_count: int [Required]

pydantic model genai.schema.RequestRetrieveResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field duration: int [Required]

field id: str [Required]

field request: dict[str, Any] | None = None

field response: dict[str, Any] | None = None

field status: RequestStatus [Required]

field version: RequestResultVersion | None = None

class genai.schema.RequestStatus

Bases: str, Enum

An enumeration.

ERROR = 'error'

SUCCESS = 'success'

pydantic model genai.schema.SocialBiasOptions

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field send_tokens: bool | None = False

field threshold: float | None = 0.75

Constraints:

• gt = 0.0

• lt = 1.0

class genai.schema.SortDirection

Bases: str, Enum

An enumeration.

ASC = 'asc'

DESC = 'desc'

class genai.schema.StopReason

Bases: str, Enum

An enumeration.

CANCELLED = 'cancelled'

EOS_TOKEN = 'eos_token'

ERROR = 'error'

MAX_TOKENS = 'max_tokens'

NOT_FINISHED = 'not_finished'

STOP_SEQUENCE = 'stop_sequence'

TIME_LIMIT = 'time_limit'

TOKEN_LIMIT = 'token_limit'

class genai.schema.StorageProviderLocation

Bases: str, Enum

An enumeration.

US_EAST = 'us-east'

US_SOUTH = 'us-south'

pydantic model genai.schema.SystemMessage

Bases: BaseMessage

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field role: ChatRole = ChatRole.SYSTEM

pydantic model genai.schema.SystemPrompt

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field author: SystemPromptAuthor | None = None

field content: str [Required]

field created_at: AwareDatetime [Required]

field id: int [Required]

field name: str [Required]

field type: SystemPromptType [Required]

pydantic model genai.schema.SystemPromptAuthor

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field first_name: str | None = None

field id: int [Required]

field last_name: str | None = None

class genai.schema.SystemPromptCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/system_prompts'

version: str = '2023-11-22'

pydantic model genai.schema.SystemPromptCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: SystemPrompt [Required]

class genai.schema.SystemPromptIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/system_prompts/{id}'

version: str = '2023-11-22'

class genai.schema.SystemPromptIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/system_prompts/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.SystemPromptIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: SystemPrompt [Required]

class genai.schema.SystemPromptIdUpdateEndpoint

Bases: ApiEndpoint

method: str = 'PUT'

path: str = '/v2/system_prompts/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.SystemPromptIdUpdateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: SystemPrompt [Required]

class genai.schema.SystemPromptRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/system_prompts'

version: str = '2023-11-22'

pydantic model genai.schema.SystemPromptRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[SystemPrompt] [Required]

field total_count: int [Required]

class genai.schema.SystemPromptType

Bases: str, Enum

An enumeration.

PRIVATE = 'private'

SYSTEM = 'system'

pydantic model genai.schema.Tag

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str [Required]

field name: str [Required]

field type: TagType [Required]

class genai.schema.TagRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tags'

version: str = '2023-11-22'

pydantic model genai.schema.TagRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[Tag] [Required]

class genai.schema.TagType

Bases: str, Enum

An enumeration.

INDUSTRY = 'industry'

LANGUAGE = 'language'

MODEL_TYPE = 'model_type'

class genai.schema.TaskRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tasks'

version: str = '2023-11-22'

pydantic model genai.schema.TaskRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[Tasks] [Required]

pydantic model genai.schema.Tasks

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field categorization: bool [Required]

field csv_example: str | None = None

field file_format_id: int | None = None

field id: str [Required]

field json_example: str | None = None

field jsonl_example: str | None = None

field name: str [Required]

field tune: bool [Required]

field verbalizer: str | None = None

class genai.schema.TextChatCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/chat'

version: str = '2024-03-19'

pydantic model genai.schema.TextChatCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field conversation_id: str [Required]

field created_at: AwareDatetime | None = None

field id: str | None = None

field input_parameters: dict[str, Any] | None = None

field model_id: str | None = None

field results: list[TextGenerationResult] [Required]

pydantic model genai.schema.TextChatGenerationStreamResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field generated_text: str [Required]

field generated_token_count: int [Required]

field generated_tokens: list[BaseTokens] | None = None

field input_text: str | None = None

field input_token_count: int | None = None

field input_tokens: list[BaseTokens] | None = None

field seed: float | None = None

field stop_reason: StopReason [Required]

field stop_sequence: str | None = None

class genai.schema.TextChatOutputCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/chat/output'

version: str = '2024-03-19'

pydantic model genai.schema.TextChatOutputCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: str [Required]

class genai.schema.TextChatStreamCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/chat_stream'

version: str = '2024-03-19'

pydantic model genai.schema.TextChatStreamCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field conversation_id: str [Required]

field created_at: AwareDatetime | None = None

field id: str | None = None

field input_parameters: dict[str, Any] | None = None

field model_id: str | None = None

field moderations: TextCreateResponseModeration | None = None

field results: list[TextChatGenerationStreamResult] | None = None

pydantic model genai.schema.TextClassificationCreateData

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field labels: list[str] [Required]

field text: str [Required]

class genai.schema.TextClassificationCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/text/classification'

version: str = '2023-11-22'

pydantic model genai.schema.TextClassificationCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextClassificationResult [Required]

pydantic model genai.schema.TextClassificationResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field classification_type: TextClassificationType [Required]

field log_likelihood: dict[str, float] [Required]

field model_input: str [Required]

field model_output: str [Required]

field predictions: list[str] [Required]

class genai.schema.TextClassificationType

Bases: str, Enum

An enumeration.

BINARY = 'binary'

MULTI_CLASS = 'multi_class'

MULTI_LABEL = 'multi_label'

pydantic model genai.schema.TextCreateResponseModeration

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field hap: list[TextModeration] | None = None

field social_bias: list[TextModeration] | None = None

class genai.schema.TextEmbeddingCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/embeddings'

version: str = '2024-04-15'

pydantic model genai.schema.TextEmbeddingCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field model_id: str [Required]

field results: list[_TextEmbeddingCreateResults] [Required]

pydantic model genai.schema.TextEmbeddingLimit

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field concurrency: ConcurrencyLimit [Required]

class genai.schema.TextEmbeddingLimitRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/text/embeddings/limits'

version: str = '2023-11-22'

pydantic model genai.schema.TextEmbeddingLimitRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextEmbeddingLimit [Required]

pydantic model genai.schema.TextEmbeddingParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field return_options: _TextEmbeddingCreateRequestParametersReturnOptions | None = None

field truncate_input_tokens: bool | None = None

class genai.schema.TextExtractionLimitRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/text/extraction/limits'

version: str = '2023-11-22'

class genai.schema.TextGenerationComparisonCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/generation/comparison'

version: str = '2024-03-19'

pydantic model genai.schema.TextGenerationComparisonCreateRequestRequest

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field data: PromptTemplateData | None = None

field input: str [Required]

field model_id: str | None = None

field moderations: ModerationParameters | None = None

field parameters: TextGenerationParameters | None = None

field prompt_id: str | None = None

field use_default: bool | None = None

pydantic model genai.schema.TextGenerationComparisonCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[TextGenerationComparisonCreateResults] [Required]

pydantic model genai.schema.TextGenerationComparisonCreateResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field error: Any | None = None

field parameters: TextGenerationComparisonCreateResultsParameters [Required]

field result: TextGenerationComparisonCreateResultsResult | None = None

pydantic model genai.schema.TextGenerationComparisonCreateResultsParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field length_penalty: dict[str, Any] | None = None

field model_id: str | None = None

field repetition_penalty: float | None = None

field temperature: float | None = None

field top_k: int | None = None

field top_p: float | None = None

field typical_p: float | None = None

pydantic model genai.schema.TextGenerationComparisonCreateResultsResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field id: str [Required]

field input_parameters: dict[str, Any] | None = None

field model_id: str [Required]

field results: list[TextGenerationResult] [Required]

pydantic model genai.schema.TextGenerationComparisonParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field length_penalty: list[dict[str, Any]] | None = None

Constraints:

• min_length = 1

• max_length = 10

field model_id: list[str] | None = None

Constraints:

• min_length = 1

• max_length = 10

field repetition_penalty: list[float] | None = None

Constraints:

• min_length = 1

• max_length = 10

field temperature: list[float] | None = None

Constraints:

• min_length = 1

• max_length = 10

field top_k: list[int] | None = None

Constraints:

• min_length = 1

• max_length = 10

field top_p: list[float] | None = None

Constraints:

• min_length = 1

• max_length = 10

field typical_p: list[float] | None = None

Constraints:

• min_length = 1

• max_length = 10

class genai.schema.TextGenerationCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/generation'

version: str = '2024-03-19'

pydantic model genai.schema.TextGenerationCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime [Required]

field id: str [Required]

field input_parameters: dict[str, Any] | None = None

field model_id: str [Required]

field results: list[TextGenerationResult] [Required]

class genai.schema.TextGenerationFeedbackCategory

Bases: str, Enum

An enumeration.

CORRECT_CONTENT = 'correct_content'

CORRECT_STYLE = 'correct_style'

INACCURATE = 'inaccurate'

KNOWLEDGE_GAP = 'knowledge_gap'

NOT_RELEVANT = 'not_relevant'

OFFENSIVE_HARMFUL = 'offensive_harmful'

OTHER_CONTENT = 'other_content'

OTHER_STYLE = 'other_style'

TOO_LONG = 'too_long'

TOO_SHORT = 'too_short'

WRONG_FORMAT = 'wrong_format'

WRONG_TONE = 'wrong_tone'

pydantic model genai.schema.TextGenerationFeedbackResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field api_request: str [Required]

field categories: list[str] [Required]

field comment: str | None = None

field contact_consent: bool [Required]

field created_at: AwareDatetime [Required]

field id: int [Required]

field updated_at: AwareDatetime [Required]

field vote: TextGenerationFeedbackVote | None = None

class genai.schema.TextGenerationFeedbackVote

Bases: str, Enum

An enumeration.

DOWN = 'down'

UP = 'up'

class genai.schema.TextGenerationIdFeedbackCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/generation/{id}/feedback'

version: str = '2024-02-20'

pydantic model genai.schema.TextGenerationIdFeedbackCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextGenerationFeedbackResult [Required]

class genai.schema.TextGenerationIdFeedbackRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/text/generation/{id}/feedback'

version: str = '2023-11-22'

pydantic model genai.schema.TextGenerationIdFeedbackRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextGenerationFeedbackResult [Required]

class genai.schema.TextGenerationIdFeedbackUpdateEndpoint

Bases: ApiEndpoint

method: str = 'PUT'

path: str = '/v2/text/generation/{id}/feedback'

version: str = '2024-02-20'

pydantic model genai.schema.TextGenerationIdFeedbackUpdateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextGenerationFeedbackResult [Required]

pydantic model genai.schema.TextGenerationLimit

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field concurrency: ConcurrencyLimit [Required]

class genai.schema.TextGenerationLimitRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/text/generation/limits'

version: str = '2023-11-22'

pydantic model genai.schema.TextGenerationLimitRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TextGenerationLimit [Required]

class genai.schema.TextGenerationOutputCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/generation/output'

version: str = '2024-03-19'

pydantic model genai.schema.TextGenerationOutputCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[str] [Required]

pydantic model genai.schema.TextGenerationParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field beam_width: int | None = None

At each step, or token, the algorithm keeps track of the n (off=1, 2, or 3) most probable sequences (beams) and selects the one with the highest probability. This continues until the stop sequence is met.

Constraints:

• ge = 0

• le = 3

field decoding_method: DecodingMethod | None = None

field include_stop_sequence: bool | None = None

field length_penalty: LengthPenalty | None = None

field max_new_tokens: int | None = None

Define the maximum number of tokens to generate.

Constraints:

• ge = 0

field min_new_tokens: int | None = None

If stop sequences are given, they are ignored until minimum tokens are generated.

Constraints:

• ge = 0

field random_seed: int | None = None

Controls the random sampling of the generated tokens when sampling is enabled. Setting the random seed to a the same number for each generation ensures experimental repeatability.

Constraints:

• ge = 1

• le = 4294967295

field repetition_penalty: float | None = None

The parameter for repetition penalty. 1.00 means no penalty.

Constraints:

• ge = 1.0

• le = 2.0

• multiple_of = 0.01

field return_options: TextGenerationReturnOptions | None = None

field stop_sequences: list[str] | None = None

Stop sequences are one or more strings which will cause the text generation to stop if/when they are produced as part of the output. Stop sequences encountered prior to the minimum number of tokens being generated will be ignored.

Constraints:

• min_length = 1

• max_length = 6

field temperature: float | None = None

Control the creativity of generated text. Higher values will lead to more randomly generated outputs.

Constraints:

• ge = 0.0

• le = 2.0

• multiple_of = 0.01

field time_limit: int | None = None

Time limit in milliseconds - if not completed within this time, generation will stop. The text generated so far will be returned along with the TIME_LIMIT stop reason.

field top_k: int | None = None

Set the number of highest probability vocabulary tokens to keep for top-k-filtering. Lower values make it less likely the model will go off topic.

Constraints:

• ge = 1

• le = 100

field top_p: float | None = None

If < 1.0, only the smallest set of most probable tokens with probabilities that add up to top_p or higher are used.

Constraints:

• ge = 0.0

• le = 1.0

• multiple_of = 0.01

field truncate_input_tokens: int | None = None

Truncate to this many input tokens. Can be used to avoid requests failing due to input being longer than configured limits. Zero means don’t truncate.

Constraints:

• ge = 0

field typical_p: float | None = None

Local typicality measures how similar the conditional probability of predicting a target token next is to the expected conditional probability of predicting a random token next, given the partial text already generated. If set to float < 1, the smallest set of the most locally typical tokens with probabilities that add up to typical_p or higher are kept for generation. 1.00 means a neutral value.

Constraints:

• ge = 0.01

• le = 1.0

• multiple_of = 0.01

pydantic model genai.schema.TextGenerationResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field generated_text: str [Required]

field generated_token_count: int [Required]

field generated_tokens: list[BaseTokens] | None = None

field input_text: str | None = None

field input_token_count: int | None = None

field input_tokens: list[BaseTokens] | None = None

field moderations: TextCreateResponseModeration | None = None

field seed: float | None = None

field stop_reason: StopReason [Required]

field stop_sequence: str | None = None

pydantic model genai.schema.TextGenerationReturnOptions

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field generated_tokens: bool | None = False

Include list of individual generated tokens

field input_parameters: bool | None = None

field input_text: bool | None = False

Include input text

field input_tokens: bool | None = False

Include list of input tokens

field token_logprobs: bool | None = False

Include logprob for each returned token

field token_ranks: bool | None = False

Include rank of each returned token

field top_n_tokens: int | None = None

Include top n candidate tokens at the position of each returned token

Constraints:

• ge = 0

• le = 5

class genai.schema.TextGenerationStreamCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/generation_stream'

version: str = '2024-03-19'

pydantic model genai.schema.TextGenerationStreamCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime | None = None

field id: str | None = None

field input_parameters: dict[str, Any] | None = None

field model_id: str [Required]

field moderations: TextCreateResponseModeration | None = None

field results: list[TextGenerationStreamResult] | None = None

pydantic model genai.schema.TextGenerationStreamResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field generated_text: str [Required]

field generated_token_count: int [Required]

field generated_tokens: list[BaseTokens] | None = None

field input_text: str | None = None

field input_token_count: int | None = None

field input_tokens: list[BaseTokens] | None = None

field seed: float | None = None

field stop_reason: StopReason [Required]

field stop_sequence: str | None = None

pydantic model genai.schema.TextModeration

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field flagged: bool [Required]

field position: ModerationPosition [Required]

field score: float [Required]

field success: bool [Required]

field tokens: list[ModerationTokens] | None = None

class genai.schema.TextModerationCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/moderations'

version: str = '2024-03-19'

pydantic model genai.schema.TextModerationCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[TextCreateResponseModeration] [Required]

class genai.schema.TextRerankCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/text/rerank'

version: str = '2023-11-22'

pydantic model genai.schema.TextRerankCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: _TextRerankCreateResult [Required]

pydantic model genai.schema.TextRerankParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field return_options: TextRerankReturnOptions | None = None

field truncate_input_tokens: bool | None = None

pydantic model genai.schema.TextRerankResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field score: float [Required]

pydantic model genai.schema.TextRerankReturnOptions

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field documents: bool | None = None

field query: bool | None = None

field top_n: float | None = None

Constraints:

• ge = 1.0

class genai.schema.TextSentenceSimilarityCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/text/sentence-similarity'

version: str = '2023-11-22'

pydantic model genai.schema.TextSentenceSimilarityCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[TextSentenceSimilarityCreateResult] [Required]

pydantic model genai.schema.TextSentenceSimilarityCreateResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field score: float [Required]

pydantic model genai.schema.TextSentenceSimilarityParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field truncate_input_tokens: bool | None = None

class genai.schema.TextTokenizationCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/text/tokenization'

version: str = '2024-01-10'

pydantic model genai.schema.TextTokenizationCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: str [Required]

field model_id: str [Required]

field results: list[TextTokenizationCreateResults] [Required]

pydantic model genai.schema.TextTokenizationCreateResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input_text: str | None = None

field token_count: int [Required]

field tokens: list[str] | None = None

pydantic model genai.schema.TextTokenizationParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field return_options: TextTokenizationReturnOptions | None = None

pydantic model genai.schema.TextTokenizationReturnOptions

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field input_text: bool | None = None

field tokens: bool | None = None

class genai.schema.TimeSerieForecastingCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/beta/time_series/forecasting'

version: str = '2023-11-22'

pydantic model genai.schema.TimeSerieForecastingCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: _TimeSerieForecastingCreateResult [Required]

class genai.schema.TimeSerieLimitRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/beta/time_series/limits'

version: str = '2023-11-22'

pydantic model genai.schema.TimeSerieLimitRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TimeSeriesLimit [Required]

pydantic model genai.schema.TimeSeriesLimit

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field concurrency: ConcurrencyLimit [Required]

pydantic model genai.schema.TooManyRequestsResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions3 [Required]

field status_code: Literal[429] = 429

class genai.schema.TrimMethod

Bases: str, Enum

An enumeration.

FLOATING_WINDOW = 'floating_window'

NONE = 'none'

class genai.schema.TuneAssetType

Bases: str, Enum

An enumeration.

EXPORT = 'export'

LOGS = 'logs'

VECTORS = 'vectors'

class genai.schema.TuneCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/tunes'

version: str = '2023-11-22'

pydantic model genai.schema.TuneCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TuneResult [Required]

class genai.schema.TuneFromFileCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/tunes/import'

version: str = '2023-11-22'

pydantic model genai.schema.TuneFromFileCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TuneResult [Required]

class genai.schema.TuneIdContentRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tunes/{id}/content'

version: str = '2023-11-22'

class genai.schema.TuneIdContentTypeRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tunes/{id}/content/{type}'

version: str = '2023-12-15'

class genai.schema.TuneIdDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/tunes/{id}'

version: str = '2023-11-22'

class genai.schema.TuneIdPatchEndpoint

Bases: ApiEndpoint

method: str = 'PATCH'

path: str = '/v2/tunes/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.TuneIdPatchResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TuneResult [Required]

class genai.schema.TuneIdRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tunes/{id}'

version: str = '2023-11-22'

pydantic model genai.schema.TuneIdRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: TuneResult [Required]

class genai.schema.TuneListSortBy

Bases: str, Enum

An enumeration.

CREATED_AT = 'created_at'

ID = 'id'

MODEL = 'model'

NAME = 'name'

STATUS = 'status'

pydantic model genai.schema.TuneParameters

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field accumulate_steps: int | None = None

field batch_size: int | None = None

field learning_rate: float | None = None

field max_input_tokens: int | None = None

field max_output_tokens: int | None = None

field num_epochs: int | None = None

field num_virtual_tokens: int | None = None

field verbalizer: str | None = None

class genai.schema.TunePreflightCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/tunes/preflight'

version: str = '2023-11-22'

pydantic model genai.schema.TunePreflightCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: _TunePreflightCreateResult [Required]

pydantic model genai.schema.TuneResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field contents: list[TuneResultContent] | None = None

field created_at: AwareDatetime [Required]

field datapoints: TuneResultDatapoint | None = None

field evaluation_files: list[TuneResultFiles] | None = None

field finished_at: AwareDatetime | None = None

field id: str [Required]

field last_used_at: AwareDatetime | None = None

field model_id: str [Required]

field model_name: str [Required]

field name: str [Required]

field parameters: dict[str, Any] | None = None

field preferred: bool [Required]

field started_at: AwareDatetime | None = None

field status: TuneStatus [Required]

field status_message: str | None = None

field task_id: str [Required]

field task_name: str [Required]

field training_files: list[TuneResultFiles] | None = None

field tuning_type: str [Required]

field validation_files: list[TuneResultFiles] | None = None

field vectors: str | None = None

pydantic model genai.schema.TuneResultContent

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field name: str [Required]

pydantic model genai.schema.TuneResultDatapoint

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field loss: list[TunesResultDatapointLoss] [Required]

field validation_loss: list[TuneResultDatapointValidationLoss] | None = None

pydantic model genai.schema.TuneResultDatapointLossData

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

Validators:

• _validate_epoch » epoch

field epoch: int [Required]

Validated by:

• _validate_epoch

field step: int | None = None

field value: float [Required]

pydantic model genai.schema.TuneResultDatapointValidationLoss

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field data: TuneResultDatapointValidationLossData [Required]

field timestamp: AwareDatetime [Required]

pydantic model genai.schema.TuneResultDatapointValidationLossData

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

Validators:

• _validate_epoch » epoch

field epoch: int [Required]

Validated by:

• _validate_epoch

field step: int | None = None

field value: float [Required]

pydantic model genai.schema.TuneResultFiles

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: AwareDatetime | None = None

field file_name: str [Required]

field id: str [Required]

class genai.schema.TuneRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tunes'

version: str = '2023-11-22'

pydantic model genai.schema.TuneRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[TuneResult] [Required]

field total_count: int [Required]

class genai.schema.TuneStatus

Bases: str, Enum

An enumeration.

COMPLETED = 'completed'

FAILED = 'failed'

HALTED = 'halted'

INITIALIZING = 'initializing'

NOT_STARTED = 'not_started'

PENDING = 'pending'

QUEUED = 'queued'

RUNNING = 'running'

pydantic model genai.schema.TunesResultDatapointLoss

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field data: TuneResultDatapointLossData [Required]

field timestamp: AwareDatetime [Required]

class genai.schema.TuningTypeRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/tuning_types'

version: str = '2024-01-30'

pydantic model genai.schema.TuningTypeRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field results: list[TuningTypeRetrieveResults] [Required]

pydantic model genai.schema.TuningTypeRetrieveResults

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field id: str | None = None

field model_ids: list[str] | None = None

field name: str | None = None

field schema_: dict[str, Any] | None = None (alias 'schema')

JSON Schema

pydantic model genai.schema.UnauthorizedResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions4 [Required]

field status_code: Literal[401] = 401

pydantic model genai.schema.UnavailableResponse

Bases: BaseErrorResponse

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field extensions: Extensions5 [Required]

field status_code: Literal[503] = 503

pydantic model genai.schema.UserApiKey

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field created_at: str [Required]

field generated_at: str [Required]

field last_used_at: str | None = None

field value: str [Required]

class genai.schema.UserCreateEndpoint

Bases: ApiEndpoint

method: str = 'POST'

path: str = '/v2/user'

version: str = '2023-11-22'

pydantic model genai.schema.UserCreateResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: UserCreateResult [Required]

pydantic model genai.schema.UserCreateResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field api_key: UserApiKey [Required]

field data_usage_consent: bool [Required]

field email: str [Required]

field first_name: str | None = None

field generate_default: UserGenerationDefault | None = None

field id: int [Required]

field last_name: str | None = None

field tou_accepted: bool [Required]

field tou_accepted_at: str | None = None

field user_id: str [Required]

class genai.schema.UserDeleteEndpoint

Bases: ApiEndpoint

method: str = 'DELETE'

path: str = '/v2/user'

version: str = '2023-11-22'

pydantic model genai.schema.UserGenerationDefault

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field model_id: str | None = None

field parameters: TextGenerationParameters | None = None

class genai.schema.UserPatchEndpoint

Bases: ApiEndpoint

method: str = 'PATCH'

path: str = '/v2/user'

version: str = '2023-11-22'

pydantic model genai.schema.UserPatchResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: UserResult [Required]

pydantic model genai.schema.UserResult

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field data_usage_consent: bool [Required]

field email: str [Required]

field first_name: str | None = None

field generate_default: UserGenerationDefault | None = None

field id: int [Required]

field last_name: str | None = None

field tou_accepted: bool [Required]

field tou_accepted_at: str | None = None

class genai.schema.UserRetrieveEndpoint

Bases: ApiEndpoint

method: str = 'GET'

path: str = '/v2/user'

version: str = '2023-11-22'

pydantic model genai.schema.UserRetrieveResponse

Bases: ApiBaseModel

Config:

• extra: str = allow

• use_enum_values: bool = True

• protected_namespaces: tuple = ()

• validate_assignment: bool = True

• allow_inf_nan: bool = False

• validate_default: bool = True

field result: UserResult [Required]