AI Squared

https://docs.squared.ai/
Admin
AI Squared is a platform that enables users to integrate AI/ML models, insights, chatbots, and...
Tokens:756
Snippets:6
Trust Score:9.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure AI/ML Model Endpoint Details

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Details the required fields for configuring an AI/ML model endpoint, including authentication methods, endpoint URLs, and expected request/response formats. These fields are essential for successful integration with external AI/ML services.

```APIDOC
Endpoint Configuration:
  Endpoint Name: A meaningful name for this model source
  Endpoint URL: The endpoint where the model is hosted
  Authentication Method: e.g., OAuth, API Key, Bearer Token
  Auth Header / Secret Key: If applicable
  Request Format: Structure expected by the model (e.g., JSON payload)
  Response Format: Format returned by the model (e.g., structured JSON with keys)
```

--------------------------------

### API: AI/ML Model Endpoint Configuration Fields

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Defines the essential fields required to configure an AI/ML model endpoint within the AI Squared platform. This includes parameters for naming the endpoint, specifying its URL, selecting an authentication method, and detailing the expected request and response formats for successful integration.

```APIDOC
Endpoint Configuration:
  Endpoint Name: string (A meaningful name for this model source)
  Endpoint URL: string (The endpoint where the model is hosted)
  Authentication Method: string (e.g., OAuth, API Key, Bearer Token)
  Auth Header / Secret Key: string (If applicable)
  Request Format: string (Structure expected by the model, e.g., JSON payload)
  Response Format: string (Format returned by the model, e.g., structured JSON with keys)
```

--------------------------------

### API: AI/ML Model Input Schema Definition

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Specifies the structure for defining the input schema expected by the AI/ML model during inference. It outlines the key properties for each input field, including its name, data type (String, Integer, Float, Boolean), and whether its value is static or dynamic.

```APIDOC
Input Schema Field:
  Name: string (Key name expected by the model)
  Type: string (Data type: String, Integer, Float, Boolean)
  Value: string (Static or dynamic input value)
```

--------------------------------

### Define AI/ML Model Output Schema

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Specifies the structure for defining the output schema to ensure consistent mapping of the AI/ML model's response. This helps in correctly interpreting the model's predictions or results by defining expected field names and their data types.

```APIDOC
Output Schema Fields:
  Field Name: Key name from the model response
  Type: Data type: String, Integer, Float, Boolean
```

--------------------------------

### API: AI/ML Model Output Schema Definition

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Specifies the structure for defining the output schema returned by the AI/ML model. This ensures consistent mapping of the model’s response by detailing the field name from the model's output and its corresponding data type (String, Integer, Float, Boolean).

```APIDOC
Output Schema Field:
  Field Name: string (Key name from the model response)
  Type: string (Data type: String, Integer, Float, Boolean)
```

--------------------------------

### Define AI/ML Model Input Schema

Source: https://docs.squared.ai/activation/ai-modelling/connect-source

Specifies the structure for defining the input schema expected by the AI/ML model during inference. This ensures that the data sent to the model matches its requirements, including field names, data types, and value types.

```APIDOC
Input Schema Fields:
  Name: Key name expected by the model
  Type: Data type: String, Integer, Float, Boolean
  Value: Static or dynamic input value
```
Tokens:
Raw