Module batch_shared

Module batch_shared 

Source
Expand description

Structures shared across the Batch API.

Modules§

exposed
Exposed namespace of the module.
orphan
Orphan namespace of the module.
own
Own namespace of the module.
prelude
Prelude to use essentials: use my_module ::prelude :: *.

Structs§

AdminApiKey
Represents an Admin API Key.
AdminApiKeyOwner
Represents the owner of an Admin API Key (User or Service Account).
ApiKeyList
Response containing a list of Admin API Keys.
Batch
Represents a Batch job object.
BatchErrorData
Represents error details within a Batch object.
BatchErrors
Represents the list of errors for a Batch job.
BatchRequestCounts
Represents the request counts for different statuses within a batch job.
BatchRequestInput
Represents the input structure for a single request within a batch file (JSONL format).
BatchRequestOutput
Represents the output structure for a single request within a batch output/error file (JSONL format).
BatchRequestOutputError
Represents error details for a failed request within a batch output file.
BatchRequestOutputResponse
Represents the response structure for a single request within a batch output file.
Invite
Represents an invitation to join an organization.
InviteListResponse
Response containing a list of organization invites.
InviteProject
Represents project membership granted upon invite acceptance.
ListBatchesResponse
Response containing a list of Batch jobs.
Project
Represents an organization project.
ProjectApiKey
Represents an API key associated with a project.
ProjectApiKeyListResponse
Response containing a list of project API keys.
ProjectApiKeyOwner
Represents the owner of a Project API Key (either a User or Service Account).
ProjectListResponse
Response containing a list of organization projects.
ProjectRateLimit
Represents rate limit configuration for a specific model within a project.
ProjectRateLimitListResponse
Response containing a list of project rate limits.
ProjectServiceAccount
Represents a service account within a project.
ProjectServiceAccountApiKey
Represents the API key generated for a new service account (only present on creation).
ProjectServiceAccountCreateResponse
Response object returned when creating a project service account.
ProjectServiceAccountListResponse
Response containing a list of project service accounts.
ProjectUser
Represents a user’s membership within a specific project.
ProjectUserListResponse
Response containing a list of users within a project.
User
Represents a user within an organization.
UserListResponse
Response containing a list of organization users.