Skip to content

Commit

Permalink
docs: update package documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bsorrentino committed Aug 14, 2024
1 parent 8272e9d commit 47e4891
Show file tree
Hide file tree
Showing 163 changed files with 163 additions and 162 deletions.
1 change: 1 addition & 0 deletions docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -117,5 +117,6 @@ swift package \
--target LangGraph \
--disable-indexing \
--transform-for-static-hosting \
--hosting-base-path LangGraph-Swift \
--output-path ./docs

2 changes: 1 addition & 1 deletion docs/data/documentation/langgraph.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/langgraph/agentstate.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/langgraph\/agentstate"]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/LangGraph\/documentation\/LangGraph"]]},"abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"metadata":{"title":"AgentState","role":"symbol","externalID":"s:9LangGraph10AgentStateP","symbolKind":"protocol","modules":[{"name":"LangGraph"}],"navigatorTitle":[{"text":"AgentState","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AgentState","kind":"identifier"}],"roleHeading":"Protocol"},"identifier":{"url":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState","interfaceLanguage":"swift"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/init(_:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data"]},{"title":"Instance Methods","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/value(_:)"]}],"relationshipsSections":[{"kind":"relationships","title":"Conforming Types","type":"conformingTypes","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AgentState"}]}],"kind":"declarations"},{"content":[{"level":2,"text":"Overview","type":"heading","anchor":"overview"},{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"AgentState"},{"type":"text","text":" protocol defines the requirements for any type that represents"},{"type":"text","text":" "},{"text":"the state of an agent. It includes a dictionary to store state data and an initializer","type":"text"},{"text":" ","type":"text"},{"text":"to set up the initial state.","type":"text"}],"type":"paragraph"}],"kind":"content"}],"kind":"symbol","references":{"doc://LangGraph/documentation/LangGraph":{"abstract":[],"role":"collection","type":"topic","url":"\/documentation\/langgraph","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph","title":"LangGraph","kind":"symbol"},"doc://LangGraph/documentation/LangGraph/AgentState":{"abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"role":"symbol","kind":"symbol","title":"AgentState","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AgentState"}],"url":"\/documentation\/langgraph\/agentstate","navigatorTitle":[{"kind":"identifier","text":"AgentState"}],"type":"topic","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState"},"doc://LangGraph/documentation/LangGraph/AgentState/data":{"url":"\/documentation\/langgraph\/agentstate\/data","required":true,"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data","role":"symbol","type":"topic","abstract":[{"text":"A dictionary to store the state data.","type":"text"}],"title":"data","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://LangGraph/documentation/LangGraph/AgentState/value(_:)":{"fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"value"},{"text":"<","kind":"text"},{"text":"T","kind":"genericParameter"},{"kind":"text","text":">("},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":") -> ","kind":"text"},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"?"}],"title":"value(_:)","kind":"symbol","abstract":[{"type":"text","text":"Retrieves the value associated with the specified key."}],"type":"topic","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/value(_:)","role":"symbol","url":"\/documentation\/langgraph\/agentstate\/value(_:)"},"doc://LangGraph/documentation/LangGraph/AgentState/init(_:)":{"role":"symbol","required":true,"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"(["},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/init(_:)","title":"init(_:)","url":"\/documentation\/langgraph\/agentstate\/init(_:)","abstract":[{"type":"text","text":"Initializes a new instance of an agent state with the given initial state."}],"kind":"symbol","type":"topic"},"doc://LangGraph/documentation/LangGraph/BaseAgentState":{"url":"\/documentation\/langgraph\/baseagentstate","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"BaseAgentState","kind":"identifier"}],"kind":"symbol","abstract":[{"text":"A structure representing the base state of an agent.","type":"text"}],"title":"BaseAgentState","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState","role":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BaseAgentState"}]}}}
{"metadata":{"role":"symbol","roleHeading":"Protocol","title":"AgentState","modules":[{"name":"LangGraph"}],"symbolKind":"protocol","externalID":"s:9LangGraph10AgentStateP","navigatorTitle":[{"text":"AgentState","kind":"identifier"}],"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AgentState"}]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/init(_:)"]},{"identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data"],"title":"Instance Properties"},{"title":"Instance Methods","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/value(_:)"]}],"kind":"symbol","primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"AgentState","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"text":"Overview","anchor":"overview","level":2,"type":"heading"},{"inlineContent":[{"text":"The ","type":"text"},{"type":"codeVoice","code":"AgentState"},{"type":"text","text":" protocol defines the requirements for any type that represents"},{"text":" ","type":"text"},{"text":"the state of an agent. It includes a dictionary to store state data and an initializer","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"to set up the initial state."}],"type":"paragraph"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/langgraph\/agentstate"],"traits":[{"interfaceLanguage":"swift"}]}],"hierarchy":{"paths":[["doc:\/\/LangGraph\/documentation\/LangGraph"]]},"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"sections":[],"relationshipsSections":[{"title":"Conforming Types","identifiers":["doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState"],"type":"conformingTypes","kind":"relationships"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState"},"references":{"doc://LangGraph/documentation/LangGraph":{"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph","url":"\/documentation\/langgraph","title":"LangGraph","type":"topic","abstract":[],"kind":"symbol","role":"collection"},"doc://LangGraph/documentation/LangGraph/AgentState":{"url":"\/documentation\/langgraph\/agentstate","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState","role":"symbol","type":"topic","abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AgentState"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"AgentState","kind":"identifier"}],"title":"AgentState"},"doc://LangGraph/documentation/LangGraph/AgentState/init(_:)":{"title":"init(_:)","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/init(_:)","fragments":[{"text":"init","kind":"identifier"},{"text":"([","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"text":"])","kind":"text"}],"role":"symbol","required":true,"type":"topic","url":"\/documentation\/langgraph\/agentstate\/init(_:)","abstract":[{"text":"Initializes a new instance of an agent state with the given initial state.","type":"text"}],"kind":"symbol"},"doc://LangGraph/documentation/LangGraph/BaseAgentState":{"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/BaseAgentState","url":"\/documentation\/langgraph\/baseagentstate","title":"BaseAgentState","navigatorTitle":[{"kind":"identifier","text":"BaseAgentState"}],"type":"topic","abstract":[{"type":"text","text":"A structure representing the base state of an agent."}],"kind":"symbol","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"BaseAgentState"}]},"doc://LangGraph/documentation/LangGraph/AgentState/data":{"abstract":[{"text":"A dictionary to store the state data.","type":"text"}],"role":"symbol","title":"data","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/langgraph\/agentstate\/data","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}]},"doc://LangGraph/documentation/LangGraph/AgentState/value(_:)":{"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/value(_:)","role":"symbol","url":"\/documentation\/langgraph\/agentstate\/value(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"value"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"T"},{"kind":"text","text":">("},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"T"},{"kind":"text","text":"?"}],"kind":"symbol","abstract":[{"text":"Retrieves the value associated with the specified key.","type":"text"}],"title":"value(_:)","type":"topic"}}}
2 changes: 1 addition & 1 deletion docs/data/documentation/langgraph/agentstate/data.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"kind":"symbol","hierarchy":{"paths":[["doc:\/\/LangGraph\/documentation\/LangGraph","doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState"]]},"metadata":{"modules":[{"name":"LangGraph"}],"required":true,"role":"symbol","title":"data","symbolKind":"property","roleHeading":"Instance Property","externalID":"s:9LangGraph10AgentStateP4dataSDySSypGvp","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"data"},{"kind":"text","text":": ["},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}]},"abstract":[{"type":"text","text":"A dictionary to store the state data."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"data","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] { "},{"text":"get","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/langgraph\/agentstate\/data"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"schemaVersion":{"patch":0,"minor":3,"major":0},"references":{"doc://LangGraph/documentation/LangGraph/AgentState/data":{"url":"\/documentation\/langgraph\/agentstate\/data","required":true,"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data","role":"symbol","type":"topic","abstract":[{"text":"A dictionary to store the state data.","type":"text"}],"title":"data","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"text":"]","kind":"text"}]},"doc://LangGraph/documentation/LangGraph/AgentState":{"abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"role":"symbol","kind":"symbol","title":"AgentState","fragments":[{"text":"protocol","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AgentState"}],"url":"\/documentation\/langgraph\/agentstate","navigatorTitle":[{"kind":"identifier","text":"AgentState"}],"type":"topic","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState"},"doc://LangGraph/documentation/LangGraph":{"abstract":[],"role":"collection","type":"topic","url":"\/documentation\/langgraph","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph","title":"LangGraph","kind":"symbol"}}}
{"metadata":{"symbolKind":"property","required":true,"modules":[{"name":"LangGraph"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"kind":"text","text":": ["},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"text":"]","kind":"text"}],"title":"data","externalID":"s:9LangGraph10AgentStateP4dataSDySSypGvp","roleHeading":"Instance Property"},"abstract":[{"text":"A dictionary to store the state data.","type":"text"}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data"},"hierarchy":{"paths":[["doc:\/\/LangGraph\/documentation\/LangGraph","doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState"]]},"sections":[],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"text":" : ","kind":"text"},{"kind":"keyword","text":"Any"},{"kind":"text","text":"] { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/langgraph\/agentstate\/data"]}],"references":{"doc://LangGraph/documentation/LangGraph":{"identifier":"doc:\/\/LangGraph\/documentation\/LangGraph","url":"\/documentation\/langgraph","title":"LangGraph","type":"topic","abstract":[],"kind":"symbol","role":"collection"},"doc://LangGraph/documentation/LangGraph/AgentState/data":{"abstract":[{"text":"A dictionary to store the state data.","type":"text"}],"role":"symbol","title":"data","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/langgraph\/agentstate\/data","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState\/data","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"data","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Any","kind":"keyword"},{"kind":"text","text":"]"}]},"doc://LangGraph/documentation/LangGraph/AgentState":{"url":"\/documentation\/langgraph\/agentstate","identifier":"doc:\/\/LangGraph\/documentation\/LangGraph\/AgentState","role":"symbol","type":"topic","abstract":[{"type":"text","text":"A protocol representing the state of an agent."}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AgentState"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"text":"AgentState","kind":"identifier"}],"title":"AgentState"}}}
Loading

0 comments on commit 47e4891

Please sign in to comment.