api.md

Shared Types

from ogx_client.types import (
    HealthInfo,
    InterleavedContent,
    InterleavedContentItem,
    ListProvidersResponse,
    ListRoutesResponse,
    ParamType,
    ProviderInfo,
    RouteInfo,
    SafetyViolation,
    SamplingParams,
    SystemMessage,
    VersionInfo,
)

Responses

Types:

from ogx_client.types import (
    CompactedResponse,
    ResponseInput,
    ResponseMessage,
    ResponseObject,
    ResponseObjectStream,
    ResponseOutput,
    ResponseListResponse,
    ResponseDeleteResponse,
)

Methods:

• client.responses.create(**params) -> ResponseObject
• client.responses.retrieve(response_id) -> ResponseObject
• client.responses.list(**params) -> SyncOpenAICursorPage[ResponseListResponse]
• client.responses.delete(response_id) -> ResponseDeleteResponse
• client.responses.compact(**params) -> CompactedResponse

InputItems

Types:

from ogx_client.types.responses import InputItemListResponse

Methods:

• client.responses.input_items.list(response_id, **params) -> InputItemListResponse

Prompts

Types:

from ogx_client.types import ListPromptsResponse, Prompt, PromptListResponse

Methods:

• client.prompts.create(**params) -> Prompt
• client.prompts.retrieve(prompt_id, **params) -> Prompt
• client.prompts.update(prompt_id, **params) -> Prompt
• client.prompts.list() -> PromptListResponse
• client.prompts.delete(prompt_id) -> None
• client.prompts.set_default_version(prompt_id, **params) -> Prompt

Versions

Methods:

• client.prompts.versions.list(prompt_id) -> PromptListResponse

Conversations

Types:

from ogx_client.types import ConversationObject, ConversationDeleteResponse

Methods:

• client.conversations.create(**params) -> ConversationObject
• client.conversations.retrieve(conversation_id) -> ConversationObject
• client.conversations.update(conversation_id, **params) -> ConversationObject
• client.conversations.delete(conversation_id) -> ConversationDeleteResponse

Items

Types:

from ogx_client.types.conversations import (
    ItemCreateResponse,
    ItemListResponse,
    ItemDeleteResponse,
    ItemGetResponse,
)

Methods:

• client.conversations.items.create(conversation_id, **params) -> ItemCreateResponse
• client.conversations.items.list(conversation_id, **params) -> SyncOpenAICursorPage[ItemListResponse]
• client.conversations.items.delete(item_id, *, conversation_id) -> ItemDeleteResponse
• client.conversations.items.get(item_id, *, conversation_id) -> ItemGetResponse

Inspect

Methods:

• client.inspect.health() -> HealthInfo
• client.inspect.version() -> VersionInfo

Embeddings

Types:

from ogx_client.types import CreateEmbeddingsResponse

Methods:

• client.embeddings.create(**params) -> CreateEmbeddingsResponse

Chat

Types:

from ogx_client.types import ChatCompletionChunk

Completions

Types:

from ogx_client.types.chat import (
    CompletionCreateResponse,
    CompletionRetrieveResponse,
    CompletionListResponse,
)

Methods:

• client.chat.completions.create(**params) -> CompletionCreateResponse
• client.chat.completions.retrieve(completion_id) -> CompletionRetrieveResponse
• client.chat.completions.list(**params) -> CompletionListResponse

Completions

Types:

from ogx_client.types import CompletionCreateResponse

Methods:

• client.completions.create(**params) -> CompletionCreateResponse

VectorIo

Types:

from ogx_client.types import QueryChunksResponse

Methods:

• client.vector_io.insert(**params) -> None
• client.vector_io.query(**params) -> QueryChunksResponse

VectorStores

Types:

from ogx_client.types import (
    ListVectorStoresResponse,
    VectorStore,
    VectorStoreDeleteResponse,
    VectorStoreSearchResponse,
)

Methods:

• client.vector_stores.create(**params) -> VectorStore
• client.vector_stores.retrieve(vector_store_id) -> VectorStore
• client.vector_stores.update(vector_store_id, **params) -> VectorStore
• client.vector_stores.list(**params) -> SyncOpenAICursorPage[VectorStore]
• client.vector_stores.delete(vector_store_id) -> VectorStoreDeleteResponse
• client.vector_stores.search(vector_store_id, **params) -> VectorStoreSearchResponse

Files

Types:

from ogx_client.types.vector_stores import VectorStoreFile, FileDeleteResponse, FileContentResponse

Methods:

• client.vector_stores.files.create(vector_store_id, **params) -> VectorStoreFile
• client.vector_stores.files.retrieve(file_id, *, vector_store_id) -> VectorStoreFile
• client.vector_stores.files.update(file_id, *, vector_store_id, **params) -> VectorStoreFile
• client.vector_stores.files.list(vector_store_id, **params) -> SyncOpenAICursorPage[VectorStoreFile]
• client.vector_stores.files.delete(file_id, *, vector_store_id) -> FileDeleteResponse
• client.vector_stores.files.content(file_id, *, vector_store_id, **params) -> FileContentResponse

FileBatches

Types:

from ogx_client.types.vector_stores import (
    ListVectorStoreFilesInBatchResponse,
    VectorStoreFileBatches,
)

Methods:

• client.vector_stores.file_batches.create(vector_store_id, **params) -> VectorStoreFileBatches
• client.vector_stores.file_batches.retrieve(batch_id, *, vector_store_id) -> VectorStoreFileBatches
• client.vector_stores.file_batches.cancel(batch_id, *, vector_store_id) -> VectorStoreFileBatches
• client.vector_stores.file_batches.list_files(batch_id, *, vector_store_id, **params) -> SyncOpenAICursorPage[VectorStoreFile]

Models

Types:

from ogx_client.types import ListModelsResponse, Model, ModelRetrieveResponse

Methods:

• client.models.retrieve(model_id) -> ModelRetrieveResponse
• client.models.list() -> ListModelsResponse

OpenAI

Methods:

• client.models.openai.list() -> ListModelsResponse

Providers

Types:

from ogx_client.types import ProviderListResponse

Methods:

• client.providers.retrieve(provider_id) -> ProviderInfo
• client.providers.list() -> ProviderListResponse

Routes

Types:

from ogx_client.types import RouteListResponse

Methods:

• client.routes.list(**params) -> RouteListResponse

Moderations

Types:

from ogx_client.types import CreateResponse

Methods:

• client.moderations.create(**params) -> CreateResponse

Safety

Types:

from ogx_client.types import RunShieldResponse

Methods:

• client.safety.run_shield(**params) -> RunShieldResponse

Shields

Types:

from ogx_client.types import ListShieldsResponse, Shield, ShieldListResponse

Methods:

• client.shields.retrieve(identifier) -> Shield
• client.shields.list() -> ShieldListResponse
• client.shields.delete(identifier) -> None
• client.shields.register(**params) -> Shield

Files

Types:

from ogx_client.types import DeleteFileResponse, File, ListFilesResponse, FileContentResponse

Methods:

• client.files.create(**params) -> File
• client.files.retrieve(file_id) -> File
• client.files.list(**params) -> SyncOpenAICursorPage[File]
• client.files.delete(file_id) -> DeleteFileResponse
• client.files.content(file_id) -> str

Batches

Types:

from ogx_client.types import (
    BatchCreateResponse,
    BatchRetrieveResponse,
    BatchListResponse,
    BatchCancelResponse,
)

Methods:

• client.batches.create(**params) -> BatchCreateResponse
• client.batches.retrieve(batch_id) -> BatchRetrieveResponse
• client.batches.list(**params) -> SyncOpenAICursorPage[BatchListResponse]
• client.batches.cancel(batch_id) -> BatchCancelResponse

Alpha

Admin

Methods:

• client.alpha.admin.health() -> HealthInfo
• client.alpha.admin.inspect_provider(provider_id) -> ProviderInfo
• client.alpha.admin.list_providers() -> ProviderListResponse
• client.alpha.admin.list_routes(**params) -> RouteListResponse
• client.alpha.admin.version() -> VersionInfo

Inference

Types:

from ogx_client.types.alpha import InferenceRerankResponse

Methods:

• client.alpha.inference.rerank(**params) -> InferenceRerankResponse