specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-05-01-preview/inference.yaml [6357:6787]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      required:
        - type

    runStepDetailsToolCallsCodeObject:
      title: Code interpreter tool call
      type: object
      description: Details of the Code Interpreter tool call the run step was involved in.
      properties:
        id:
          type: string
          description: The ID of the tool call.
        type:
          type: string
          description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call.
          enum:
            - code_interpreter
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeObjectType
            modelAsString: true
            values:
              - value: code_interpreter
        code_interpreter:
          type: object
          description: The Code Interpreter tool call definition.
          required:
            - input
            - outputs
          properties:
            input:
              type: string
              description: The input to the Code Interpreter tool call.
            outputs:
              type: array
              description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject'
                  - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject'
      required:
        - id
        - type
        - code_interpreter
    
    runStepDeltaStepDetailsToolCallsCodeObject:
      title: Code interpreter tool call
      type: object
      description: Details of the Code Interpreter tool call the run step was involved in.
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call.
        type:
          type: string
          description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call.
          enum: ["code_interpreter"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeObjectType
            modelAsString: true
            values:
              - value: code_interpreter
        code_interpreter:
          type: object
          description: The Code Interpreter tool call definition.
          properties:
            input:
              type: string
              description: The input to the Code Interpreter tool call.
            outputs:
              type: array
              description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.
              items:
                type: object
                oneOf:
                  - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject"
                  - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject"
      required:
        - index
        - type

    runStepDetailsToolCallsCodeOutputLogsObject:
      title: Code interpreter log output
      type: object
      description: Text output from the Code Interpreter tool call as part of a run step.
      properties:
        type:
          description: Always `logs`.
          type: string
          enum:
            - logs
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeOutputLogsObjectType
            modelAsString: true
            values:
              - value: logs
        logs:
          type: string
          description: The text output from the Code Interpreter tool call.
      required:
        - type
        - logs
    
    runStepDeltaStepDetailsToolCallsCodeOutputLogsObject:
      title: Code interpreter log output
      type: object
      description: Text output from the Code Interpreter tool call as part of a run step.
      properties:
        index:
          type: integer
          description: The index of the output in the outputs array.
        type:
          description: Always `logs`.
          type: string
          enum: ["logs"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
            modelAsString: true
            values:
              - value: logs
        logs:
          type: string
          description: The text output from the Code Interpreter tool call.
      required:
        - index
        - type

    runStepDetailsToolCallsCodeOutputImageObject:
      title: Code interpreter image output
      type: object
      properties:
        type:
          description: Always `image`.
          type: string
          enum:
            - image
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeOutputImageObjectType
            modelAsString: true
            values:
              - value: image
        image:
          type: object
          properties:
            file_id:
              description: The file ID of the image.
              type: string
          required:
            - file_id
      required:
        - type
        - image
    
    runStepDeltaStepDetailsToolCallsCodeOutputImageObject:
      title: Code interpreter image output
      type: object
      properties:
        index:
          type: integer
          description: The index of the output in the outputs array.
        type:
          description: Always `image`.
          type: string
          enum: ["image"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
            modelAsString: true
            values:
              - value: image
        image:
          type: object
          properties:
            file_id:
              description: The file ID of the image.
              type: string
      required:
        - index
        - type
    
    runStepDetailsToolCallsFileSearchObject:
      title: File search tool call
      type: object
      properties:
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `file_search` for this type of tool call.
          enum: ["file_search"]
          x-ms-enum:
            name: RunStepDetailsToolCallsFileSearchObjectType
            modelAsString: true
            values:
              - value: file_search
        file_search:
          type: object
          description: For now, this is always going to be an empty object.
      required:
        - id
        - type
        - file_search

    runStepDeltaStepDetailsToolCallsFileSearchObject:
      title: File search tool call
      type: object
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `retrieval` for this type of tool call.
          enum:
            - file_search
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsFileSearchObjectType
            modelAsString: true
            values:
              - value: file_search
        file_search:
          type: object
          description: For now, this is always going to be an empty object.
      required:
        - index
        - type
        - file_search

    runStepDetailsToolCallsFunctionObject:
      type: object
      title: Function tool call
      properties:
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `function` for this type of tool call.
          enum:
            - function
          x-ms-enum:
            name: RunStepDetailsToolCallsFunctionObjectType
            modelAsString: true
            values:
              - value: function
        function:
          type: object
          description: The definition of the function that was called.
          properties:
            name:
              type: string
              description: The name of the function.
            arguments:
              type: string
              description: The arguments passed to the function.
            output:
              type: string
              description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.
              nullable: true
          required:
            - name
            - arguments
            - output
      required:
        - id
        - type
        - function
    
    runStepDeltaStepDetailsToolCallsFunctionObject:
      type: object
      title: Function tool call
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `function` for this type of tool call.
          enum: ["function"]
          x-ms-enum:
            name: RunStepDetailsToolCallsFunctionObjectType
            modelAsString: true
            values:
              - value: function
        function:
          type: object
          description: The definition of the function that was called.
          properties:
            name:
              type: string
              description: The name of the function.
            arguments:
              type: string
              description: The arguments passed to the function.
            output:
              type: string
              description: The output of the function. This will be `null` if the outputs have not been submitted yet.
              nullable: true
      required:
        - index
        - type

    vectorStoreExpirationAfter:
      type: object
      title: Vector store expiration policy
      description: The expiration policy for a vector store.
      properties:
        anchor:
          description: "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`."
          type: string
          enum: ["last_active_at"]
          x-ms-enum:
            name: VectorStoreExpirationAfterAnchor
            modelAsString: true
            values:
              - value: last_active_at
                description: The anchor timestamp after which the expiration policy applies.
        days:
          description: The number of days after the anchor time that the vector store will expire.
          type: integer
          minimum: 1
          maximum: 365
      required:
        - anchor
        - days

    vectorStoreObject:
      type: object
      title: Vector store
      description: A vector store is a collection of processed files can be used by the `file_search` tool.
      properties:
        id:
          description: The identifier, which can be referenced in API endpoints.
          type: string
        object:
          description: The object type, which is always `vector_store`.
          type: string
          enum: ["vector_store"]
        created_at:
          description: The Unix timestamp (in seconds) for when the vector store was created.
          type: integer
        name:
          description: The name of the vector store.
          type: string
        usage_bytes:
          description: The total number of bytes used by the files in the vector store.
          type: integer
        file_counts:
          type: object
          properties:
            in_progress:
              description: The number of files that are currently being processed.
              type: integer
            completed:
              description: The number of files that have been successfully processed.
              type: integer
            failed:
              description: The number of files that have failed to process.
              type: integer
            cancelled:
              description: The number of files that were cancelled.
              type: integer
            total:
              description: The total number of files.
              type: integer
          required:
            - in_progress
            - completed
            - failed
            - cancelled
            - total
        status:
          description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.
          type: string
          enum: ["expired", "in_progress", "completed"]
          x-ms-enum:
            name: VectorStoreObjectStatus
            modelAsString: true
            values:
              - value: expired
              - value: in_progress
              - value: completed
        expires_after:
          $ref: "#/components/schemas/vectorStoreExpirationAfter"
        expires_at:
          description: The Unix timestamp (in seconds) for when the vector store will expire.
          type: integer
          nullable: true
        last_active_at:
          description: The Unix timestamp (in seconds) for when the vector store was last active.
          type: integer
          nullable: true
        metadata:
          description: *metadata_description
          type: object
          nullable: true
      required:
        - id
        - object
        - usage_bytes
        - created_at
        - status
        - last_active_at
        - name
        - bytes
        - file_counts
        - metadata

    createVectorStoreRequest:
      type: object
      additionalProperties: false
      properties:
        file_ids:
          description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
          type: array
          maxItems: 500
          items:
            type: string
        name:
          description: The name of the vector store.
          type: string
        expires_after:
          $ref: "#/components/schemas/vectorStoreExpirationAfter"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2024-07-01-preview/inference.yaml [6511:6941]:
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      required:
        - type

    runStepDetailsToolCallsCodeObject:
      title: Code interpreter tool call
      type: object
      description: Details of the Code Interpreter tool call the run step was involved in.
      properties:
        id:
          type: string
          description: The ID of the tool call.
        type:
          type: string
          description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call.
          enum:
            - code_interpreter
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeObjectType
            modelAsString: true
            values:
              - value: code_interpreter
        code_interpreter:
          type: object
          description: The Code Interpreter tool call definition.
          required:
            - input
            - outputs
          properties:
            input:
              type: string
              description: The input to the Code Interpreter tool call.
            outputs:
              type: array
              description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.
              items:
                type: object
                oneOf:
                  - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputLogsObject'
                  - $ref: '#/components/schemas/runStepDetailsToolCallsCodeOutputImageObject'
      required:
        - id
        - type
        - code_interpreter
    
    runStepDeltaStepDetailsToolCallsCodeObject:
      title: Code interpreter tool call
      type: object
      description: Details of the Code Interpreter tool call the run step was involved in.
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call.
        type:
          type: string
          description: The type of tool call. This is always going to be `code_interpreter` for this type of tool call.
          enum: ["code_interpreter"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeObjectType
            modelAsString: true
            values:
              - value: code_interpreter
        code_interpreter:
          type: object
          description: The Code Interpreter tool call definition.
          properties:
            input:
              type: string
              description: The input to the Code Interpreter tool call.
            outputs:
              type: array
              description: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type.
              items:
                type: object
                oneOf:
                  - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputLogsObject"
                  - $ref: "#/components/schemas/runStepDeltaStepDetailsToolCallsCodeOutputImageObject"
      required:
        - index
        - type

    runStepDetailsToolCallsCodeOutputLogsObject:
      title: Code interpreter log output
      type: object
      description: Text output from the Code Interpreter tool call as part of a run step.
      properties:
        type:
          description: Always `logs`.
          type: string
          enum:
            - logs
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeOutputLogsObjectType
            modelAsString: true
            values:
              - value: logs
        logs:
          type: string
          description: The text output from the Code Interpreter tool call.
      required:
        - type
        - logs
    
    runStepDeltaStepDetailsToolCallsCodeOutputLogsObject:
      title: Code interpreter log output
      type: object
      description: Text output from the Code Interpreter tool call as part of a run step.
      properties:
        index:
          type: integer
          description: The index of the output in the outputs array.
        type:
          description: Always `logs`.
          type: string
          enum: ["logs"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType
            modelAsString: true
            values:
              - value: logs
        logs:
          type: string
          description: The text output from the Code Interpreter tool call.
      required:
        - index
        - type

    runStepDetailsToolCallsCodeOutputImageObject:
      title: Code interpreter image output
      type: object
      properties:
        type:
          description: Always `image`.
          type: string
          enum:
            - image
          x-ms-enum:
            name: RunStepDetailsToolCallsCodeOutputImageObjectType
            modelAsString: true
            values:
              - value: image
        image:
          type: object
          properties:
            file_id:
              description: The file ID of the image.
              type: string
          required:
            - file_id
      required:
        - type
        - image
    
    runStepDeltaStepDetailsToolCallsCodeOutputImageObject:
      title: Code interpreter image output
      type: object
      properties:
        index:
          type: integer
          description: The index of the output in the outputs array.
        type:
          description: Always `image`.
          type: string
          enum: ["image"]
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject
            modelAsString: true
            values:
              - value: image
        image:
          type: object
          properties:
            file_id:
              description: The file ID of the image.
              type: string
      required:
        - index
        - type
    
    runStepDetailsToolCallsFileSearchObject:
      title: File search tool call
      type: object
      properties:
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `file_search` for this type of tool call.
          enum: ["file_search"]
          x-ms-enum:
            name: RunStepDetailsToolCallsFileSearchObjectType
            modelAsString: true
            values:
              - value: file_search
        file_search:
          type: object
          description: For now, this is always going to be an empty object.
      required:
        - id
        - type
        - file_search

    runStepDeltaStepDetailsToolCallsFileSearchObject:
      title: File search tool call
      type: object
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `retrieval` for this type of tool call.
          enum:
            - file_search
          x-ms-enum:
            name: RunStepDeltaStepDetailsToolCallsFileSearchObjectType
            modelAsString: true
            values:
              - value: file_search
        file_search:
          type: object
          description: For now, this is always going to be an empty object.
      required:
        - index
        - type
        - file_search

    runStepDetailsToolCallsFunctionObject:
      type: object
      title: Function tool call
      properties:
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `function` for this type of tool call.
          enum:
            - function
          x-ms-enum:
            name: RunStepDetailsToolCallsFunctionObjectType
            modelAsString: true
            values:
              - value: function
        function:
          type: object
          description: The definition of the function that was called.
          properties:
            name:
              type: string
              description: The name of the function.
            arguments:
              type: string
              description: The arguments passed to the function.
            output:
              type: string
              description: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet.
              nullable: true
          required:
            - name
            - arguments
            - output
      required:
        - id
        - type
        - function
    
    runStepDeltaStepDetailsToolCallsFunctionObject:
      type: object
      title: Function tool call
      properties:
        index:
          type: integer
          description: The index of the tool call in the tool calls array.
        id:
          type: string
          description: The ID of the tool call object.
        type:
          type: string
          description: The type of tool call. This is always going to be `function` for this type of tool call.
          enum: ["function"]
          x-ms-enum:
            name: RunStepDetailsToolCallsFunctionObjectType
            modelAsString: true
            values:
              - value: function
        function:
          type: object
          description: The definition of the function that was called.
          properties:
            name:
              type: string
              description: The name of the function.
            arguments:
              type: string
              description: The arguments passed to the function.
            output:
              type: string
              description: The output of the function. This will be `null` if the outputs have not been submitted yet.
              nullable: true
      required:
        - index
        - type

    vectorStoreExpirationAfter:
      type: object
      title: Vector store expiration policy
      description: The expiration policy for a vector store.
      properties:
        anchor:
          description: "Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`."
          type: string
          enum: ["last_active_at"]
          x-ms-enum:
            name: VectorStoreExpirationAfterAnchor
            modelAsString: true
            values:
              - value: last_active_at
                description: The anchor timestamp after which the expiration policy applies.
        days:
          description: The number of days after the anchor time that the vector store will expire.
          type: integer
          minimum: 1
          maximum: 365
      required:
        - anchor
        - days

    vectorStoreObject:
      type: object
      title: Vector store
      description: A vector store is a collection of processed files can be used by the `file_search` tool.
      properties:
        id:
          description: The identifier, which can be referenced in API endpoints.
          type: string
        object:
          description: The object type, which is always `vector_store`.
          type: string
          enum: ["vector_store"]
        created_at:
          description: The Unix timestamp (in seconds) for when the vector store was created.
          type: integer
        name:
          description: The name of the vector store.
          type: string
        usage_bytes:
          description: The total number of bytes used by the files in the vector store.
          type: integer
        file_counts:
          type: object
          properties:
            in_progress:
              description: The number of files that are currently being processed.
              type: integer
            completed:
              description: The number of files that have been successfully processed.
              type: integer
            failed:
              description: The number of files that have failed to process.
              type: integer
            cancelled:
              description: The number of files that were cancelled.
              type: integer
            total:
              description: The total number of files.
              type: integer
          required:
            - in_progress
            - completed
            - failed
            - cancelled
            - total
        status:
          description: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.
          type: string
          enum: ["expired", "in_progress", "completed"]
          x-ms-enum:
            name: VectorStoreObjectStatus
            modelAsString: true
            values:
              - value: expired
              - value: in_progress
              - value: completed
        expires_after:
          $ref: "#/components/schemas/vectorStoreExpirationAfter"
        expires_at:
          description: The Unix timestamp (in seconds) for when the vector store will expire.
          type: integer
          nullable: true
        last_active_at:
          description: The Unix timestamp (in seconds) for when the vector store was last active.
          type: integer
          nullable: true
        metadata:
          description: *metadata_description
          type: object
          nullable: true
      required:
        - id
        - object
        - usage_bytes
        - created_at
        - status
        - last_active_at
        - name
        - bytes
        - file_counts
        - metadata

    createVectorStoreRequest:
      type: object
      additionalProperties: false
      properties:
        file_ids:
          description: A list of file IDs that the vector store should use. Useful for tools like `file_search` that can access files.
          type: array
          maxItems: 500
          items:
            type: string
        name:
          description: The name of the vector store.
          type: string
        expires_after:
          $ref: "#/components/schemas/vectorStoreExpirationAfter"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -



