openapi: 3.0.3
info:
  title: International Business Machines IBM Cloud Object Storage Analyze Embeddings API
  description: The IBM Cloud Object Storage API provides a RESTful interface compatible with S3 for storing and retrieving objects in buckets. It supports features such as multipart uploads, versioning, lifecycle policies, and server-side encryption.
  version: 1.0.0
  contact:
    name: IBM Cloud
    url: https://cloud.ibm.com/docs/cloud-object-storage
  license:
    name: IBM Cloud Terms
    url: https://www.ibm.com/terms
servers:
- url: https://s3.us-south.cloud-object-storage.appdomain.cloud
  description: US South
- url: https://s3.eu-de.cloud-object-storage.appdomain.cloud
  description: EU Germany
- url: https://s3.eu-gb.cloud-object-storage.appdomain.cloud
  description: EU Great Britain
security:
- bearerAuth: []
tags:
- name: Embeddings
  description: Generate text embeddings.
paths:
  /ml/v1/text/embeddings:
    post:
      operationId: textEmbeddings
      summary: International Business Machines Generate embeddings
      description: Generate embeddings from text input for use in downstream tasks such as search and retrieval.
      tags:
      - Embeddings
      parameters:
      - name: version
        in: query
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmbeddingsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddingsResponse'
components:
  schemas:
    EmbeddingsResponse:
      type: object
      properties:
        model_id:
          type: string
        results:
          type: array
          items:
            type: object
            properties:
              embedding:
                type: array
                items:
                  type: number
              input_token_count:
                type: integer
    EmbeddingsRequest:
      type: object
      required:
      - model_id
      - inputs
      - project_id
      properties:
        model_id:
          type: string
        inputs:
          type: array
          items:
            type: string
        project_id:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: IAM Token