> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-workspaces-notebooks.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# StringPrompt

> Référence du SDK TypeScript

export const GitHubLink = ({url, compact = false}) => <a href={url} target="_blank" rel="noopener noreferrer" className={compact ? "source-link" : "github-source-link"}>
    {compact ? "voir la source" : <>
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M12 0C5.37 0 0 5.37 0 12c0 5.31 3.435 9.795 8.205 11.385.6.105.825-.255.825-.57 0-.285-.015-1.23-.015-2.235-3.015.555-3.795-.735-4.035-1.41-.135-.345-.72-1.41-1.23-1.695-.42-.225-1.02-.78-.015-.795.945-.015 1.62.87 1.845 1.23 1.08 1.815 2.805 1.305 3.495.99.105-.78.42-1.305.765-1.605-2.67-.3-5.46-1.335-5.46-5.925 0-1.305.465-2.385 1.23-3.225-.12-.3-.54-1.53.12-3.18 0 0 1.005-.315 3.3 1.23.96-.27 1.98-.405 3-.405s2.04.135 3 .405c2.295-1.56 3.3-1.23 3.3-1.23.66 1.65.24 2.88.12 3.18.765.84 1.23 1.905 1.23 3.225 0 4.605-2.805 5.625-5.475 5.925.435.375.81 1.095.81 2.22 0 1.605-.015 2.895-.015 3.3 0 .315.225.69.825.57A12.02 12.02 0 0024 12c0-6.63-5.37-12-12-12z" />
    </svg>
    Source GitHub
      </>}
  </a>;

<GitHubLink url="https://github.com/wandb/weave/blob/7c9efdc9fe05ffcaf2430dd652ef9bc5b3ffdfaa/sdks/node/src/prompt.ts#L19" />

<div id="extends">
  ## Étend
</div>

* `Prompt`

<div id="constructor">
  ## Constructeur
</div>

> **new StringPrompt**(`parameters`) : `StringPrompt`

<div id="parameters">
  ### Paramètres
</div>

<ParamField path="parameters" type="object" required>
  <Expandable title="propriétés" defaultOpen>
    <ParamField path="content" type="string" required />

    <ParamField path="description" type="string" />

    <ParamField path="name" type="string" />
  </Expandable>
</ParamField>

<div id="returns">
  ### Renvoie
</div>

`StringPrompt`

<div id="overrides">
  ### Redéfinitions
</div>

`Prompt.constructor`

<div id="properties">
  ## Propriétés
</div>

<div id="__savedref">
  ### \_\_savedRef
</div>

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

<div id="inherited-from">
  #### Hérité de
</div>

`Prompt.__savedRef`

***

<div id="content">
  ### content
</div>

> **content**: `string`

<div id="accessors">
  ## Accesseurs
</div>

<div id="description">
  ### description
</div>

<div id="get-signature">
  #### Signature d’obtention
</div>

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

<div id="returns-2">
  ##### Renvoie
</div>

`string` | `undefined`

<div id="inherited-from-2">
  #### Hérité de
</div>

`Prompt.description`

***

<div id="name">
  ### nom
</div>

<div id="get-signature-2">
  #### Signature d’obtention
</div>

> **get** **nom**(): `string`

<div id="returns-3">
  ##### Renvoie
</div>

`string`

<div id="inherited-from-3">
  #### Hérité de
</div>

`Prompt.name`

<div id="methods">
  ## Méthodes
</div>

<div id="format">
  ### format()
</div>

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

<div id="parameters-2">
  #### Paramètres
</div>

<ParamField path="values" type="Record<string, any> = {}" />

<div id="returns-4">
  #### Renvoie
</div>

`string`

***

<div id="saveattrs">
  ### saveAttrs()
</div>

> **saveAttrs**() : `objet`

<div id="returns-5">
  #### Renvoie
</div>

`objet`

<div id="inherited-from-4">
  #### Hérité de
</div>

`Prompt.saveAttrs`

***

<div id="get">
  ### get()
</div>

> `static` **get**(`client`, `uri`): `Promise`\<`StringPrompt`>

<div id="parameters-3">
  #### Paramètres
</div>

<ParamField path="client" type="WeaveClient" required>
  Voir [`WeaveClient`](../interfaces/weaveclient).
</ParamField>

<ParamField path="uri" type="string" required />

<div id="returns-6">
  #### Renvoie
</div>

`Promise`\<`StringPrompt`>
