network.sharedcomputer.chat.defs

sharedcomputer.network

Documentation

effort string

The model's reasoning effort.

Known Values (other values may be valid)
none low medium high max
View raw schema
{
  "description": "The model's reasoning effort.",
  "knownValues": [
    "none",
    "low",
    "medium",
    "high",
    "max"
  ],
  "type": "string"
}
encryptedContent object

A sealed plainContent, or the sealed fields of the enclosing record. All user content is sealed, metadata stays in the clear.

Properties

blobs array of blob Optional

Encrypted blobs referenced inside the ciphertext, listed so the PDS keeps them.

maxLength: 100 items
ciphertext bytes Required

No description available.

maxLength: 1000000
keyId string Required

No description available.

maxLength: 128 bytes
nonce bytes Required

No description available.

maxLength: 64
scheme string Required

No description available.

maxLength: 128 bytes
View raw schema
{
  "description": "A sealed plainContent, or the sealed fields of the enclosing record. All user content is sealed, metadata stays in the clear.",
  "properties": {
    "blobs": {
      "description": "Encrypted blobs referenced inside the ciphertext, listed so the PDS keeps them.",
      "items": {
        "type": "blob"
      },
      "maxLength": 100,
      "type": "array"
    },
    "ciphertext": {
      "maxLength": 1000000,
      "type": "bytes"
    },
    "keyId": {
      "maxLength": 128,
      "type": "string"
    },
    "nonce": {
      "maxLength": 64,
      "type": "bytes"
    },
    "scheme": {
      "maxLength": 128,
      "type": "string"
    }
  },
  "required": [
    "scheme",
    "keyId",
    "nonce",
    "ciphertext"
  ],
  "type": "object"
}
extractedText object

Cache for text pulled from a file.

Properties

method string Required

No description available.

Known values: text, ocr
text blob Required

No description available.

maxSize: 20.0 MB
View raw schema
{
  "description": "Cache for text pulled from a file.",
  "properties": {
    "method": {
      "knownValues": [
        "text",
        "ocr"
      ],
      "type": "string"
    },
    "text": {
      "accept": [
        "text/plain"
      ],
      "maxSize": 20000000,
      "type": "blob"
    }
  },
  "required": [
    "text",
    "method"
  ],
  "type": "object"
}
filePart object

No description available.

Properties

file blob Required

No description available.

maxSize: 50.0 MB
name string Optional

No description available.

maxLength: 1024 bytes
View raw schema
{
  "properties": {
    "extracted": {
      "ref": "#extractedText",
      "type": "ref"
    },
    "file": {
      "accept": [
        "*/*"
      ],
      "maxSize": 50000000,
      "type": "blob"
    },
    "name": {
      "maxLength": 1024,
      "type": "string"
    }
  },
  "required": [
    "file"
  ],
  "type": "object"
}
generationRequest object

No description available.

Properties

attempt integer Optional

The reply is written as '{messageKey}.r{attempt}'. Increase by 1 to ask for a regeneration.

minimum: 0maximum: 1000
effort ref #effort Optional

No description available.

model ref #modelRef Optional

Model used in generating the response. If empty falls back to previous response model, then the user's default.

tools array of string Optional

Ids for the tools the assistant may use for this turn.

maxLength: 64 items
View raw schema
{
  "properties": {
    "attempt": {
      "default": 0,
      "description": "The reply is written as '{messageKey}.r{attempt}'. Increase by 1 to ask for a regeneration.",
      "maximum": 1000,
      "minimum": 0,
      "type": "integer"
    },
    "effort": {
      "ref": "#effort",
      "type": "ref"
    },
    "model": {
      "description": "Model used in generating the response. If empty falls back to previous response model, then the user's default.",
      "ref": "#modelRef",
      "type": "ref"
    },
    "tools": {
      "description": "Ids for the tools the assistant may use for this turn.",
      "items": {
        "maxLength": 128,
        "type": "string"
      },
      "maxLength": 64,
      "type": "array"
    }
  },
  "type": "object"
}
imagePart object

No description available.

Properties

alt string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
image blob Required

No description available.

maxSize: 20.0 MB
View raw schema
{
  "properties": {
    "alt": {
      "maxGraphemes": 1000,
      "maxLength": 10000,
      "type": "string"
    },
    "image": {
      "accept": [
        "image/png",
        "image/jpeg",
        "image/webp",
        "image/gif"
      ],
      "maxSize": 20000000,
      "type": "blob"
    }
  },
  "required": [
    "image"
  ],
  "type": "object"
}
modelRef object

The model being used. API keys are stored in the app database.

Properties

id string Required

No description available.

maxLength: 256 bytes
provider string Required

No description available.

maxLength: 128 bytes
Known values: anthropic, openai, google, openrouter, cocore
View raw schema
{
  "description": "The model being used. API keys are stored in the app database.",
  "properties": {
    "id": {
      "maxLength": 256,
      "type": "string"
    },
    "provider": {
      "knownValues": [
        "anthropic",
        "openai",
        "google",
        "openrouter",
        "cocore"
      ],
      "maxLength": 128,
      "type": "string"
    }
  },
  "required": [
    "provider",
    "id"
  ],
  "type": "object"
}
plainContent object

No description available.

Properties

View raw schema
{
  "properties": {
    "parts": {
      "items": {
        "refs": [
          "#textPart",
          "#reasoningPart",
          "#imagePart",
          "#filePart",
          "#toolCallPart",
          "#toolResultPart",
          "#sourcePart"
        ],
        "type": "union"
      },
      "maxLength": 1000,
      "type": "array"
    }
  },
  "required": [
    "parts"
  ],
  "type": "object"
}
providerData string

JSON-encoded provider options for this part, such as reasoning signatures. Sent back unchanged when continuing with the same provider.

ConstraintsmaxLength: 100000 bytes
View raw schema
{
  "description": "JSON-encoded provider options for this part, such as reasoning signatures. Sent back unchanged when continuing with the same provider.",
  "maxLength": 100000,
  "type": "string"
}
reasoningPart object

No description available.

Properties

providerData ref #providerData Optional

No description available.

text string Optional

No description available.

maxLength: 500000 bytes
View raw schema
{
  "properties": {
    "providerData": {
      "ref": "#providerData",
      "type": "ref"
    },
    "text": {
      "maxLength": 500000,
      "type": "string"
    }
  },
  "type": "object"
}
sourcePart object

URL source cited by the assistant.

Properties

title string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
url string uri Required

A valid URI.

View raw schema
{
  "description": "URL source cited by the assistant.",
  "properties": {
    "title": {
      "maxGraphemes": 300,
      "maxLength": 3000,
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "type": "object"
}
textPart object

No description available.

Properties

providerData ref #providerData Optional

No description available.

text string Required

No description available.

maxLength: 500000 bytes
View raw schema
{
  "properties": {
    "providerData": {
      "ref": "#providerData",
      "type": "ref"
    },
    "text": {
      "maxLength": 500000,
      "type": "string"
    }
  },
  "required": [
    "text"
  ],
  "type": "object"
}
toolCallPart object

No description available.

Properties

callId string Required

No description available.

maxLength: 256 bytes
input string Required

JSON-encoded arguments.

maxLength: 200000 bytes
providerData ref #providerData Optional

No description available.

tool string Required

No description available.

maxLength: 128 bytes
View raw schema
{
  "properties": {
    "callId": {
      "maxLength": 256,
      "type": "string"
    },
    "input": {
      "description": "JSON-encoded arguments.",
      "maxLength": 200000,
      "type": "string"
    },
    "providerData": {
      "ref": "#providerData",
      "type": "ref"
    },
    "tool": {
      "maxLength": 128,
      "type": "string"
    }
  },
  "required": [
    "callId",
    "tool",
    "input"
  ],
  "type": "object"
}
toolResultPart object

No description available.

Properties

callId string Required

No description available.

maxLength: 256 bytes
isError boolean Optional

No description available.

output string Required

Tool output as text or JSON-encoded data.

maxLength: 500000 bytes
outputBlob blob Optional

Used when the output is too long for the output record. Output will contain a summary in that case.

maxSize: 50.0 MB
View raw schema
{
  "properties": {
    "callId": {
      "maxLength": 256,
      "type": "string"
    },
    "isError": {
      "default": false,
      "type": "boolean"
    },
    "output": {
      "description": "Tool output as text or JSON-encoded data.",
      "maxLength": 500000,
      "type": "string"
    },
    "outputBlob": {
      "accept": [
        "*/*"
      ],
      "description": "Used when the output is too long for the output record. Output will contain a summary in that case.",
      "maxSize": 50000000,
      "type": "blob"
    }
  },
  "required": [
    "callId",
    "output"
  ],
  "type": "object"
}
usage object

No description available.

Properties

inputTokens integer Optional

No description available.

minimum: 0
outputTokens integer Optional

No description available.

minimum: 0
reasoningTokens integer Optional

No description available.

minimum: 0
View raw schema
{
  "properties": {
    "inputTokens": {
      "minimum": 0,
      "type": "integer"
    },
    "outputTokens": {
      "minimum": 0,
      "type": "integer"
    },
    "reasoningTokens": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}

Lexicon Garden

@