openai_dart_admin library
Explicitly authenticated organization administration, isolated from inference.
Classes
- AdminExternalKeysResource
- The five external-key operations; creation registers caller-owned key metadata.
- AdminExternalStorageResource
- The five external-storage operations, including AWS, Azure, GCP and OCI.
- AdminListOrder
-
Frozen
OrderEnumvalues; unknown received strings retain their exact value. - AdminOrganizationResource
- Bounded organization operations, authenticated only by OpenAIAdminClient.
- AdminProjectApiKeysResource
- Updates project API keys without creating, retrieving or deleting credentials.
- AdminProjectsResource
- Bounded project administration; historical project CRUD is outside this API.
- AdminUsageResource
- Organization Decisions usage. Results are aggregates, not per-request costs.
- ApiKeyProvider
- Provides API key authentication for the OpenAI API.
- AuthProvider
- Abstract interface for providing authentication credentials.
- AwsExternalKeyParams
- AwsExternalKeyParams
- AwsExternalStorageProviderParams
- AwsExternalStorageProviderParams
- AwsExternalStorageProviderResponse
- AwsExternalStorageProviderResponse
- AzureExternalKeyParams
- AzureExternalKeyParams
- AzureExternalStorageProviderParams
- AzureExternalStorageProviderParams
- AzureExternalStorageProviderResponse
- AzureExternalStorageProviderResponse
- CreateExternalStorageRequest
- CreateExternalStorageRequest
- DecisionsUsageApiSource
-
Frozen
DecisionsUsageApiSourcevalues; unknown received strings retain their exact value. - DecisionsUsageBucket
- DecisionsUsageBucket
- DecisionsUsageBucketWidth
-
Frozen
DecisionsUsageBucketWidthvalues; unknown received strings retain their exact value. - DecisionsUsageGroupBy
-
Frozen
DecisionsUsageGroupByvalues; unknown received strings retain their exact value. - DecisionsUsagePage
- DecisionsUsagePage
- DecisionsUsageResult
- The aggregated Decisions API usage details of the specific time bucket.
- DeletedExternalStorage
- DeletedExternalStorage
- ExternalKey
- ExternalKey
- ExternalKeyList
- ExternalKeyList
- ExternalKeyParams
- Native variants: AwsExternalKeyParams, AzureExternalKeyParams, GcpExternalKeyParams and UnknownExternalKeyParams.
- ExternalKeyPurpose
-
Frozen
ExternalKeyPurposevalues; unknown received strings retain their exact value. - ExternalKeyValidation
- ExternalKeyValidation
- ExternalStorage
- ExternalStorage
- ExternalStorageList
- ExternalStorageList
- ExternalStorageProvider
- Native variants: AwsExternalStorageProviderResponse, AzureExternalStorageProviderResponse, GcpExternalStorageProviderResponse, OciExternalStorageProviderResponse and UnknownExternalStorageProvider.
- ExternalStorageProviderParams
- Native variants: AwsExternalStorageProviderParams, AzureExternalStorageProviderParams, GcpExternalStorageProviderParams, OciExternalStorageProviderParams and UnknownExternalStorageProviderParams.
- ExternalStorageStatus
-
Frozen
ExternalStorageStatusvalues; unknown received strings retain their exact value. - GcpExternalKeyParams
- GcpExternalKeyParams
- GcpExternalStorageProviderParams
- GcpExternalStorageProviderParams
- GcpExternalStorageProviderResponse
- GcpExternalStorageProviderResponse
- OciExternalStorageProviderParams
- OciExternalStorageProviderParams
- OciExternalStorageProviderResponse
- OciExternalStorageProviderResponse
- OpenAIAdminClient
- Organization administration with an explicit, separate credential realm.
- OpenAIAdminConfig
- Explicit configuration for organization administration, isolated from model API credentials.
- ProjectApiKey
- Represents an individual API key in a project.
- ProjectApiKeyOwner
- ProjectApiKeyOwner
- ProjectApiKeyOwnerServiceAccount
- The service account that owns a project API key.
- ProjectApiKeyOwnerUser
- The user that owns a project API key.
- RetryPolicy
- Retry policy configuration.
- UnknownExternalKeyParams
- Immutable future provider data, unavailable for writes.
- UnknownExternalStorageProvider
- Immutable future provider data.
- UnknownExternalStorageProviderParams
- Immutable future provider data, unavailable for writes.
- UpdateProjectApiKeyRequest
- UpdateProjectApiKeyRequest
Enums
- AbortionStage
- The stage at which the request was aborted.
Functions
-
createApiException(
{required int statusCode, required String message, String? type, String? code, String? param, String? requestId, Map< String, dynamic> ? body, ResponsesMisalignmentDetails? misalignment, Duration? retryAfter, Object? cause}) → ApiException - Creates the appropriate exception based on HTTP status code.
Exceptions / Errors
- AbortedException
- Exception thrown when a request is aborted.
- ApiException
- Exception thrown when the API returns an error response.
- AuthenticationException
- Exception thrown when authentication fails (HTTP 401).
- BadRequestException
- Exception thrown when the request is invalid (HTTP 400).
- ConflictException
- Exception thrown when the request conflicts with current state (HTTP 409).
- ConnectionException
- Exception thrown when a network connection cannot be established.
- InternalServerException
- Exception thrown when an internal server error occurs (HTTP 5xx).
- NotFoundException
- Exception thrown when a resource is not found (HTTP 404).
- OpenAIException
- Base exception class for OpenAI HTTP and client transport errors.
- ParseException
- Exception thrown when response parsing fails.
- PermissionDeniedException
- Exception thrown when access is denied (HTTP 403).
- RateLimitException
- Exception thrown when rate limited (HTTP 429).
- RequestTimeoutException
- Exception thrown when a request times out.
- StreamException
- Exception thrown when streaming fails.
- UnprocessableEntityException
- Exception thrown when the request cannot be processed (HTTP 422).