ogx-client 0.7.2-rc1 → 0.7.2

package/api.md

@@ -0,0 +1,337 @@
+# Shared
+
+Types:
+
+- <code><a href="./src/resources/shared.ts">HealthInfo</a></code>
+- <code><a href="./src/resources/shared.ts">InterleavedContent</a></code>
+- <code><a href="./src/resources/shared.ts">InterleavedContentItem</a></code>
+- <code><a href="./src/resources/shared.ts">ListProvidersResponse</a></code>
+- <code><a href="./src/resources/shared.ts">ListRoutesResponse</a></code>
+- <code><a href="./src/resources/shared.ts">ParamType</a></code>
+- <code><a href="./src/resources/shared.ts">ProviderInfo</a></code>
+- <code><a href="./src/resources/shared.ts">RouteInfo</a></code>
+- <code><a href="./src/resources/shared.ts">SafetyViolation</a></code>
+- <code><a href="./src/resources/shared.ts">SamplingParams</a></code>
+- <code><a href="./src/resources/shared.ts">SystemMessage</a></code>
+- <code><a href="./src/resources/shared.ts">VersionInfo</a></code>
+
+# Responses
+
+Types:
+
+- <code><a href="./src/resources/responses/responses.ts">CompactedResponse</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseInput</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseMessage</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseObject</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseObjectStream</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseOutput</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseListResponse</a></code>
+- <code><a href="./src/resources/responses/responses.ts">ResponseDeleteResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/responses">client.responses.<a href="./src/resources/responses/responses.ts">create</a>({ ...params }) -> ResponseObject</code>
+- <code title="get /v1/responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">retrieve</a>(responseId) -> ResponseObject</code>
+- <code title="get /v1/responses">client.responses.<a href="./src/resources/responses/responses.ts">list</a>({ ...params }) -> ResponseListResponsesOpenAICursorPage</code>
+- <code title="delete /v1/responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">delete</a>(responseId) -> ResponseDeleteResponse</code>
+- <code title="post /v1/responses/compact">client.responses.<a href="./src/resources/responses/responses.ts">compact</a>({ ...params }) -> CompactedResponse</code>
+
+## InputItems
+
+Types:
+
+- <code><a href="./src/resources/responses/input-items.ts">InputItemListResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/responses/{response_id}/input_items">client.responses.inputItems.<a href="./src/resources/responses/input-items.ts">list</a>(responseId, { ...params }) -> InputItemListResponse</code>
+
+# Prompts
+
+Types:
+
+- <code><a href="./src/resources/prompts/prompts.ts">ListPromptsResponse</a></code>
+- <code><a href="./src/resources/prompts/prompts.ts">Prompt</a></code>
+- <code><a href="./src/resources/prompts/prompts.ts">PromptListResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/prompts">client.prompts.<a href="./src/resources/prompts/prompts.ts">create</a>({ ...params }) -> Prompt</code>
+- <code title="get /v1/prompts/{prompt_id}">client.prompts.<a href="./src/resources/prompts/prompts.ts">retrieve</a>(promptId, { ...params }) -> Prompt</code>
+- <code title="put /v1/prompts/{prompt_id}">client.prompts.<a href="./src/resources/prompts/prompts.ts">update</a>(promptId, { ...params }) -> Prompt</code>
+- <code title="get /v1/prompts">client.prompts.<a href="./src/resources/prompts/prompts.ts">list</a>() -> PromptListResponse</code>
+- <code title="delete /v1/prompts/{prompt_id}">client.prompts.<a href="./src/resources/prompts/prompts.ts">delete</a>(promptId) -> void</code>
+- <code title="put /v1/prompts/{prompt_id}/set-default-version">client.prompts.<a href="./src/resources/prompts/prompts.ts">setDefaultVersion</a>(promptId, { ...params }) -> Prompt</code>
+
+## Versions
+
+Methods:
+
+- <code title="get /v1/prompts/{prompt_id}/versions">client.prompts.versions.<a href="./src/resources/prompts/versions.ts">list</a>(promptId) -> PromptListResponse</code>
+
+# Conversations
+
+Types:
+
+- <code><a href="./src/resources/conversations/conversations.ts">ConversationObject</a></code>
+- <code><a href="./src/resources/conversations/conversations.ts">ConversationDeleteResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/conversations">client.conversations.<a href="./src/resources/conversations/conversations.ts">create</a>({ ...params }) -> ConversationObject</code>
+- <code title="get /v1/conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">retrieve</a>(conversationId) -> ConversationObject</code>
+- <code title="post /v1/conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">update</a>(conversationId, { ...params }) -> ConversationObject</code>
+- <code title="delete /v1/conversations/{conversation_id}">client.conversations.<a href="./src/resources/conversations/conversations.ts">delete</a>(conversationId) -> ConversationDeleteResponse</code>
+
+## Items
+
+Types:
+
+- <code><a href="./src/resources/conversations/items.ts">ItemCreateResponse</a></code>
+- <code><a href="./src/resources/conversations/items.ts">ItemListResponse</a></code>
+- <code><a href="./src/resources/conversations/items.ts">ItemDeleteResponse</a></code>
+- <code><a href="./src/resources/conversations/items.ts">ItemGetResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/conversations/{conversation_id}/items">client.conversations.items.<a href="./src/resources/conversations/items.ts">create</a>(conversationId, { ...params }) -> ItemCreateResponse</code>
+- <code title="get /v1/conversations/{conversation_id}/items">client.conversations.items.<a href="./src/resources/conversations/items.ts">list</a>(conversationId, { ...params }) -> ItemListResponsesOpenAICursorPage</code>
+- <code title="delete /v1/conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/resources/conversations/items.ts">delete</a>(conversationId, itemId) -> ItemDeleteResponse</code>
+- <code title="get /v1/conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/resources/conversations/items.ts">get</a>(conversationId, itemId) -> ItemGetResponse</code>
+
+# Inspect
+
+Methods:
+
+- <code title="get /v1/health">client.inspect.<a href="./src/resources/inspect.ts">health</a>() -> HealthInfo</code>
+- <code title="get /v1/version">client.inspect.<a href="./src/resources/inspect.ts">version</a>() -> VersionInfo</code>
+
+# Embeddings
+
+Types:
+
+- <code><a href="./src/resources/embeddings.ts">CreateEmbeddingsResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/embeddings">client.embeddings.<a href="./src/resources/embeddings.ts">create</a>({ ...params }) -> CreateEmbeddingsResponse</code>
+
+# Chat
+
+Types:
+
+- <code><a href="./src/resources/chat/chat.ts">ChatCompletionChunk</a></code>
+
+## Completions
+
+Types:
+
+- <code><a href="./src/resources/chat/completions.ts">CompletionCreateResponse</a></code>
+- <code><a href="./src/resources/chat/completions.ts">CompletionRetrieveResponse</a></code>
+- <code><a href="./src/resources/chat/completions.ts">CompletionListResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">create</a>({ ...params }) -> CompletionCreateResponse</code>
+- <code title="get /v1/chat/completions/{completion_id}">client.chat.completions.<a href="./src/resources/chat/completions.ts">retrieve</a>(completionId) -> CompletionRetrieveResponse</code>
+- <code title="get /v1/chat/completions">client.chat.completions.<a href="./src/resources/chat/completions.ts">list</a>({ ...params }) -> CompletionListResponse</code>
+
+# Completions
+
+Types:
+
+- <code><a href="./src/resources/completions.ts">CompletionCreateResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/completions">client.completions.<a href="./src/resources/completions.ts">create</a>({ ...params }) -> CompletionCreateResponse</code>
+
+# VectorIo
+
+Types:
+
+- <code><a href="./src/resources/vector-io.ts">QueryChunksResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/vector-io/insert">client.vectorIo.<a href="./src/resources/vector-io.ts">insert</a>({ ...params }) -> void</code>
+- <code title="post /v1/vector-io/query">client.vectorIo.<a href="./src/resources/vector-io.ts">query</a>({ ...params }) -> QueryChunksResponse</code>
+
+# VectorStores
+
+Types:
+
+- <code><a href="./src/resources/vector-stores/vector-stores.ts">ListVectorStoresResponse</a></code>
+- <code><a href="./src/resources/vector-stores/vector-stores.ts">VectorStore</a></code>
+- <code><a href="./src/resources/vector-stores/vector-stores.ts">VectorStoreDeleteResponse</a></code>
+- <code><a href="./src/resources/vector-stores/vector-stores.ts">VectorStoreSearchResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/vector_stores">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">create</a>({ ...params }) -> VectorStore</code>
+- <code title="get /v1/vector_stores/{vector_store_id}">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">retrieve</a>(vectorStoreId) -> VectorStore</code>
+- <code title="post /v1/vector_stores/{vector_store_id}">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">update</a>(vectorStoreId, { ...params }) -> VectorStore</code>
+- <code title="get /v1/vector_stores">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">list</a>({ ...params }) -> VectorStoresOpenAICursorPage</code>
+- <code title="delete /v1/vector_stores/{vector_store_id}">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">delete</a>(vectorStoreId) -> VectorStoreDeleteResponse</code>
+- <code title="post /v1/vector_stores/{vector_store_id}/search">client.vectorStores.<a href="./src/resources/vector-stores/vector-stores.ts">search</a>(vectorStoreId, { ...params }) -> VectorStoreSearchResponse</code>
+
+## Files
+
+Types:
+
+- <code><a href="./src/resources/vector-stores/files.ts">VectorStoreFile</a></code>
+- <code><a href="./src/resources/vector-stores/files.ts">FileDeleteResponse</a></code>
+- <code><a href="./src/resources/vector-stores/files.ts">FileContentResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/vector_stores/{vector_store_id}/files">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">create</a>(vectorStoreId, { ...params }) -> VectorStoreFile</code>
+- <code title="get /v1/vector_stores/{vector_store_id}/files/{file_id}">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">retrieve</a>(vectorStoreId, fileId) -> VectorStoreFile</code>
+- <code title="post /v1/vector_stores/{vector_store_id}/files/{file_id}">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">update</a>(vectorStoreId, fileId, { ...params }) -> VectorStoreFile</code>
+- <code title="get /v1/vector_stores/{vector_store_id}/files">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">list</a>(vectorStoreId, { ...params }) -> VectorStoreFilesOpenAICursorPage</code>
+- <code title="delete /v1/vector_stores/{vector_store_id}/files/{file_id}">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">delete</a>(vectorStoreId, fileId) -> FileDeleteResponse</code>
+- <code title="get /v1/vector_stores/{vector_store_id}/files/{file_id}/content">client.vectorStores.files.<a href="./src/resources/vector-stores/files.ts">content</a>(vectorStoreId, fileId, { ...params }) -> FileContentResponse</code>
+
+## FileBatches
+
+Types:
+
+- <code><a href="./src/resources/vector-stores/file-batches.ts">ListVectorStoreFilesInBatchResponse</a></code>
+- <code><a href="./src/resources/vector-stores/file-batches.ts">VectorStoreFileBatches</a></code>
+
+Methods:
+
+- <code title="post /v1/vector_stores/{vector_store_id}/file_batches">client.vectorStores.fileBatches.<a href="./src/resources/vector-stores/file-batches.ts">create</a>(vectorStoreId, { ...params }) -> VectorStoreFileBatches</code>
+- <code title="get /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}">client.vectorStores.fileBatches.<a href="./src/resources/vector-stores/file-batches.ts">retrieve</a>(vectorStoreId, batchId) -> VectorStoreFileBatches</code>
+- <code title="post /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.vectorStores.fileBatches.<a href="./src/resources/vector-stores/file-batches.ts">cancel</a>(vectorStoreId, batchId) -> VectorStoreFileBatches</code>
+- <code title="get /v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.vectorStores.fileBatches.<a href="./src/resources/vector-stores/file-batches.ts">listFiles</a>(vectorStoreId, batchId, { ...params }) -> VectorStoreFilesOpenAICursorPage</code>
+
+# Models
+
+Types:
+
+- <code><a href="./src/resources/models/models.ts">ListModelsResponse</a></code>
+- <code><a href="./src/resources/models/models.ts">Model</a></code>
+- <code><a href="./src/resources/models/models.ts">ModelRetrieveResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/models/{model_id}">client.models.<a href="./src/resources/models/models.ts">retrieve</a>(modelId) -> ModelRetrieveResponse</code>
+- <code title="get /v1/models">client.models.<a href="./src/resources/models/models.ts">list</a>() -> ListModelsResponse</code>
+
+## OpenAI
+
+Methods:
+
+- <code title="get /v1/models">client.models.openai.<a href="./src/resources/models/openai.ts">list</a>() -> ListModelsResponse</code>
+
+# Providers
+
+Types:
+
+- <code><a href="./src/resources/providers.ts">ProviderListResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/providers/{provider_id}">client.providers.<a href="./src/resources/providers.ts">retrieve</a>(providerId) -> ProviderInfo</code>
+- <code title="get /v1/providers">client.providers.<a href="./src/resources/providers.ts">list</a>() -> ProviderListResponse</code>
+
+# Routes
+
+Types:
+
+- <code><a href="./src/resources/routes.ts">RouteListResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/inspect/routes">client.routes.<a href="./src/resources/routes.ts">list</a>({ ...params }) -> RouteListResponse</code>
+
+# Moderations
+
+Types:
+
+- <code><a href="./src/resources/moderations.ts">CreateResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/moderations">client.moderations.<a href="./src/resources/moderations.ts">create</a>({ ...params }) -> CreateResponse</code>
+
+# Safety
+
+Types:
+
+- <code><a href="./src/resources/safety.ts">RunShieldResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/safety/run-shield">client.safety.<a href="./src/resources/safety.ts">runShield</a>({ ...params }) -> RunShieldResponse</code>
+
+# Shields
+
+Types:
+
+- <code><a href="./src/resources/shields.ts">ListShieldsResponse</a></code>
+- <code><a href="./src/resources/shields.ts">Shield</a></code>
+- <code><a href="./src/resources/shields.ts">ShieldListResponse</a></code>
+
+Methods:
+
+- <code title="get /v1/shields/{identifier}">client.shields.<a href="./src/resources/shields.ts">retrieve</a>(identifier) -> Shield</code>
+- <code title="get /v1/shields">client.shields.<a href="./src/resources/shields.ts">list</a>() -> ShieldListResponse</code>
+- <code title="delete /v1/shields/{identifier}">client.shields.<a href="./src/resources/shields.ts">delete</a>(identifier) -> void</code>
+- <code title="post /v1/shields">client.shields.<a href="./src/resources/shields.ts">register</a>({ ...params }) -> Shield</code>
+
+# Files
+
+Types:
+
+- <code><a href="./src/resources/files.ts">DeleteFileResponse</a></code>
+- <code><a href="./src/resources/files.ts">File</a></code>
+- <code><a href="./src/resources/files.ts">ListFilesResponse</a></code>
+- <code><a href="./src/resources/files.ts">FileContentResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/files">client.files.<a href="./src/resources/files.ts">create</a>({ ...params }) -> File</code>
+- <code title="get /v1/files/{file_id}">client.files.<a href="./src/resources/files.ts">retrieve</a>(fileId) -> File</code>
+- <code title="get /v1/files">client.files.<a href="./src/resources/files.ts">list</a>({ ...params }) -> FilesOpenAICursorPage</code>
+- <code title="delete /v1/files/{file_id}">client.files.<a href="./src/resources/files.ts">delete</a>(fileId) -> DeleteFileResponse</code>
+- <code title="get /v1/files/{file_id}/content">client.files.<a href="./src/resources/files.ts">content</a>(fileId) -> string</code>
+
+# Batches
+
+Types:
+
+- <code><a href="./src/resources/batches.ts">BatchCreateResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchRetrieveResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchListResponse</a></code>
+- <code><a href="./src/resources/batches.ts">BatchCancelResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/batches">client.batches.<a href="./src/resources/batches.ts">create</a>({ ...params }) -> BatchCreateResponse</code>
+- <code title="get /v1/batches/{batch_id}">client.batches.<a href="./src/resources/batches.ts">retrieve</a>(batchId) -> BatchRetrieveResponse</code>
+- <code title="get /v1/batches">client.batches.<a href="./src/resources/batches.ts">list</a>({ ...params }) -> BatchListResponsesOpenAICursorPage</code>
+- <code title="post /v1/batches/{batch_id}/cancel">client.batches.<a href="./src/resources/batches.ts">cancel</a>(batchId) -> BatchCancelResponse</code>
+
+# Alpha
+
+## Admin
+
+Methods:
+
+- <code title="get /v1alpha/admin/health">client.alpha.admin.<a href="./src/resources/alpha/admin.ts">health</a>() -> HealthInfo</code>
+- <code title="get /v1alpha/admin/providers/{provider_id}">client.alpha.admin.<a href="./src/resources/alpha/admin.ts">inspectProvider</a>(providerId) -> ProviderInfo</code>
+- <code title="get /v1alpha/admin/providers">client.alpha.admin.<a href="./src/resources/alpha/admin.ts">listProviders</a>() -> ProviderListResponse</code>
+- <code title="get /v1alpha/admin/inspect/routes">client.alpha.admin.<a href="./src/resources/alpha/admin.ts">listRoutes</a>({ ...params }) -> RouteListResponse</code>
+- <code title="get /v1alpha/admin/version">client.alpha.admin.<a href="./src/resources/alpha/admin.ts">version</a>() -> VersionInfo</code>
+
+## Inference
+
+Types:
+
+- <code><a href="./src/resources/alpha/inference.ts">InferenceRerankResponse</a></code>
+
+Methods:
+
+- <code title="post /v1alpha/inference/rerank">client.alpha.inference.<a href="./src/resources/alpha/inference.ts">rerank</a>({ ...params }) -> InferenceRerankResponse</code>

package/bin/check-release-environment

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+errors=()
+
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+fi
+
+lenErrors=${#errors[@]}
+
+if [[ lenErrors -gt 0 ]]; then
+  echo -e "Found the following errors in the release environment:\n"
+
+  for error in "${errors[@]}"; do
+    echo -e "- $error\n"
+  done
+
+  exit 1
+fi
+
+echo "The environment is ready to push releases!"
+

package/bin/publish-npm

@@ -0,0 +1,61 @@
+#!/usr/bin/env bash
+
+set -eux
+
+npm config set '//registry.npmjs.org/:_authToken' "$NPM_TOKEN"
+
+yarn build
+cd dist
+
+# Get package name and version from package.json
+PACKAGE_NAME="$(jq -r -e '.name' ./package.json)"
+VERSION="$(jq -r -e '.version' ./package.json)"
+
+# Get latest version from npm
+#
+# If the package doesn't exist, npm will return:
+# {
+#   "error": {
+#     "code": "E404",
+#     "summary": "Unpublished on 2025-06-05T09:54:53.528Z",
+#     "detail": "'the_package' is not in this registry..."
+#   }
+# }
+NPM_INFO="$(npm view "$PACKAGE_NAME" version --json 2>/dev/null || true)"
+
+# Check if we got an E404 error
+if echo "$NPM_INFO" | jq -e '.error.code == "E404"' > /dev/null 2>&1; then
+  # Package doesn't exist yet, no last version
+  LAST_VERSION=""
+elif echo "$NPM_INFO" | jq -e '.error' > /dev/null 2>&1; then
+  # Report other errors
+  echo "ERROR: npm returned unexpected data:"
+  echo "$NPM_INFO"
+  exit 1
+else
+  # Success - get the version
+  LAST_VERSION=$(echo "$NPM_INFO" | jq -r '.') # strip quotes
+fi
+
+# Check if current version is pre-release (e.g. alpha / beta / rc)
+CURRENT_IS_PRERELEASE=false
+if [[ "$VERSION" =~ -([a-zA-Z]+) ]]; then
+  CURRENT_IS_PRERELEASE=true
+  CURRENT_TAG="${BASH_REMATCH[1]}"
+fi
+
+# Check if last version is a stable release
+LAST_IS_STABLE_RELEASE=true
+if [[ -z "$LAST_VERSION" || "$LAST_VERSION" =~ -([a-zA-Z]+) ]]; then
+  LAST_IS_STABLE_RELEASE=false
+fi
+
+# Use a corresponding alpha/beta tag if there already is a stable release and we're publishing a prerelease.
+if $CURRENT_IS_PRERELEASE && $LAST_IS_STABLE_RELEASE; then
+  TAG="$CURRENT_TAG"
+else
+  TAG="latest"
+fi
+
+# Publish with the appropriate tag
+yarn publish --tag "$TAG"