> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wandb.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Class: StringPrompt

> TypeScript SDK reference

[weave](../) / StringPrompt

## Hierarchy

* `Prompt`

  ↳ `StringPrompt`

## Table of contents

### Constructors

* [constructor](./stringprompt#constructor)

### Properties

* [\_\_savedRef](./stringprompt#__savedref)
* [content](./stringprompt#content)

### Accessors

* [description](./stringprompt#description)
* [name](./stringprompt#name)

### Methods

* [format](./stringprompt#format)
* [saveAttrs](./stringprompt#saveattrs)
* [get](./stringprompt#get)

## Constructors

### constructor

• **new StringPrompt**(`parameters`): [`StringPrompt`](./stringprompt)

#### Parameters

| Name         | Type                     |
| :----------- | :----------------------- |
| `parameters` | `StringPromptParameters` |

#### Returns

[`StringPrompt`](./stringprompt)

#### Overrides

Prompt.constructor

#### Defined in

[src/prompt.ts:21](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/prompt.ts#L21)

## Properties

### \_\_savedRef

• `Optional` **\_\_savedRef**: [`ObjectRef`](./objectref) | `Promise`\<[`ObjectRef`](./objectref)>

#### Inherited from

Prompt.\_\_savedRef

#### Defined in

[src/weaveObject.ts:71](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/weaveObject.ts#L71)

***

### content

• **content**: `string`

#### Defined in

[src/prompt.ts:19](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/prompt.ts#L19)

## Accessors

### description

• `get` **description**(): `undefined` | `string`

#### Returns

`undefined` | `string`

#### Inherited from

Prompt.description

#### Defined in

[src/weaveObject.ts:98](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/weaveObject.ts#L98)

***

### name

• `get` **name**(): `string`

#### Returns

`string`

#### Inherited from

Prompt.name

#### Defined in

[src/weaveObject.ts:94](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/weaveObject.ts#L94)

## Methods

### format

▸ **format**(`values?`): `string`

#### Parameters

| Name     | Type                       |
| :------- | :------------------------- |
| `values` | `Record`\<`string`, `any`> |

#### Returns

`string`

#### Defined in

[src/prompt.ts:26](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/prompt.ts#L26)

***

### saveAttrs

▸ **saveAttrs**(): `Object`

#### Returns

`Object`

#### Inherited from

Prompt.saveAttrs

#### Defined in

[src/weaveObject.ts:75](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/weaveObject.ts#L75)

***

### get

▸ **get**(`client`, `uri`): `Promise`\<[`StringPrompt`](./stringprompt)>

#### Parameters

| Name     | Type                           |
| :------- | :----------------------------- |
| `client` | [`WeaveClient`](./weaveclient) |
| `uri`    | `string`                       |

#### Returns

`Promise`\<[`StringPrompt`](./stringprompt)>

#### Defined in

[src/prompt.ts:30](https://github.com/wandb/weave/blob/9591aba8a5e77309ee0858e5ba94d31c1bd7e404/sdks/node/src/prompt.ts#L30)