chore: docstring cleanup
This commit is contained in:
parent
2c66813944
commit
0eb0d6d427
|
|
@ -66,7 +66,7 @@ class ConclusionScope:
|
|||
observed: str,
|
||||
):
|
||||
"""
|
||||
Initialize an ConclusionScope.
|
||||
Initialize a ConclusionScope.
|
||||
|
||||
Args:
|
||||
client: The Honcho client instance
|
||||
|
|
@ -165,7 +165,7 @@ class ConclusionScope:
|
|||
Create conclusions in this scope.
|
||||
|
||||
Args:
|
||||
conclusions: Single conclusion or list of conclusions to create.
|
||||
conclusions: List of conclusions to create.
|
||||
Each conclusion can be a ConclusionCreateParams object or a dictionary with 'content' and 'session_id' keys.
|
||||
|
||||
Returns:
|
||||
|
|
@ -173,12 +173,6 @@ class ConclusionScope:
|
|||
|
||||
Example:
|
||||
```python
|
||||
# Create a single conclusion
|
||||
conclusions = peer.conclusions.create(
|
||||
{"content": "User prefers dark mode", "session_id": "session1"}
|
||||
)
|
||||
|
||||
# Create multiple conclusions
|
||||
conclusions = peer.conclusions.create([
|
||||
{"content": "User prefers dark mode", "session_id": "session1"},
|
||||
{"content": "User is interested in AI", "session_id": "session1"},
|
||||
|
|
@ -388,7 +382,7 @@ class AsyncConclusionScope:
|
|||
Create conclusions in this scope.
|
||||
|
||||
Args:
|
||||
conclusions: Single conclusion or list of conclusions to create.
|
||||
conclusions: List of conclusions to create.
|
||||
Each conclusion can be a ConclusionCreateParams object or a dictionary with 'content' and 'session_id' keys.
|
||||
|
||||
Returns:
|
||||
|
|
@ -396,12 +390,6 @@ class AsyncConclusionScope:
|
|||
|
||||
Example:
|
||||
```python
|
||||
# Create a single conclusion
|
||||
conclusions = await peer.conclusions.create(
|
||||
{"content": "User prefers dark mode", "session_id": "session1"}
|
||||
)
|
||||
|
||||
# Create multiple conclusions
|
||||
conclusions = await peer.conclusions.create([
|
||||
{"content": "User prefers dark mode", "session_id": "session1"},
|
||||
{"content": "User is interested in AI", "session_id": "session1"},
|
||||
|
|
|
|||
|
|
@ -634,7 +634,7 @@ class Peer(PeerBase):
|
|||
has made about themselves. Use this for self-conclusion scenarios.
|
||||
|
||||
Returns:
|
||||
An ConclusionScope scoped to this peer's self-conclusions
|
||||
A ConclusionScope scoped to this peer's self-conclusions
|
||||
|
||||
Example:
|
||||
```python
|
||||
|
|
@ -663,7 +663,7 @@ class Peer(PeerBase):
|
|||
target: The target peer (either a Peer object or peer ID string)
|
||||
|
||||
Returns:
|
||||
An ConclusionScope scoped to this peer's conclusions of the target
|
||||
A ConclusionScope scoped to this peer's conclusions of the target
|
||||
|
||||
Example:
|
||||
```python
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ import type { ConclusionCreateParam } from './types'
|
|||
export type { RepresentationOptions, ConclusionCreateParam }
|
||||
|
||||
/**
|
||||
* An conclusion from the theory-of-mind system.
|
||||
* A conclusion from Honcho's reasoning system.
|
||||
*
|
||||
* Conclusions are facts derived from messages that help build a representation
|
||||
* of a peer.
|
||||
|
|
@ -60,7 +60,7 @@ export class Conclusion {
|
|||
}
|
||||
|
||||
/**
|
||||
* Create an Conclusion from an API response object.
|
||||
* Create a Conclusion from an API response object.
|
||||
*
|
||||
* @param data - API response data
|
||||
* @returns A new Conclusion instance
|
||||
|
|
@ -135,7 +135,7 @@ export class ConclusionScope {
|
|||
readonly observed: string
|
||||
|
||||
/**
|
||||
* Initialize an ConclusionScope.
|
||||
* Initialize a ConclusionScope.
|
||||
*
|
||||
* @param client - The Honcho client instance
|
||||
* @param workspaceId - The workspace ID
|
||||
|
|
|
|||
|
|
@ -614,7 +614,7 @@ export class Peer {
|
|||
* This property provides a convenient way to access conclusions that this peer
|
||||
* has made about themselves. Use this for self-conclusion scenarios.
|
||||
*
|
||||
* @returns An ConclusionScope scoped to this peer's self-conclusions
|
||||
* @returns A ConclusionScope scoped to this peer's self-conclusions
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
|
|
@ -639,7 +639,7 @@ export class Peer {
|
|||
* observer and the target is the observed peer.
|
||||
*
|
||||
* @param target - The target peer (either a Peer object or peer ID string)
|
||||
* @returns An ConclusionScope scoped to this peer's conclusions of the target
|
||||
* @returns A ConclusionScope scoped to this peer's conclusions of the target
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
|
|
|
|||
Loading…
Reference in New Issue