ai-sdk-js
SAP Cloud SDK for AI is the official Software Development Kit (SDK) for SAP AI Core, SAP Generative AI Hub, and Orchestration Service.
File Explorer
Download Latest Version (.zip)- config.json
- concept-mentor.agent.md
- SKILL.md
- SKILL.md
- action.yml
- action.yml
- codeql-config.yml
- bug_report.yml
- config.yml
- feature_request.yml
- question.yml
- api-docs.yml
- auth.yml
- auto-fix-lint.yml
- auto-gen.yml
- blackduck.yml
- build.yml
- bump.yml
- check-pr.yml
- codeql.yml
- documentation.yml
- draft-release.yml
- e2e-tests.yml
- fosstars.yml
- issue-reply.yml
- publish-canary.yml
- publish-release.yml
- publish.yml
- smoke-tests.yml
- spec-update-cleanup-cron.yml
- spec-update-cleanup.yaml
- spec-update-cron.yml
- spec-update.yaml
- test-release-environment.yml
- zizmor.yml
- owasp-suppressions.xml
- PULL_REQUEST_TEMPLATE.md
- renovate.jsonc
- zizmor.yml
- pull_request_bot.json
- 001-esm.md
- 002-project-structure.md
- 003-history-maintenance.md
- 004-api-facade.md
- 005-file-input-convenience.md
- 006-responses-api.md
- 007-foundation-model-client-strategy.md
- template.md
- list-tested-APIs.md
- Apache-2.0.txt
- no-uppercase-internal-tag.js
- ai-api-error-with-id.ts
- ai-api-error.ts
- ai-artifact-argument-binding-list.ts
- ai-artifact-argument-binding.ts
- ai-artifact-array.ts
- ai-artifact-creation-response-message.ts
- ai-artifact-creation-response.ts
- ai-artifact-description.ts
- ai-artifact-id.ts
- ai-artifact-list.ts
- ai-artifact-name.ts
- ai-artifact-post-data.ts
- ai-artifact-url.ts
- ai-artifact.ts
- ai-backend-details.ts
- ai-configuration-base-data.ts
- ai-configuration-creation-response-message.ts
- ai-configuration-creation-response.ts
- ai-configuration-id.ts
- ai-configuration-list.ts
- ai-configuration-name.ts
- ai-configuration.ts
- ai-creation-response-message.ts
- ai-cron.ts
- ai-deployment-bulk-modification-request.ts
- ai-deployment-bulk-modification-response.ts
- ai-deployment-creation-request.ts
- ai-deployment-creation-response-message.ts
- ai-deployment-creation-response.ts
- ai-deployment-deletion-response-message.ts
- ai-deployment-deletion-response.ts
- ai-deployment-details.ts
- ai-deployment-id.ts
- ai-deployment-list.ts
- ai-deployment-modification-request-list.ts
- ai-deployment-modification-request-with-identifier.ts
- ai-deployment-modification-request.ts
- ai-deployment-modification-response-list.ts
- ai-deployment-modification-response-message.ts
- ai-deployment-modification-response.ts
- ai-deployment-response-with-details.ts
- ai-deployment-status-details.ts
- ai-deployment-status-message.ts
- ai-deployment-status.ts
- ai-deployment-target-status.ts
- ai-deployment-time-to-live.ts
- ai-deployment-url.ts
- ai-deployment.ts
- ai-enactment-creation-request.ts
- ai-executable-artifact-list.ts
- ai-executable-artifact.ts
- ai-executable-id.ts
- ai-executable-list.ts
- ai-executable-parameter-list.ts
- ai-executable-parameter.ts
- ai-executable.ts
- ai-execution-bulk-modification-request.ts
- ai-execution-bulk-modification-response.ts
- ai-execution-creation-response-message.ts
- ai-execution-creation-response.ts
- ai-execution-deletion-response-message.ts
- ai-execution-deletion-response.ts
- ai-execution-id.ts
- ai-execution-list.ts
- ai-execution-modification-request-list.ts
- ai-execution-modification-request-with-identifier.ts
- ai-execution-modification-request.ts
- ai-execution-modification-response-list.ts
- ai-execution-modification-response-message.ts
- ai-execution-modification-response.ts
- ai-execution-response-with-details.ts
- ai-execution-schedule-creation-data.ts
- ai-execution-schedule-creation-response-message.ts
- ai-execution-schedule-creation-response.ts
- ai-execution-schedule-deletion-response-message.ts
- ai-execution-schedule-deletion-response.ts
- ai-execution-schedule-id.ts
- ai-execution-schedule-list.ts
- ai-execution-schedule-modification-request.ts
- ai-execution-schedule-modification-response-message.ts
- ai-execution-schedule-modification-response.ts
- ai-execution-schedule-status.ts
- ai-execution-schedule.ts
- ai-execution-status-details.ts
- ai-execution-status-message.ts
- ai-execution-status.ts
- ai-execution.ts
- ai-id.ts
- ai-label-key.ts
- ai-label-list.ts
- ai-label-value.ts
- ai-label.ts
- ai-log-common-data.ts
- ai-log-common-result-item.ts
- ai-log-common-result.ts
- ai-model-base-data.ts
- ai-model-list.ts
- ai-model-version-list.ts
- ai-model-version.ts
- ai-parameter-argument-binding-list.ts
- ai-parameter-argument-binding.ts
- ai-resources-details.ts
- ai-scaling-details.ts
- ai-scenario-id.ts
- ai-scenario-label-key.ts
- ai-scenario-label-list.ts
- ai-scenario-label.ts
- ai-scenario-list.ts
- ai-scenario.ts
- ai-url.ts
- ai-version-description.ts
- ai-version-id.ts
- ai-version-list.ts
- ai-version.ts
- bcknd-all-argo-cd-application-data.ts
- bcknd-argo-cd-application-base-data.ts
- bcknd-argo-cd-application-creation-response-message.ts
- bcknd-argo-cd-application-creation-response.ts
- bcknd-argo-cd-application-data-repo-name.ts
- bcknd-argo-cd-application-data-request.ts
- bcknd-argo-cd-application-data-response.ts
- bcknd-argo-cd-application-deletion-response-message.ts
- bcknd-argo-cd-application-deletion-response.ts
- bcknd-argo-cd-application-modification-response-message.ts
- bcknd-argo-cd-application-modification-response.ts
- bcknd-argo-cd-application-refresh-response-message.ts
- bcknd-argo-cd-application-refresh-response.ts
- bcknd-argo-cd-application-status.ts
- bcknd-argo-cd-repository-creation-response-message.ts
- bcknd-argo-cd-repository-creation-response.ts
- bcknd-argo-cd-repository-credentials.ts
- bcknd-argo-cd-repository-data-response.ts
- bcknd-argo-cd-repository-data.ts
- bcknd-argo-cd-repository-deletion-response-message.ts
- bcknd-argo-cd-repository-deletion-response.ts
- bcknd-argo-cd-repository-details.ts
- bcknd-argo-cd-repository-modification-response-message.ts
- bcknd-argo-cd-repository-modification-response.ts
- bcknd-common-resource-quota-response.ts
- bcknd-creation-response-message.ts
- bcknd-deployment-quota-item.ts
- bcknd-deployment-quota.ts
- bcknd-deployment-resource-quota-response.ts
- bcknd-deployment-usage.ts
- bcknd-error-response.ts
- bcknd-error.ts
- bcknd-executable-resource-quota-response.ts
- bcknd-extended-service.ts
- bcknd-generic-secret-data-response.ts
- bcknd-generic-secret-data.ts
- bcknd-generic-secret-details.ts
- bcknd-generic-secret-label.ts
- bcknd-generic-secret-labels.ts
- bcknd-generic-secret-patch-body.ts
- bcknd-generic-secret-post-body.ts
- bcknd-id.ts
- bcknd-instance-type-get-response.ts
- bcknd-instance-type.ts
- bcknd-internal-resource-group-annotation.ts
- bcknd-internal-resource-group-annotations.ts
- bcknd-internal-resource-group-label.ts
- bcknd-internal-resource-group-labels.ts
- bcknd-internal-resource-group.ts
- bcknd-list-generic-secrets-response.ts
- bcknd-message.ts
- bcknd-name.ts
- bcknd-resource-get-resource-plans.ts
- bcknd-resource-get-response.ts
- bcknd-resource-group-base.ts
- bcknd-resource-group-deletion-response-message.ts
- bcknd-resource-group-deletion-response.ts
- bcknd-resource-group-label.ts
- bcknd-resource-group-labels.ts
- bcknd-resource-group-list.ts
- bcknd-resource-group-patch-request.ts
- bcknd-resource-group.ts
- bcknd-resource-groups-post-request.ts
- bcknd-resource-patch-body.ts
- bcknd-resource-patch-nodes.ts
- bcknd-resource-patch-resource-plans.ts
- bcknd-resource-patch-response.ts
- bcknd-service-broker-secret.ts
- bcknd-service-capabilities.ts
- bcknd-service-list.ts
- bcknd-service-service-catalog-item-extend-catalog.ts
- bcknd-service-service-catalog-item-extend-credentials.ts
- bcknd-service-service-catalog-item.ts
- bcknd-service-service-catalog.ts
- bcknd-service-service-plan-item-metadata.ts
- bcknd-service-service-plan-item.ts
- bcknd-service.ts
- bcknd-shared-resource-group-status.ts
- bcknd-tenant.ts
- bcknd-url.ts
- bcknd-usage-resource-plan-item.ts
- bcknddocker-registry-name-component.ts
- bcknddocker-registry-secret-creation-response-message.ts
- bcknddocker-registry-secret-creation-response.ts
- bcknddocker-registry-secret-deletion-response-message.ts
- bcknddocker-registry-secret-deletion-response.ts
- bcknddocker-registry-secret-modification-response-message.ts
- bcknddocker-registry-secret-modification-response.ts
- bcknddocker-registry-secret-status-response.ts
- bcknddocker-registry-secret-status.ts
- bcknddocker-registry-secret-with-sensitive-data-request.ts
- bckndobject-store-secret-creation-response-message.ts
- bckndobject-store-secret-creation-response.ts
- bckndobject-store-secret-deletion-response-message.ts
- bckndobject-store-secret-deletion-response.ts
- bckndobject-store-secret-modification-response-message.ts
- bckndobject-store-secret-modification-response.ts
- bckndobject-store-secret-status-response.ts
- bckndobject-store-secret-status.ts
- bckndobject-store-secret-with-sensitive-data-request-for-post-call.ts
- bckndobject-store-secret-with-sensitive-data-request.ts
- d-set-error.ts
- d-set-file-creation-response.ts
- d-set-url.ts
- index.ts
- kpi-aggregation-attribute.ts
- kpi-api-error.ts
- kpi-array-of-column-names.ts
- kpi-column-name.ts
- kpi-count-aggregate.ts
- kpi-result-row-item.ts
- kpi-result-row-list.ts
- kpi-result-row.ts
- kpi-result-set.ts
- meta-ai-api.ts
- meta-api-error.ts
- meta-api-version.ts
- meta-capabilities.ts
- meta-extensions.ts
- meta-version.ts
- rt-amessage.ts
- rt-atimestamp.ts
- rta-artifact-array.ts
- rta-artifact-label-list.ts
- rta-artifact-label.ts
- rta-artifact-name.ts
- rta-artifact-signature.ts
- rta-artifact-url.ts
- rta-artifact.ts
- rta-backend-details.ts
- rta-creation-response-message.ts
- rta-deployment-cascade-update-response-message.ts
- rta-deployment-creation-response-message.ts
- rta-deployment-deletion-response-message.ts
- rta-deployment-details.ts
- rta-deployment-id.ts
- rta-deployment-modification-response-message.ts
- rta-deployment-status-details.ts
- rta-deployment-url.ts
- rta-deployment.ts
- rta-error-response.ts
- rta-error.ts
- rta-executable-argument-binding.ts
- rta-executable-artifact.ts
- rta-executable-id.ts
- rta-executable-input-artifact-list.ts
- rta-executable-output-artifact-list.ts
- rta-executable-parameter-list.ts
- rta-executable-parameter.ts
- rta-executable.ts
- rta-execution-creation-response-message.ts
- rta-execution-deletion-response-message.ts
- rta-execution-id.ts
- rta-execution-modification-response-message.ts
- rta-execution-status-details.ts
- rta-execution.ts
- rta-id.ts
- rta-input-artifact-argument-binding.ts
- rta-label-list.ts
- rta-label.ts
- rta-latest-running-target-id.ts
- rta-log-common-data.ts
- rta-log-common-response.ts
- rta-log-common-result-item.ts
- rta-log-common-result.ts
- rta-model-base-data.ts
- rta-model-version-list.ts
- rta-model-version.ts
- rta-output-artifact-argument-binding.ts
- rta-scenario-id.ts
- rta-scenario.ts
- rta-target-id.ts
- rta-ttl.ts
- tnt-api-error.ts
- tnt-tenant-info.ts
- trck-api-error.ts
- trck-custom-info-object-data.ts
- trck-custom-info-object-list.ts
- trck-custom-info-object.ts
- trck-delete-metrics-response.ts
- trck-details-error-response.ts
- trck-execution-id.ts
- trck-generic-name.ts
- trck-get-metric-list.ts
- trck-get-metric-resource-list.ts
- trck-get-metric-resource.ts
- trck-get-metric.ts
- trck-label-list.ts
- trck-label-name.ts
- trck-label.ts
- trck-metric-list.ts
- trck-metric-name.ts
- trck-metric-resource.ts
- trck-metric-value.ts
- trck-metric.ts
- trck-mlapi-execution-id.ts
- trck-string-array.ts
- trck-tag-list.ts
- trck-tag.ts
- trck-timestamp.ts
- trckmetric-selector-permissible-values.ts
- application-api.ts
- artifact-api.ts
- configuration-api.ts
- deployment-api.ts
- docker-registry-secret-api.ts
- executable-api.ts
- execution-api.ts
- execution-schedule-api.ts
- file-api.ts
- index.ts
- kpi-api.ts
- meta-api.ts
- metrics-api.ts
- object-store-secret-api.ts
- repository-api.ts
- resource-api.ts
- resource-group-api.ts
- resource-quota-api.ts
- scenario-api.ts
- secret-api.ts
- service-api.ts
- tenant-info-api.ts
- AI_CORE_API.yaml
- artifact-api.test.ts
- configuration-api.test.ts
- deployment-api.test.ts
- execution-api.test.ts
- scenario-api.test.ts
- deployment-cache.test.ts
- deployment-cache.ts
- deployment-resolver.test.ts
- deployment-resolver.ts
- index.ts
- model.ts
- index.ts
- internal.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- line-decoder.ts
- sse-decoder.ts
- sse-stream.test.ts
- sse-stream.ts
- context.test.ts
- context.ts
- http-client.test.ts
- http-client.ts
- index.ts
- internal.ts
- model-types.ts
- openapi-request-builder.test.ts
- openapi-request-builder.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- backward-compat-getDataRepositoryById-order.patch
- api-error.ts
- base-document.ts
- base-pipeline-minimal-response.ts
- base-pipeline-response.ts
- batch-update-document-success.ts
- batch-update-documents-response.ts
- binary-boolean-filter.ts
- boosting-score-computation-strategy.ts
- boosting-scoring-configuration.ts
- chunk.ts
- collection-created-response.ts
- collection-deleted-response.ts
- collection-pending-response.ts
- collection-request.ts
- collection.ts
- collections-list-response.ts
- configuration-document-full-details.ts
- configuration-document.ts
- create-pipeline.ts
- data-repositories.ts
- data-repository-meta-data-strict.ts
- data-repository-per-filter-search-result.ts
- data-repository-search-result.ts
- data-repository-search-results.ts
- data-repository-type.ts
- data-repository-with-documents.ts
- data-repository.ts
- dense-retrieval-scoring-configuration.ts
- details-error-response.ts
- document-bulk-delete-request.ts
- document-bulk-delete-response.ts
- document-create-request.ts
- document-input.ts
- document-key-value-list-pair.ts
- document-metadata-batch-request.ts
- document-metadata-update-error.ts
- document-metadata-update.ts
- document-metadata.ts
- document-output.ts
- document-response.ts
- document-status.ts
- document-update-request.ts
- document-without-chunks.ts
- document.ts
- documents-chunk.ts
- documents-list-response.ts
- documents-status-response.ts
- documents.ts
- embedding-config.ts
- error-response.ts
- filter-match-mode-enum.ts
- generic-error.ts
- get-pipeline-execution-by-id.ts
- get-pipeline-executions.ts
- get-pipeline-status.ts
- get-pipeline.ts
- get-pipelines.ts
- google-drive-config.ts
- google-drive-configuration-minimal.ts
- google-drive-configuration-struct.ts
- google-drive-pipeline-create-request.ts
- google-drive-pipeline-get-response.ts
- google-drive-pipeline-minimal-response.ts
- google-drive-resource-detail.ts
- http-validation-error.ts
- include-paths-array.ts
- index.ts
- key-value-list-pair.ts
- key-word-retrieval-scoring-configuration.ts
- list-configuration-documents-full-details.ts
- list-configuration-documents.ts
- list-metadata-configurations.ts
- manual-pipeline-trigger.ts
- merge-strategy-reranker.ts
- merge-strategy-score-reuse.ts
- merge-strategy-type.ts
- message-response.ts
- meta-data-key-value-pair-strict.ts
- meta-data.ts
- metadata-configuration-request.ts
- metadata-configuration-response.ts
- metadata-configuration-struct.ts
- metadata-configuration.ts
- metadata-item.ts
- metadata-key-update.ts
- metadata-operation-enum.ts
- metadata-operation.ts
- metadata-response.ts
- metadata-update-item.ts
- metadata-updates.ts
- ms-share-point-configuration-get-response.ts
- ms-share-point-configuration-minimal.ts
- ms-share-point-configuration.ts
- ms-share-point-pipeline-create-request.ts
- ms-share-point-pipeline-get-response.ts
- ms-share-point-pipeline-minimal-response.ts
- patch-pipeline.ts
- per-filter-search-result-error.ts
- per-filter-search-result-with-error.ts
- per-filter-search-result.ts
- pipeline-document-response.ts
- pipeline-execution-data.ts
- pipeline-execution-status.ts
- pipeline-id.ts
- pipeline-minimal-response.ts
- post-processing-object-reference.ts
- post-processing-operation.ts
- retrieval-binary-boolean-filter.ts
- retrieval-chunk.ts
- retrieval-data-repository-search-result.ts
- retrieval-document-key-value-list-pair.ts
- retrieval-key-value-list-pair.ts
- retrieval-per-filter-search-result-error.ts
- retrieval-per-filter-search-result-with-error.ts
- retrieval-per-filter-search-result.ts
- retrieval-scoped-key-value-list-pair.ts
- retrieval-search-configuration.ts
- retrieval-search-document-key-value-list-pair.ts
- retrieval-search-filter.ts
- retrieval-search-input.ts
- retrieval-search-results.ts
- retrieval-search-select-option-enum.ts
- retrieval-vector-search-filter.ts
- s-3-configuration-minimal.ts
- s-3-configuration.ts
- s-3-pipeline-create-request.ts
- s-3-pipeline-get-response.ts
- s-3-pipeline-minimal-response.ts
- scoped-key-value-list-pair.ts
- score.ts
- scores-aggregation-strategy.ts
- sdm-pipeline-create-request.ts
- sdm-pipeline-get-response.ts
- sdm-pipeline-minimal-response.ts
- search-configuration.ts
- search-document-key-value-list-pair.ts
- search-filter.ts
- search-pipeline.ts
- search-pipelines-response.ts
- search-results.ts
- search-scores.ts
- search-select-option-enum.ts
- service-now-config.ts
- service-now-configuration-minimal.ts
- service-now-configuration-struct.ts
- service-now-pipeline-create-request.ts
- service-now-pipeline-get-response.ts
- service-now-pipeline-minimal-response.ts
- sftp-configuration-minimal.ts
- sftp-configuration.ts
- sftp-pipeline-create-request.ts
- sftp-pipeline-get-response.ts
- sftp-pipeline-minimal-response.ts
- share-point-config-get-response.ts
- share-point-config.ts
- share-point-site-detail.ts
- share-point-site-get-response.ts
- share-point-site.ts
- text-only-base-chunk-create.ts
- text-only-base-chunk.ts
- text-search-request.ts
- validation-error.ts
- vector-chunk.ts
- vector-document-key-value-list-pair.ts
- vector-key-value-list-pair.ts
- vector-per-filter-search-result.ts
- vector-scoring-configuration.ts
- vector-search-configuration.ts
- vector-search-document-key-value-list-pair.ts
- vector-search-filter.ts
- vector-search-results.ts
- vector-search-select-option-enum.ts
- work-zone-pipeline-create-request.ts
- work-zone-pipeline-get-response.ts
- work-zone-pipeline-minimal-response.ts
- index.ts
- metadata-configurations-api.ts
- pipelines-api.ts
- retrieval-api.ts
- vector-api.ts
- api.yaml
- options-per-service.json
- pipelines-api.test.ts
- retrieval-api.test.ts
- vector-api.test.ts
- index.ts
- internal.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- audio-response-format.ts
- audio-response.ts
- audio-segment.ts
- audio-verbose-response.ts
- azure-chat-extension-configuration.ts
- azure-chat-extension-type.ts
- azure-chat-extensions-message-context.ts
- azure-cosmos-db-chat-extension-configuration.ts
- azure-cosmos-db-chat-extension-parameters.ts
- azure-cosmos-db-field-mapping-options.ts
- azure-search-chat-extension-configuration.ts
- azure-search-chat-extension-parameters.ts
- azure-search-index-field-mapping-options.ts
- azure-search-query-type.ts
- chat-completion-choice-common.ts
- chat-completion-choice-log-probs.ts
- chat-completion-function-call-option.ts
- chat-completion-function-call.ts
- chat-completion-functions.ts
- chat-completion-message-tool-call-chunk.ts
- chat-completion-message-tool-call.ts
- chat-completion-message-tool-calls.ts
- chat-completion-named-tool-choice.ts
- chat-completion-request-assistant-message-content-part.ts
- chat-completion-request-assistant-message.ts
- chat-completion-request-function-message.ts
- chat-completion-request-message-content-part-image.ts
- chat-completion-request-message-content-part-refusal.ts
- chat-completion-request-message-content-part-text.ts
- chat-completion-request-message-function.ts
- chat-completion-request-message-tool.ts
- chat-completion-request-message.ts
- chat-completion-request-system-message-content-part.ts
- chat-completion-request-system-message.ts
- chat-completion-request-tool-message-content-part.ts
- chat-completion-request-tool-message.ts
- chat-completion-request-user-message-content-part.ts
- chat-completion-request-user-message.ts
- chat-completion-response-message-role.ts
- chat-completion-response-message.ts
- chat-completion-stream-options.ts
- chat-completion-stream-response-delta.ts
- chat-completion-token-logprob.ts
- chat-completion-tool-choice-option.ts
- chat-completion-tool.ts
- chat-completions-request-common.ts
- citation.ts
- completion-usage.ts
- content-filter-choice-results.ts
- content-filter-detected-result.ts
- content-filter-detected-with-citation-result.ts
- content-filter-prompt-results.ts
- content-filter-result-base.ts
- content-filter-results-base.ts
- content-filter-severity-result.ts
- create-chat-completion-request.ts
- create-chat-completion-response.ts
- create-chat-completion-stream-response.ts
- create-completion-request.ts
- create-completion-response.ts
- create-transcription-request.ts
- create-translation-request.ts
- dalle-content-filter-results.ts
- dalle-error-response.ts
- dalle-error.ts
- dalle-filter-results.ts
- dalle-inner-error.ts
- error-base.ts
- error-response.ts
- error.ts
- function-object.ts
- function-parameters.ts
- generate-images-response.ts
- image-generations-request.ts
- image-quality.ts
- image-result.ts
- image-size.ts
- image-style.ts
- images-response-format.ts
- index.ts
- inner-error-code.ts
- inner-error.ts
- on-your-data-api-key-authentication-options.ts
- on-your-data-authentication-options.ts
- on-your-data-authentication-type.ts
- on-your-data-connection-string-authentication-options.ts
- on-your-data-deployment-name-vectorization-source.ts
- on-your-data-endpoint-vectorization-source.ts
- on-your-data-system-assigned-managed-identity-authentication-options.ts
- on-your-data-user-assigned-managed-identity-authentication-options.ts
- on-your-data-vectorization-source-type.ts
- on-your-data-vectorization-source.ts
- parallel-tool-calls.ts
- prompt-filter-result.ts
- prompt-filter-results.ts
- response-format-json-object.ts
- response-format-json-schema-schema.ts
- response-format-json-schema.ts
- response-format-text.ts
- tool-call-type.ts
- inference.json
- index.ts
- tool-calls.ts
- azure-openai-batch-input.test.ts
- azure-openai-batch-input.ts
- azure-openai-batch-output.test.ts
- azure-openai-batch-output.ts
- azure-openai-chat-client.test.ts
- azure-openai-chat-client.ts
- azure-openai-chat-completion-response.test.ts
- azure-openai-chat-completion-response.ts
- azure-openai-chat-completion-stream-chunk-response.test.ts
- azure-openai-chat-completion-stream-chunk-response.ts
- azure-openai-chat-completion-stream-response.test.ts
- azure-openai-chat-completion-stream-response.ts
- azure-openai-chat-completion-stream.test.ts
- azure-openai-chat-completion-stream.ts
- azure-openai-chat-completion-types.ts
- azure-openai-embedding-client.test.ts
- azure-openai-embedding-client.ts
- azure-openai-embedding-response.test.ts
- azure-openai-embedding-response.ts
- azure-openai-embedding-types.ts
- index.ts
- model-types.ts
- index.ts
- internal.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- chat.test.ts.snap
- util.test.ts.snap
- chat.test.ts
- chat.ts
- embedding.ts
- index.ts
- types.ts
- util.test.ts
- util.ts
- client.test.ts.snap
- util.test.ts.snap
- index.ts
- prompt-caching-middleware.ts
- client.test.ts
- client.ts
- index.ts
- orchestration-message-chunk.ts
- orchestration-message.ts
- prompt-caching-middleware.test.ts
- types.ts
- util.test.ts
- util.ts
- index.ts
- internal.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- batch-cancel-response.ts
- batch-create-request.ts
- batch-create-response.ts
- batch-delete-response.ts
- batch-detail-response.ts
- batch-list-response.ts
- batch-status-response.ts
- error-response.ts
- index.ts
- batches-api.ts
- index.ts
- batch-service.yaml
- batches-api.test.ts
- index.ts
- internal.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- index.ts
- internal.ts
- realtime-client.test.ts
- realtime-client.ts
- types.ts
- azure-openai.test.ts
- azure-openai.ts
- chat.ts
- client.test.ts
- client.ts
- completions.test.ts
- completions.ts
- config.test.ts
- config.ts
- embeddings.test.ts
- embeddings.ts
- index.ts
- internal.ts
- responses.test.ts
- responses.ts
- token-provider.test.ts
- token-provider.ts
- types.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- orchestration-client.test.ts.snap
- orchestration-embedding-client.test.ts.snap
- orchestration-stream.test.ts.snap
- assistant-chat-message.ts
- azure-content-safety-input-filter-config.ts
- azure-content-safety-input.ts
- azure-content-safety-output-filter-config.ts
- azure-content-safety-output.ts
- azure-threshold.ts
- cache-control.ts
- cache-creation-token-details.ts
- chat-completion-token-logprob.ts
- chat-completion-tool.ts
- chat-delta.ts
- chat-message-content.ts
- chat-message.ts
- chat-messages.ts
- choice-logprobs.ts
- citation.ts
- completion-post-request.ts
- completion-post-response-streaming.ts
- completion-post-response.ts
- completion-request-configuration-reference-by-id-config-ref.ts
- completion-request-configuration-reference-by-id.ts
- completion-request-configuration-reference-by-name-scenario-version-config-ref.ts
- completion-request-configuration-reference-by-name-scenario-version.ts
- completion-request-configuration.ts
- data-repository-type.ts
- developer-chat-message.ts
- document-grounding-filter.ts
- dpi-config.ts
- dpi-custom-entity.ts
- dpi-entities.ts
- dpi-entity-config.ts
- dpi-method-constant.ts
- dpi-method-fabricated-data.ts
- dpi-standard-entity.ts
- embedding-base-64-string.ts
- embedding-float-array.ts
- embedding-multi-format.ts
- embedding-result.ts
- embedding.ts
- embeddings-input-text.ts
- embeddings-input.ts
- embeddings-model-config.ts
- embeddings-model-details.ts
- embeddings-model-params.ts
- embeddings-module-configs.ts
- embeddings-orchestration-config.ts
- embeddings-post-request.ts
- embeddings-post-response.ts
- embeddings-response.ts
- embeddings-usage.ts
- encoding-format.ts
- error-list.ts
- error-response-streaming.ts
- error-response.ts
- error-streaming-list.ts
- error-streaming.ts
- error.ts
- file-content.ts
- filtering-module-config.ts
- filtering-stream-options.ts
- function-object.ts
- function-parameters.ts
- generic-module-result.ts
- global-stream-options.ts
- grounding-filter-id.ts
- grounding-filter-search-configuration.ts
- grounding-module-config.ts
- image-content-url.ts
- index.ts
- input-filter-config.ts
- input-filtering-config.ts
- input-translation-module-result.ts
- key-value-list-pair.ts
- llama-guard-38-b-filter-config.ts
- llama-guard-38-b.ts
- llm-choice-streaming.ts
- llm-choice.ts
- llm-model-details.ts
- llm-module-result-streaming.ts
- llm-module-result.ts
- masking-module-config.ts
- masking-provider-config.ts
- message-tool-call.ts
- message-tool-calls.ts
- module-configs-list.ts
- module-configs.ts
- module-results-base.ts
- module-results-streaming.ts
- module-results.ts
- orchestration-config.ts
- output-filter-config.ts
- output-filtering-config.ts
- partial-module-configs.ts
- partial-orchestration-config.ts
- partial-prompt-templating-module-config.ts
- prompt-templating-module-config.ts
- reasoning-block.ts
- response-chat-message.ts
- response-format-json-object.ts
- response-format-json-schema-schema.ts
- response-format-json-schema.ts
- response-format-text.ts
- sap-document-translation-apply-to-selector.ts
- sap-document-translation-input.ts
- sap-document-translation-output-target-language.ts
- sap-document-translation-output.ts
- search-document-key-value-list-pair.ts
- search-select-option-enum.ts
- system-chat-message.ts
- template-ref-by-id.ts
- template-ref-by-scenario-name-version.ts
- template-ref.ts
- template.ts
- templating-chat-message.ts
- text-content.ts
- token-usage.ts
- tool-call-chunk.ts
- tool-chat-message.ts
- translation-module-config.ts
- user-chat-message-content-item.ts
- user-chat-message-content.ts
- user-chat-message.ts
- api.yaml
- filtering.test.ts
- filtering.ts
- grounding.test.ts
- grounding.ts
- index.ts
- masking.test.ts
- masking.ts
- module-config.test.ts
- module-config.ts
- stream.test.ts
- stream.ts
- translation.test.ts
- translation.ts
- deployment-resolver.test.ts
- index.ts
- internal.ts
- model-types.ts
- orchestration-client.test.ts
- orchestration-client.ts
- orchestration-completion-post-request-from-json.test.ts
- orchestration-completion-post-request.test.ts
- orchestration-embedding-client.test.ts
- orchestration-embedding-client.ts
- orchestration-embedding-response.test.ts
- orchestration-embedding-response.ts
- orchestration-response.test.ts
- orchestration-response.ts
- orchestration-stream-chunk-response.test.ts
- orchestration-stream-chunk-response.ts
- orchestration-stream-response.test.ts
- orchestration-stream-response.ts
- orchestration-stream.test.ts
- orchestration-stream.ts
- orchestration-types.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- backward-compat-listPromptTemplateHistory-order.patch
- assistant-chat-message.ts
- azure-content-safety-input-filter-config.ts
- azure-content-safety-input.ts
- azure-content-safety-output-filter-config.ts
- azure-content-safety-output.ts
- azure-threshold.ts
- cache-control.ts
- chat-completion-tool.ts
- chat-message-content.ts
- chat-message.ts
- data-repository-type.ts
- developer-chat-message.ts
- document-grounding-filter.ts
- dpi-config.ts
- dpi-custom-entity.ts
- dpi-entities.ts
- dpi-entity-config.ts
- dpi-method-constant.ts
- dpi-method-fabricated-data.ts
- dpi-standard-entity.ts
- error-response.ts
- file-content.ts
- filtering-module-config.ts
- filtering-stream-options.ts
- function-object.ts
- function-parameters.ts
- global-stream-options.ts
- grounding-filter-id.ts
- grounding-filter-search-configuration.ts
- grounding-module-config.ts
- image-content-url.ts
- image-content.ts
- index.ts
- input-filter-config.ts
- input-filtering-config.ts
- key-value-list-pair.ts
- llama-guard-38-b-filter-config.ts
- llama-guard-38-b.ts
- llm-model-details.ts
- masking-module-config.ts
- masking-provider-config.ts
- message-tool-call.ts
- message-tool-calls.ts
- module-configs-list.ts
- module-configs.ts
- multi-chat-content.ts
- multi-chat-template.ts
- orchestration-config-delete-response.ts
- orchestration-config-get-response.ts
- orchestration-config-list-response.ts
- orchestration-config-post-request.ts
- orchestration-config-post-response.ts
- orchestration-config-resource.ts
- output-filter-config.ts
- output-filtering-config.ts
- partial-module-configs.ts
- partial-prompt-templating-module-config.ts
- prompt-registry-orchestration-config.ts
- prompt-template-delete-response.ts
- prompt-template-get-response.ts
- prompt-template-list-response.ts
- prompt-template-post-request.ts
- prompt-template-post-response.ts
- prompt-template-spec.ts
- prompt-template-substitution-request.ts
- prompt-template-substitution-response.ts
- prompt-template.ts
- prompt-templating-module-config.ts
- reasoning-block.ts
- response-format-json-object.ts
- response-format-json-schema-schema.ts
- response-format-json-schema.ts
- response-format-text.ts
- runtime-orchestration-config-file.ts
- runtime-prompt-template-file.ts
- sap-document-translation-apply-to-selector.ts
- sap-document-translation-input.ts
- sap-document-translation-output-target-language.ts
- sap-document-translation-output.ts
- schemas-chat-completion-tool.ts
- schemas-text-content.ts
- search-document-key-value-list-pair.ts
- search-select-option-enum.ts
- single-chat-template.ts
- system-chat-message.ts
- template-ref-by-id.ts
- template-ref-by-scenario-name-version.ts
- template-ref.ts
- template.ts
- templating-chat-message.ts
- text-content.ts
- tool-chat-message.ts
- translation-module-config.ts
- user-chat-message-content-item.ts
- user-chat-message-content.ts
- user-chat-message.ts
- index.ts
- orchestration-configs-api.ts
- prompt-templates-api.ts
- prompt-registry.yaml
- prompt-templates-api.test.ts
- index.ts
- prompt-registry.zod.ts
- index.ts
- internal.ts
- CHANGELOG.md
- orval.config.js
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- body-predict-parquet.ts
- column-type.ts
- index.ts
- predict-request-payload.ts
- predict-response-metadata.ts
- predict-response-payload.ts
- predict-response-status.ts
- prediction-config.ts
- prediction-result.ts
- schema-field-config.ts
- target-column-config.ts
- index.ts
- rpt-api.ts
- rpt.json
- client.test.ts
- client.ts
- index.ts
- internal.ts
- types.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- ai-api-service.cds
- ai-api-service.ts
- azure-openai-service.cds
- azure-openai-service.ts
- orchestration-service.cds
- orchestration-service.ts
- index.cds
- .cdsrc.json
- .gitignore
- .oxlintrc.json
- CHANGELOG.md
- manifest.yml
- package.json
- README.md
- tsconfig.json
- xs-security.json
- generate-parquet.ts
- orchestration.md
- product_data.parquet
- realtime-input.pcm.zst
- test.csv
- test.docx
- test.mp3
- test.pdf
- deployment-api.ts
- scenario-api.ts
- azure-openai.ts
- sample-image.png
- agent.ts
- knowledge.ts
- reply.ts
- mcp-adapter.ts
- weather-mcp-server.ts
- travel-itinerary-agent.ts
- document-grounding.ts
- index.ts
- langchain-azure-openai.ts
- langchain-orchestration.ts
- llm-batch.ts
- model-orchestration-config.json
- openai-realtime.ts
- openai.ts
- orchestration.ts
- prompt-registry.ts
- rpt.ts
- server.ts
- .npmrc
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- add-changelog.ts
- apply-patches.ts
- extract-model-table.js
- extracted-models.json
- generate-docs.ts
- get-package-version.test.ts
- get-package-version.ts
- postgenerate-llm-batch.ts
- postgenerate-orchestration.ts
- postgenerate-rpt.ts
- pregenerate-rpt.ts
- sap-models.json
- sync-model-types.ts
- update-imports.ts
- util.ts
- vitest-snapshot-serializers.ts
- accept.txt
- reject.txt
- Adverbs.yml
- Cliches.yml
- ComplexWords.yml
- Ellipses.yml
- EndWithPeriod.yml
- FirstPerson.yml
- Gender.yml
- HeadingAcronyms.yml
- HeadingPunctuation.yml
- Headings.yml
- Illusions.yml
- meta.json
- Ordinal.yml
- OxfordComma.yml
- Passive.yml
- Products.yml
- Readability.yml
- SentenceLength.yml
- Sentences.yml
- SentencesList.yml
- Slang.yml
- So.yml
- Spacing.yml
- Spelling.yml
- ThereIs.yml
- Weasel.yml
- Wordiness.yml
- azure-openai-chat-completion-stream-chunk-response-delta-content.json
- azure-openai-chat-completion-stream-chunk-response-finish-reason.json
- azure-openai-chat-completion-stream-chunk-response-initial.json
- azure-openai-chat-completion-stream-chunk-response-token-usage.json
- azure-openai-chat-completion-stream-chunk-response-tool-calls.json
- azure-openai-chat-completion-stream-chunks.txt
- azure-openai-chat-completion-stream-tools-chunks.txt
- azure-openai-chat-completion-success-response.json
- azure-openai-embeddings-success-response.json
- azure-openai-error-response.json
- orchestration-chat-completion-filter-config.json
- orchestration-chat-completion-grounding.json
- orchestration-chat-completion-input-filter-error.json
- orchestration-chat-completion-message-history.json
- orchestration-chat-completion-multiple-filter-config.json
- orchestration-chat-completion-stream-chunk-response-delta-content.json
- orchestration-chat-completion-stream-chunk-response-initial.json
- orchestration-chat-completion-stream-chunk-response-token-usage-and-finish-reason.json
- orchestration-chat-completion-stream-chunk-response-tool-call.json
- orchestration-chat-completion-stream-chunks-with-error.txt
- orchestration-chat-completion-stream-chunks.txt
- orchestration-chat-completion-stream-tools-chunks.txt
- orchestration-chat-completion-success-response.json
- orchestration-chat-completion-yaml-template-response.json
- orchestration-chat-completion-yaml-template.yaml
- orchestration-embedding-error.json
- orchestration-embedding-simple-response.json
- orchestration-embedding-with-masking-response.json
- orchestration-stream-response-complete-success.json
- mock-http.ts
- mock-jwt.ts
- tools.ts
- ai-api-utils.ts
- cleanup-deployments.ts
- load-env.ts
- deployment-api.test.ts
- document-grounding.test.ts
- foundation-models.test.ts
- llm-batch.test.ts
- open-ai-langchain.test.ts
- openai-realtime.test.ts
- openai.test.ts
- orchestration-langchain.test.ts
- orchestration.test.ts
- prompt-registry.test.ts
- rpt.test.ts
- scenario-api.test.ts
- CHANGELOG.md
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- create-deployment.ts
- global-setup.ts
- smoke.test.ts
- .npmrc
- CHANGELOG.md
- manifest.yml
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
- azure-openai.test-d.ts
- context.test-d.ts
- http-client.test-d.ts
- langchain-orchestration.test-d.ts
- openai-realtime.test-d.ts
- openai.test-d.ts
- orchestration-embedding.test-d.ts
- orchestration.test-d.ts
- rpt.test-d.ts
- CHANGELOG.md
- package.json
- .agents
- .gitignore
- .oxfmtrc.json
- .oxlintrc.json
- .vale.ini
- CHANGELOG.md
- CONTRIBUTING.md
- DOCUMENTATION.md
- global-test-setup.mjs
- knip.config.mjs
- LICENSE
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- README.md
- REUSE.toml
- sonar-project.properties
- STYLEGUIDE.md
- tsconfig.base.json
- tsconfig.json
- tsconfig.typedoc.json
- V2-Upgrade-Guide.md
- vitest.config.ts
- vitest.shared.ts
# Installation Guide
1. Get the code
git clone https://github.com/SAP/ai-sdk-js
Downloads the entire project code from GitHub to your computer.
cd ai-sdk-js
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install @sap-ai-sdk/ai-api
Downloads and installs the libraries listed in package.json.
npm install @sap-ai-sdk/foundation-models
Downloads and installs the libraries listed in package.json.
npm install @sap-ai-sdk/langchain
Downloads and installs the libraries listed in package.json.
npm install @sap-ai-sdk/orchestration
Downloads and installs the libraries listed in package.json.
npm install @sap-ai-sdk/document-grounding
Downloads and installs the libraries listed in package.json.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)