# AppFunctionAppMetadata

Artifact: [androidx.appfunctions:appfunctions](https://developer.android.com/jetpack/androidx/releases/appfunctions) [View Source](https://cs.android.com/search?q=file:androidx/appfunctions/metadata/AppFunctionAppMetadata.kt+class:androidx.appfunctions.metadata.AppFunctionAppMetadata) Added in [1.0.0-rc01](https://developer.android.com/jetpack/androidx/releases/appfunctions#1.0.0-rc01)

*** ** * ** ***


```
class AppFunctionAppMetadata
```

<br />

*** ** * ** ***

Metadata describing how an app exposes its functions for use by an AI agent or large language model (LLM).

This class corresponds to the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable in the XML linked to property `android.app.appfunctions.app_metadata` in the app's manifest.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#AppFunctionAppMetadata(kotlin.String,kotlin.String)(instructions: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, displayDescription: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#displayDescription()` A short, user-visible description of what the app functions enable the agent to do. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/appfunctions/metadata/AppFunctionAppMetadata#instructions()` App-provided instructions for the LLM on how to use the app's functions together. |

## Public constructors

### AppFunctionAppMetadata

Added in [1.0.0-rc01](https://developer.android.com/jetpack/androidx/releases/appfunctions#1.0.0-rc01)

```
AppFunctionAppMetadata(
    instructions: String = "",
    displayDescription: String = ""
)
```

## Public functions

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### displayDescription

Added in [1.0.0-rc01](https://developer.android.com/jetpack/androidx/releases/appfunctions#1.0.0-rc01)

```
val displayDescription: String
```

A short, user-visible description of what the app functions enable the agent to do.

Corresponds to the `displayDescription` attribute in the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable. Defaults to empty string if not specified.

### instructions

Added in [1.0.0-rc01](https://developer.android.com/jetpack/androidx/releases/appfunctions#1.0.0-rc01)

```
val instructions: String
```

App-provided instructions for the LLM on how to use the app's functions together.

Agents should use these instructions as context when planning calls to the app's functions, for example to follow a required order across functions (such as searching for an entity before updating or deleting it) or to respect constraints that apply across functions. Instructions complement, and do not replace, the descriptions of individual functions.

Corresponds to the `instructions` attribute in the androidx.appfunctions.R.styleable.AppFunctionAppMetadata styleable. Defaults to empty string if not specified.